com.ibm.streams.management

Interface PropertyMetadata


  • public interface PropertyMetadata
    PropertyMetadata contains information about a configuration property.

    • Field Detail

      • REPLACEMENT_PARAMETER_STREAMS_INSTALL

        static final java.lang.String REPLACEMENT_PARAMETER_STREAMS_INSTALL
        REPLACEMENT_PARAMETER_STREAMS_INSTALL is a replacement value used in property values to identify the installation path for the version of Streams code running for the domain. The value is "%STREAMS_INSTALL%".
        See Also:
        Constant Field Values

      • REPLACEMENT_PARAMETER_STREAMS_BASE_INSTALL

        static final java.lang.String REPLACEMENT_PARAMETER_STREAMS_BASE_INSTALL
        REPLACEMENT_PARAMETER_STREAMS_BASE_INSTALL is a replacement value used in property values to identify the base installation path for the Streams code running for the domain. This excludes the version portion of the full installation path. The value is "%STREAMS_INSTALL_BASE%".
        See Also:
        Constant Field Values

      • REPLACEMENT_PARAMETER_USER_HOME

        static final java.lang.String REPLACEMENT_PARAMETER_USER_HOME
        REPLACEMENT_PARAMETER_USER_HOME is a replacement value used in property values to identify the home directory of the user on whose behalf the request performing the property retrieval is being run. The value is "%STREAMS_USER_HOME%".
        See Also:
        Constant Field Values

      • REPLACEMENT_PARAMETER_STREAMS_RESOURCE

        static final java.lang.String REPLACEMENT_PARAMETER_STREAMS_RESOURCE
        REPLACEMENT_PARAMETER_STREAMS_RESOURCE is a replacement value used in property values to identify a resource where code relevant to the property retrieval, such as a Streams service or a PE, is running. It is replaced with the resource identifier. The value is "%STREAMS_RESOURCE%".
        See Also:
        Constant Field Values

    • Method Detail

      • getName

        java.lang.String getName()
        Returns the name of the property. This is the name the streamtool command uses to get and set the property value. This value can be converted to a PropertyId by passing the value to either fromString for a domain property or to fromString for an instance property.
        Returns:
        the property name.

      • getDescription

        java.lang.String getDescription()
        Returns a description of the property.
        Returns:
        the property description.

      • getValueType

        PropertyMetadata.ValueType getValueType()
        Returns the data type of the property value.
        Returns:
        the property value data type.

      • getDefaultContentType

        PropertyMetadata.ValueContentType getDefaultContentType()
        Returns the content type of the default value.
        Returns:
        the default value content type.

      • getDefaultValue

        java.lang.String getDefaultValue()
        Returns information to determine the default property value. The value can be interpreted as follows:
        • If DefaultContentType is CONSTANT the default is identified by the constant value contained in DefaultValue.
        • If DefaultContentType is DOMAIN_PROPERTY_NAME the default value is the current value of the domain property with the name specified in DefaultValue
        • If DefaultContentType is INSTANCE_PROPERTY_NAME the default value is the current value of the instance property with the name specified in DefaultValue

        The default value could contain substitution parameters. Possible substitution parameters are:

        Returns:
        the property default.

      • getUpdateType

        PropertyMetadata.UpdateType getUpdateType()
        Returns an indicator describing when an update to the property is performed.
        Returns:
        the property update type.

      • getConstraintType

        PropertyMetadata.ConstraintType getConstraintType()
        Returns the type of constraint that applies to the value of the property.
        Returns:
        the property value constraint type.

      • getPossibleValues

        java.util.Set<java.lang.String> getPossibleValues()
        Returns the set of possible values for the property. If the constraint type is not ENUMERATION an empty set is returned.
        Returns:
        the set of possible property values.

      • getMinimumContentType

        PropertyMetadata.ValueContentType getMinimumContentType()
        Returns the content type of the minimum value. If the constraint type is not RANGE or GREATER_OR_EQUAL CONSTANT is returned.
        Returns:
        the minimum value content type.

      • getMinimumValue

        java.lang.String getMinimumValue()
        Returns information to determine the minimum possible value for the property. The value can be interpreted as follows:
        • If {link com.ibm.streams.management.PropertyMetadata#getMinimumContentType() MinimumContentType} is CONSTANT the minimum is identified by the constant value contained in MinimumValue.
        • If MinimumContentType is DOMAIN_PROPERTY_NAME the minimum value is the current value of the domain property with the name specified in MinimumValue
        • If MinimumContentType is INSTANCE_PROPERTY_NAME the minimum value is the current value of the instance property with the name specified in MinimumValue
        If the constraint type is not RANGE or GREATER_OR_EQUAL null is returned.
        Returns:
        the minimum value identification information.

      • getMaximumContentType

        PropertyMetadata.ValueContentType getMaximumContentType()
        Returns the content type of the maximum value. If the constraint type is not RANGE or LESS_OR_EQUAL CONSTANT is returned.
        Returns:
        the maximum value content type.

      • getMaximumValue

        java.lang.String getMaximumValue()
        Returns information to determine the maximum possible value for the property. The value can be interpreted as follows:
        • If MaximumContentType is CONSTANT the maximum is identified by the constant value contained in MaximumValue.
        • If MaximumContentType is DOMAIN_PROPERTY_NAME the maximum value is the current value of the domain property with the name specified in MaximumValue
        • If MaximumContentType is INSTANCE_PROPERTY_NAME the maximum value is the current value of the instance property with the name specified in MaximumValue
        If the constraint type is not RANGE or LESS_OR_EQUAL null is returned.
        Returns:
        the maximum value identification information.

      • getConstrainingRegularExpression

        java.lang.String getConstrainingRegularExpression()
        Returns the regular expression used to constrain property values. If the constraint type is not REGULAR_EXPRESSION an empty string is returned.
        Returns:
        the constraining regular expression.

      • getValueHidden

        boolean getValueHidden()
        Indicates whether the property value can be retrieved. If the value is true, the property value, default, and any pending value cannot be retrieved.
        Returns:
        true if the property value cannot be retrieved.
Skip navigation links
IBM Streams JMX API