Class PutAssetPropertyValueEntry

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

Contains a list of value updates for an asset property in the list of asset entries consumed by the BatchPutAssetPropertyValue API operation.

See Also:

  • Method Details

    • entryId

      public final String entryId()

      The user specified ID for the entry. You can use this ID to identify which entries failed.

      Returns:
      The user specified ID for the entry. You can use this ID to identify which entries failed.

    • assetId

      public final String assetId()

      The ID of the asset to update.

      Returns:
      The ID of the asset to update.

    • propertyId

      public final String propertyId()

      The ID of the asset property for this entry.

      Returns:
      The ID of the asset property for this entry.

    • propertyAlias

      public final String propertyAlias()

      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.

    • hasPropertyValues

      public final boolean hasPropertyValues()
      For responses, this returns true if the service returned a value for the PropertyValues 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.

    • propertyValues

      public final List<AssetPropertyValue> propertyValues()

      The list of property values to upload. You can specify up to 10 propertyValues array elements.

      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 hasPropertyValues() method.

      Returns:
      The list of property values to upload. You can specify up to 10 propertyValues array elements.

    • toBuilder

      public PutAssetPropertyValueEntry.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<PutAssetPropertyValueEntry.Builder,PutAssetPropertyValueEntry>
      Returns:
      a builder for type T

    • builder

      public static PutAssetPropertyValueEntry.Builder builder()

    • serializableBuilderClass

      public static Class<? extends PutAssetPropertyValueEntry.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.