java.lang.Object
- software.amazon.awssdk.services.iotsitewise.model.AssetModelHierarchy

All Implemented Interfaces:

Serializable, SdkPojo, ToCopyableBuilder<AssetModelHierarchy.Builder,AssetModelHierarchy>
```
@Generated("software.amazon.awssdk:codegen")
public final class AssetModelHierarchy
extends Object
implements SdkPojo, Serializable, ToCopyableBuilder<AssetModelHierarchy.Builder,AssetModelHierarchy>
```
Describes an asset hierarchy that contains a hierarchy's name, ID, and child asset model ID that specifies the type of asset that can be in this hierarchy.

See Also:

Serialized Form

Nested Class Summary

Nested Classes
Modifier and Type Class Description

static interface AssetModelHierarchy.Builder

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method	Description
`static AssetModelHierarchy.Builder`	`builder()`
`String`	`childAssetModelId()`	The ID of the asset model, in UUID format.
`boolean`	`equals(Object obj)`
`boolean`	`equalsBySdkFields(Object obj)`
`String`	`externalId()`	The external ID (if any) provided in the CreateAssetModel or UpdateAssetModel operation.
`<T> Optional<T>`	`getValueForField(String fieldName, Class<T> clazz)`
`int`	`hashCode()`
`String`	`id()`	The ID of the asset model hierarchy.
`String`	`name()`	The name of the asset model hierarchy that you specify by using the CreateAssetModel or UpdateAssetModel API operation.
`List<SdkField<?>>`	`sdkFields()`
`static Class<? extends AssetModelHierarchy.Builder>`	`serializableBuilderClass()`
`AssetModelHierarchy.Builder`	`toBuilder()`
`String`	`toString()`	Returns a string representation of this object.

Methods inherited from class java.lang.Object
clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface software.amazon.awssdk.utils.builder.ToCopyableBuilder
copy

- Method Detail
  - id
```
public final String id()
```
    The ID of the asset model hierarchy. This ID is a hierarchyId.
    
    If you are callling UpdateAssetModel to create a new hierarchy: You can specify its ID here, 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.
    
    If you are calling UpdateAssetModel to modify an existing 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 the asset model hierarchy. This ID is a hierarchyId.
    
    If you are callling UpdateAssetModel to create a new hierarchy: You can specify its ID here, 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.
    
    If you are calling UpdateAssetModel to modify an existing 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.
  - name
```
public final String name()
```
    The name of the asset model hierarchy that you specify by using the CreateAssetModel or UpdateAssetModel API operation.
    
    Returns:
    
    The name of the asset model hierarchy that you specify by using the CreateAssetModel or UpdateAssetModel API operation.
  - childAssetModelId
```
public final String childAssetModelId()
```
    The ID of the asset model, in UUID format. All assets in this hierarchy must be instances of the childAssetModelId asset model. IoT SiteWise will always return the actual asset model ID for this value. However, when you are specifying this value as part of a call to UpdateAssetModel, you may provide either the asset model ID or else externalId: followed by the asset model's external ID. For more information, see Using external IDs in the IoT SiteWise User Guide.
    
    Returns:
    
    The ID of the asset model, in UUID format. All assets in this hierarchy must be instances of the childAssetModelId asset model. IoT SiteWise will always return the actual asset model ID for this value. However, when you are specifying this value as part of a call to UpdateAssetModel, you may provide either the asset model ID or else externalId: followed by the asset model's external ID. For more information, see Using external IDs in the IoT SiteWise User Guide.
  - externalId
```
public final String externalId()
```
    The external ID (if any) provided in the CreateAssetModel or UpdateAssetModel operation. You can assign an external ID by specifying this value as part of a call to UpdateAssetModel. However, you can't change the external ID if one is already assigned. For more information, see Using external IDs in the IoT SiteWise User Guide.
    
    Returns:
    
    The external ID (if any) provided in the CreateAssetModel or UpdateAssetModel operation. You can assign an external ID by specifying this value as part of a call to UpdateAssetModel. However, you can't change the external ID if one is already assigned. For more information, see Using external IDs in the IoT SiteWise User Guide.
  - toBuilder
```
public AssetModelHierarchy.Builder toBuilder()
```
    Specified by:
    
    toBuilder in interface ToCopyableBuilder<AssetModelHierarchy.Builder,AssetModelHierarchy>
  - builder
```
public static AssetModelHierarchy.Builder builder()
```
  - serializableBuilderClass
```
public static Class<? extends AssetModelHierarchy.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)
```
    Specified by:
    
    equalsBySdkFields in interface SdkPojo
  - 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

Class AssetModelHierarchy

Nested Class Summary

Method Summary

Methods inherited from class java.lang.Object

Methods inherited from interface software.amazon.awssdk.utils.builder.ToCopyableBuilder

Method Detail

id

name

childAssetModelId

externalId

toBuilder

builder

serializableBuilderClass

hashCode

equals

equalsBySdkFields

toString

getValueForField

sdkFields