Class Attribute

    • Method Detail

      • fullyQualifiedName

        public final String fullyQualifiedName()

        The fully qualified name of the attribute. For example, the fully qualified name of an attribute might be Vehicle.Body.Engine.Type.

        Returns:
        The fully qualified name of the attribute. For example, the fully qualified name of an attribute might be Vehicle.Body.Engine.Type.
      • dataTypeAsString

        public final String dataTypeAsString()

        The specified data type of the attribute.

        If the service returns an enum value that is not available in the current SDK version, dataType will return NodeDataType.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from dataTypeAsString().

        Returns:
        The specified data type of the attribute.
        See Also:
        NodeDataType
      • description

        public final String description()

        A brief description of the attribute.

        Returns:
        A brief description of the attribute.
      • unit

        public final String unit()

        The scientific unit for the attribute.

        Returns:
        The scientific unit for the attribute.
      • hasAllowedValues

        public final boolean hasAllowedValues()
        For responses, this returns true if the service returned a value for the AllowedValues property. This DOES NOT check that the value is non-empty (for which, you should check the isEmpty() method on the property). This is useful because the SDK will never return a null collection or map, but you may need to differentiate between the service returning nothing (or null) and the service returning an empty collection or map. For requests, this returns true if a value for the property was specified in the request builder, and false if a value was not specified.
      • allowedValues

        public final List<String> allowedValues()

        A list of possible values an attribute can be assigned.

        Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.

        This method will never return null. If you would like to know whether the service returned this field (so that you can differentiate between null and empty), you can use the hasAllowedValues() method.

        Returns:
        A list of possible values an attribute can be assigned.
      • min

        public final Double min()

        The specified possible minimum value of the attribute.

        Returns:
        The specified possible minimum value of the attribute.
      • max

        public final Double max()

        The specified possible maximum value of the attribute.

        Returns:
        The specified possible maximum value of the attribute.
      • assignedValue

        @Deprecated
        public final String assignedValue()
        Deprecated.
        assignedValue is no longer in use

        A specified value for the attribute.

        Returns:
        A specified value for the attribute.
      • defaultValue

        public final String defaultValue()

        The default value of the attribute.

        Returns:
        The default value of the attribute.
      • deprecationMessage

        public final String deprecationMessage()

        The deprecation message for the node or the branch that was moved or deleted.

        Returns:
        The deprecation message for the node or the branch that was moved or deleted.
      • comment

        public final String comment()

        A comment in addition to the description.

        Returns:
        A comment in addition to the description.
      • hashCode

        public final int hashCode()
        Overrides:
        hashCode in class Object
      • equals

        public final boolean equals​(Object obj)
        Overrides:
        equals in class Object
      • toString

        public final String toString()
        Returns a string representation of this object. This is useful for testing and debugging. Sensitive data will be redacted from this string using a placeholder value.
        Overrides:
        toString in class Object
      • getValueForField

        public final <T> Optional<T> getValueForField​(String fieldName,
                                                      Class<T> clazz)