Class AssociatedAssetsSummary

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

Contains a summary of an associated asset.

See Also:

  • Method Details

    • id

      public final String id()

      The ID of the asset, in UUID format.

      Returns:
      The ID of the asset, in UUID format.

    • externalId

      public final String externalId()

      The external ID of the asset. For more information, see Using external IDs in the IoT SiteWise User Guide.

      Returns:
      The external ID of the asset. For more information, see Using external IDs in the IoT SiteWise User Guide.

    • arn

      public final String arn()

      The ARN of the asset, which has the following format.

      arn:${Partition}:iotsitewise:${Region}:${Account}:asset/${AssetId}

      Returns:
      The ARN of the asset, which has the following format.

      arn:${Partition}:iotsitewise:${Region}:${Account}:asset/${AssetId}

    • name

      public final String name()

      The name of the asset.

      Returns:
      The name of the asset.

    • assetModelId

      public final String assetModelId()

      The ID of the asset model used to create the asset.

      Returns:
      The ID of the asset model used to create the asset.

    • creationDate

      public final Instant creationDate()

      The date the asset was created, in Unix epoch time.

      Returns:
      The date the asset was created, in Unix epoch time.

    • lastUpdateDate

      public final Instant lastUpdateDate()

      The date the asset was last updated, in Unix epoch time.

      Returns:
      The date the asset was last updated, in Unix epoch time.

    • status

      public final AssetStatus status()

      The current status of the asset.

      Returns:
      The current status of the asset.

    • hasHierarchies

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

    • hierarchies

      public final List<AssetHierarchy> hierarchies()

      A list of asset hierarchies that each contain a hierarchyId. A hierarchy specifies allowed parent/child asset relationships.

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

      Returns:
      A list of asset hierarchies that each contain a hierarchyId. A hierarchy specifies allowed parent/child asset relationships.

    • description

      public final String description()

      A description for the asset.

      Returns:
      A description for the asset.

    • toBuilder

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

    • builder

      public static AssociatedAssetsSummary.Builder builder()

    • serializableBuilderClass

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

    • sdkFieldNameToField

      public final Map<String,SdkField<?>> sdkFieldNameToField()
      Specified by:
      sdkFieldNameToField in interface SdkPojo
      Returns:
      The mapping between the field name and its corresponding field.