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

Class DescribeAssetModelResponse

java.lang.Object
software.amazon.awssdk.core.SdkResponse
software.amazon.awssdk.awscore.AwsResponse
software.amazon.awssdk.services.iotsitewise.model.IoTSiteWiseResponse
software.amazon.awssdk.services.iotsitewise.model.DescribeAssetModelResponse
All Implemented Interfaces:
SdkPojo, ToCopyableBuilder<DescribeAssetModelResponse.Builder,DescribeAssetModelResponse>
@Generated("software.amazon.awssdk:codegen") public final class DescribeAssetModelResponse extends IoTSiteWiseResponse implements ToCopyableBuilder<DescribeAssetModelResponse.Builder,DescribeAssetModelResponse>

  • Method Details

    • assetModelId

      public final String assetModelId()

      The ID of the asset model, in UUID format.

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

    • assetModelArn

      public final String assetModelArn()

      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}

    • assetModelName

      public final String assetModelName()

      The name of the asset model.

      Returns:
      The name of the asset model.

    • assetModelDescription

      public final String assetModelDescription()

      The asset model's description.

      Returns:
      The asset model's description.

    • hasAssetModelProperties

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

    • assetModelProperties

      public final List<AssetModelProperty> assetModelProperties()

      The list of asset properties for the asset model.

      This object doesn't include properties that you define in composite models. You can find composite model properties in the assetModelCompositeModels object.

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

      Returns:
      The list of asset properties for the asset model.

      This object doesn't include properties that you define in composite models. You can find composite model properties in the assetModelCompositeModels object.

    • hasAssetModelHierarchies

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

    • assetModelHierarchies

      public final List<AssetModelHierarchy> assetModelHierarchies()

      A list of asset model hierarchies that each contain a childAssetModelId and a hierarchyId (named id). A hierarchy specifies allowed parent/child asset relationships for an asset model.

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

      Returns:
      A list of asset model hierarchies that each contain a childAssetModelId and a hierarchyId (named id). A hierarchy specifies allowed parent/child asset relationships for an asset model.

    • hasAssetModelCompositeModels

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

    • assetModelCompositeModels

      public final List<AssetModelCompositeModel> assetModelCompositeModels()

      The list of built-in composite models for the asset model, such as those with those of type AWS/ALARMS.

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

      Returns:
      The list of built-in composite models for the asset model, such as those with those of type AWS/ALARMS.

    • assetModelCreationDate

      public final Instant assetModelCreationDate()

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

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

    • assetModelLastUpdateDate

      public final Instant assetModelLastUpdateDate()

      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.

    • assetModelStatus

      public final AssetModelStatus assetModelStatus()

      The current status of the asset model, which contains a state and any error message.

      Returns:
      The current status of the asset model, which contains a state and any error message.

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

    • hasAssetModelCompositeModelSummaries

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

    • assetModelCompositeModelSummaries

      public final List<AssetModelCompositeModelSummary> assetModelCompositeModelSummaries()

      The list of the immediate child custom composite model summaries for the asset model.

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

      Returns:
      The list of the immediate child custom composite model summaries for the asset model.

    • assetModelExternalId

      public final String assetModelExternalId()

      The external ID of the asset model, if any.

      Returns:
      The external ID of the asset model, if any.

    • toBuilder

      public DescribeAssetModelResponse.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<DescribeAssetModelResponse.Builder,DescribeAssetModelResponse>
      Specified by:
      toBuilder in class AwsResponse
      Returns:
      a builder for type T

    • builder

      public static DescribeAssetModelResponse.Builder builder()

    • serializableBuilderClass

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

    • hashCode

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

    • equals

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

    • 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)
      Description copied from class: SdkResponse
      Used to retrieve the value of a field from any class that extends SdkResponse. The field name specified should match the member name from the corresponding service-2.json model specified in the codegen-resources folder for a given service. The class specifies what class to cast the returned value to. If the returned value is also a modeled class, the SdkResponse.getValueForField(String, Class) method will again be available.
      Overrides:
      getValueForField in class SdkResponse
      Parameters:
      fieldName - The name of the member to be retrieved.
      clazz - The class to cast the returned object to.
      Returns:
      Optional containing the casted return value

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