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

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:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static interface	AssetModelHierarchyDefinition.Builder

Method Summary

Modifier and Type	Method	Description
static AssetModelHierarchyDefinition.Builder	builder()
String	childAssetModelId()	The ID of an asset model for this hierarchy.
boolean	equals(Object obj)
boolean	equalsBySdkFields(Object obj)
String	externalId()	An external ID to assign to the asset model hierarchy.
<T> Optional<T>	getValueForField(String fieldName, Class<T> clazz)
int	hashCode()
String	id()	The ID to assign to the asset model hierarchy, if desired.
String	name()	The name of the asset model hierarchy definition (as specified in the CreateAssetModel or UpdateAssetModel API operation).
List<SdkField<?>>	sdkFields()
static Class<? extends AssetModelHierarchyDefinition.Builder>	serializableBuilderClass()
AssetModelHierarchyDefinition.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

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.

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.

toBuilder

public AssetModelHierarchyDefinition.Builder toBuilder()

Specified by:

toBuilder in interface ToCopyableBuilder<AssetModelHierarchyDefinition.Builder,AssetModelHierarchyDefinition>

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)

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