Class AssetModelHierarchyDefinition

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

Contains an asset model hierarchy used in asset model creation. An asset model hierarchy determines the kind (or type) of asset that can belong to a hierarchy.

See Also:

  • Method Details

    • id

      public final String id()

      The ID to assign to the asset model hierarchy, if desired. IoT SiteWise automatically generates a unique ID for you, so this parameter is never required. However, if you prefer to supply your own ID instead, you can specify it here in UUID format. If you specify your own ID, it must be globally unique.

      Returns:
      The ID to assign to the asset model hierarchy, if desired. IoT SiteWise automatically generates a unique ID for you, so this parameter is never required. However, if you prefer to supply your own ID instead, you can specify it here in UUID format. If you specify your own ID, it must be globally unique.

    • externalId

      public final String externalId()

      An external ID to assign to the asset model hierarchy. The external ID must be unique among asset model hierarchies within this asset model. For more information, see Using external IDs in the IoT SiteWise User Guide.

      Returns:
      An external ID to assign to the asset model hierarchy. The external ID must be unique among asset model hierarchies within this asset model. For more information, see Using external IDs in the IoT SiteWise User Guide.

    • name

      public final String name()

      The name of the asset model hierarchy definition (as specified in the CreateAssetModel or UpdateAssetModel API operation).

      Returns:
      The name of the asset model hierarchy definition (as specified in the CreateAssetModel or UpdateAssetModel API operation).

    • childAssetModelId

      public final String childAssetModelId()

      The ID of an asset model for this hierarchy. This can be either the actual ID in UUID format, or else externalId: followed by the external ID, if it has one. For more information, see Referencing objects with external IDs in the IoT SiteWise User Guide.

      Returns:
      The ID of an asset model for this hierarchy. This can be either the actual ID in UUID format, or else externalId: followed by the external ID, if it has one. For more information, see Referencing objects with external IDs in the IoT SiteWise User Guide.

    • toBuilder

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

    • builder

      public static AssetModelHierarchyDefinition.Builder builder()

    • serializableBuilderClass

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