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

Class AssetModelCompositeModelDefinition

java.lang.Object

software.amazon.awssdk.services.iotsitewise.model.AssetModelCompositeModelDefinition

All Implemented Interfaces:

Serializable, SdkPojo, ToCopyableBuilder<AssetModelCompositeModelDefinition.Builder,AssetModelCompositeModelDefinition>

@Generated("software.amazon.awssdk:codegen")
public final class AssetModelCompositeModelDefinition
extends Object
implements SdkPojo, Serializable, ToCopyableBuilder<AssetModelCompositeModelDefinition.Builder,AssetModelCompositeModelDefinition>

Contains a composite model definition in an asset model. This composite model definition is applied to all assets created from the asset model.

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static interface	AssetModelCompositeModelDefinition.Builder

Method Summary

Modifier and Type	Method	Description
static AssetModelCompositeModelDefinition.Builder	builder()
String	description()	The description of the composite model.
boolean	equals(Object obj)
boolean	equalsBySdkFields(Object obj)
String	externalId()	An external ID to assign to the composite model.
<T> Optional<T>	getValueForField(String fieldName, Class<T> clazz)
int	hashCode()
boolean	hasProperties()	For responses, this returns true if the service returned a value for the Properties property.
String	id()	The ID to assign to the composite model, if desired.
String	name()	The name of the composite model.
List<AssetModelPropertyDefinition>	properties()	The asset property definitions for this composite model.
List<SdkField<?>>	sdkFields()
static Class<? extends AssetModelCompositeModelDefinition.Builder>	serializableBuilderClass()
AssetModelCompositeModelDefinition.Builder	toBuilder()
String	toString()	Returns a string representation of this object.
String	type()	The type of the composite model.

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 composite model.

Returns:

The name of the composite model.

description

public final String description()

The description of the composite model.

Returns:

The description of the composite model.

type

public final String type()

The type of the composite model. For alarm composite models, this type is AWS/ALARM.

Returns:

The type of the composite model. For alarm composite models, this type is AWS/ALARM.

hasProperties

public final boolean hasProperties()

For responses, this returns true if the service returned a value for the Properties 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.

properties

public final List<AssetModelPropertyDefinition> properties()

The asset property definitions for this composite model.

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

Returns:

The asset property definitions for this composite model.

id

public final String id()

The ID to assign to the composite model, 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 composite model, 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 composite model. The external ID must be unique among composite models 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 composite model. The external ID must be unique among composite models within this asset model. For more information, see Using external IDs in the IoT SiteWise User Guide.

toBuilder

public AssetModelCompositeModelDefinition.Builder toBuilder()

Specified by:

toBuilder in interface ToCopyableBuilder<AssetModelCompositeModelDefinition.Builder,AssetModelCompositeModelDefinition>

builder

public static AssetModelCompositeModelDefinition.Builder builder()

serializableBuilderClass

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