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

Class DescribeAssetCompositeModelResponse

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.DescribeAssetCompositeModelResponse
All Implemented Interfaces:
SdkPojo, ToCopyableBuilder<DescribeAssetCompositeModelResponse.Builder,DescribeAssetCompositeModelResponse>
@Generated("software.amazon.awssdk:codegen") public final class DescribeAssetCompositeModelResponse extends IoTSiteWiseResponse implements ToCopyableBuilder<DescribeAssetCompositeModelResponse.Builder,DescribeAssetCompositeModelResponse>

  • Method Details

    • assetId

      public final String assetId()

      The ID of the asset, in UUID format. This ID uniquely identifies the asset within IoT SiteWise and can be used with other IoT SiteWise APIs.

      Returns:
      The ID of the asset, in UUID format. This ID uniquely identifies the asset within IoT SiteWise and can be used with other IoT SiteWise APIs.

    • assetCompositeModelId

      public final String assetCompositeModelId()

      The ID of a composite model on this asset.

      Returns:
      The ID of a composite model on this asset.

    • assetCompositeModelExternalId

      public final String assetCompositeModelExternalId()

      An external ID to assign to the asset model.

      If the composite model is a component-based composite model, or one nested inside a component model, you can only set the external ID using UpdateAssetModelCompositeModel and specifying the derived ID of the model or property from the created model it's a part of.

      Returns:
      An external ID to assign to the asset model.

      If the composite model is a component-based composite model, or one nested inside a component model, you can only set the external ID using UpdateAssetModelCompositeModel and specifying the derived ID of the model or property from the created model it's a part of.

    • hasAssetCompositeModelPath

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

    • assetCompositeModelPath

      public final List<AssetCompositeModelPathSegment> assetCompositeModelPath()

      The path to the composite model listing the parent composite models.

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

      Returns:
      The path to the composite model listing the parent composite models.

    • assetCompositeModelName

      public final String assetCompositeModelName()

      The unique, friendly name for the composite model.

      Returns:
      The unique, friendly name for the composite model.

    • assetCompositeModelDescription

      public final String assetCompositeModelDescription()

      A description for the composite model.

      Returns:
      A description for the composite model.

    • assetCompositeModelType

      public final String assetCompositeModelType()

      The composite model type. Valid values are AWS/ALARM, CUSTOM, or AWS/L4E_ANOMALY.

      Returns:
      The composite model type. Valid values are AWS/ALARM, CUSTOM, or AWS/L4E_ANOMALY.

    • hasAssetCompositeModelProperties

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

    • assetCompositeModelProperties

      public final List<AssetProperty> assetCompositeModelProperties()

      The property definitions of the composite model that was used to create the asset.

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

      Returns:
      The property definitions of the composite model that was used to create the asset.

    • hasAssetCompositeModelSummaries

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

    • assetCompositeModelSummaries

      public final List<AssetCompositeModelSummary> assetCompositeModelSummaries()

      The list of composite model summaries.

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

      Returns:
      The list of composite model summaries.

    • hasActionDefinitions

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

    • actionDefinitions

      public final List<ActionDefinition> actionDefinitions()

      The available actions for a composite model on this asset.

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

      Returns:
      The available actions for a composite model on this asset.

    • toBuilder

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

    • builder

      public static DescribeAssetCompositeModelResponse.Builder builder()

    • serializableBuilderClass

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