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

Class AssetCompositeModelSummary

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

Contains a summary of the composite model for a specific asset.

See Also:

  • Method Details

    • id

      public final String id()

      The ID of the composite model that this summary describes.

      Returns:
      The ID of the composite model that this summary describes.

    • externalId

      public final String externalId()

      An external ID to assign to the asset model.

      If the composite model is a derived 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 derived 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.

    • name

      public final String name()

      The name of the composite model that this summary describes.

      Returns:
      The name of the composite model that this summary describes.

    • type

      public final String type()

      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.

      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.

    • description

      public final String description()

      A description of the composite model that this summary describes.

      Returns:
      A description of the composite model that this summary describes.

    • hasPath

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

    • path

      public final List<AssetCompositeModelPathSegment> path()

      The path that includes all the components of the asset model for 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 hasPath() method.

      Returns:
      The path that includes all the components of the asset model for the asset.

    • toBuilder

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

    • builder

      public static AssetCompositeModelSummary.Builder builder()

    • serializableBuilderClass

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