Package software.amazon.awssdk.services.iotsitewise.model

Class Property

java.lang.Object
software.amazon.awssdk.services.iotsitewise.model.Property
All Implemented Interfaces:
Serializable, SdkPojo, ToCopyableBuilder<Property.Builder,Property>
@Generated("software.amazon.awssdk:codegen") public final class Property extends Object implements SdkPojo, Serializable, ToCopyableBuilder<Property.Builder,Property>

Contains asset property information.

See Also:

  • Method Details

    • id

      public final String id()

      The ID of the asset property.

      Returns:
      The ID of the asset property.

    • name

      public final String name()

      The name of the property.

      Returns:
      The name of the property.

    • alias

      public final String alias()

      The alias that identifies the property, such as an OPC-UA server data stream path (for example, /company/windfarm/3/turbine/7/temperature). For more information, see Mapping industrial data streams to asset properties in the IoT SiteWise User Guide.

      Returns:
      The alias that identifies the property, such as an OPC-UA server data stream path (for example, /company/windfarm/3/turbine/7/temperature). For more information, see Mapping industrial data streams to asset properties in the IoT SiteWise User Guide.

    • notification

      public final PropertyNotification notification()

      The asset property's notification topic and state. For more information, see UpdateAssetProperty.

      Returns:
      The asset property's notification topic and state. For more information, see UpdateAssetProperty.

    • dataType

      public final PropertyDataType dataType()

      The property data type.

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

      Returns:
      The property data type.
      See Also:

    • dataTypeAsString

      public final String dataTypeAsString()

      The property data type.

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

      Returns:
      The property data type.
      See Also:

    • unit

      public final String unit()

      The unit (such as Newtons or RPM) of the asset property.

      Returns:
      The unit (such as Newtons or RPM) of the asset property.

    • type

      public final PropertyType type()

      The property type (see PropertyType). A property contains one type.

      Returns:
      The property type (see PropertyType). A property contains one type.

    • toBuilder

      public Property.Builder toBuilder()
      Description copied from interface: ToCopyableBuilder
      Take this object and create a builder that contains all of the current property values of this object.
      Specified by:
      toBuilder in interface ToCopyableBuilder<Property.Builder,Property>
      Returns:
      a builder for type T

    • builder

      public static Property.Builder builder()

    • serializableBuilderClass

      public static Class<? extends Property.Builder> serializableBuilderClass()

    • hashCode

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

    • equals

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

    • equalsBySdkFields

      public final boolean equalsBySdkFields(Object obj)
      Description copied from interface: SdkPojo
      Indicates whether some other object is "equal to" this one by SDK fields. An SDK field is a modeled, non-inherited field in an SdkPojo class, and is generated based on a service model.

      If an SdkPojo class does not have any inherited fields, equalsBySdkFields and equals are essentially the same.

      Specified by:
      equalsBySdkFields in interface SdkPojo
      Parameters:
      obj - the object to be compared with
      Returns:
      true if the other object equals to this object by sdk fields, false otherwise.

    • 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)

    • sdkFields

      public final List<SdkField<?>> sdkFields()
      Specified by:
      sdkFields in interface SdkPojo
      Returns:
      List of SdkField in this POJO. May be empty list but should never be null.