Class AssetModelSummary

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

Contains a summary of an asset model.

See Also:

  • Method Details

    • id

      public final String id()

      The ID of the asset model (used with IoT SiteWise API operations).

      Returns:
      The ID of the asset model (used with IoT SiteWise API operations).

    • externalId

      public final String externalId()

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

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

    • arn

      public final String arn()

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

      arn:${Partition}:iotsitewise:${Region}:${Account}:asset-model/${AssetModelId}

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

      arn:${Partition}:iotsitewise:${Region}:${Account}:asset-model/${AssetModelId}

    • name

      public final String name()

      The name of the asset model.

      Returns:
      The name of the asset model.

    • assetModelType

      public final AssetModelType assetModelType()

      The type of asset model.

      • ASSET_MODEL – (default) An asset model that you can use to create assets. Can't be included as a component in another asset model.

      • COMPONENT_MODEL – A reusable component that you can include in the composite models of other asset models. You can't create assets directly from this type of asset model.

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

      Returns:
      The type of asset model.

      • ASSET_MODEL – (default) An asset model that you can use to create assets. Can't be included as a component in another asset model.

      • COMPONENT_MODEL – A reusable component that you can include in the composite models of other asset models. You can't create assets directly from this type of asset model.

      See Also:

    • assetModelTypeAsString

      public final String assetModelTypeAsString()

      The type of asset model.

      • ASSET_MODEL – (default) An asset model that you can use to create assets. Can't be included as a component in another asset model.

      • COMPONENT_MODEL – A reusable component that you can include in the composite models of other asset models. You can't create assets directly from this type of asset model.

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

      Returns:
      The type of asset model.

      • ASSET_MODEL – (default) An asset model that you can use to create assets. Can't be included as a component in another asset model.

      • COMPONENT_MODEL – A reusable component that you can include in the composite models of other asset models. You can't create assets directly from this type of asset model.

      See Also:

    • description

      public final String description()

      The asset model description.

      Returns:
      The asset model description.

    • creationDate

      public final Instant creationDate()

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

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

    • lastUpdateDate

      public final Instant lastUpdateDate()

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

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

    • status

      public final AssetModelStatus status()

      The current status of the asset model.

      Returns:
      The current status of the asset model.

    • version

      public final String version()

      The version number of the asset model.

      Returns:
      The version number of the asset model.

    • toBuilder

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

    • builder

      public static AssetModelSummary.Builder builder()

    • serializableBuilderClass

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