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

Interface AssetModelCompositeModelDefinition.Builder

All Superinterfaces:

Buildable, CopyableBuilder<AssetModelCompositeModelDefinition.Builder,AssetModelCompositeModelDefinition>, SdkBuilder<AssetModelCompositeModelDefinition.Builder,AssetModelCompositeModelDefinition>, SdkPojo

Enclosing class:

AssetModelCompositeModelDefinition

public static interface AssetModelCompositeModelDefinition.Builder
extends SdkPojo, CopyableBuilder<AssetModelCompositeModelDefinition.Builder,AssetModelCompositeModelDefinition>

Method Summary

Modifier and Type	Method	Description
AssetModelCompositeModelDefinition.Builder	description(String description)	The description of the composite model.
AssetModelCompositeModelDefinition.Builder	externalId(String externalId)	An external ID to assign to the composite model.
AssetModelCompositeModelDefinition.Builder	id(String id)	The ID to assign to the composite model, if desired.
AssetModelCompositeModelDefinition.Builder	name(String name)	The name of the composite model.
AssetModelCompositeModelDefinition.Builder	properties(Collection<AssetModelPropertyDefinition> properties)	The asset property definitions for this composite model.
AssetModelCompositeModelDefinition.Builder	properties(Consumer<AssetModelPropertyDefinition.Builder>... properties)	The asset property definitions for this composite model.
AssetModelCompositeModelDefinition.Builder	properties(AssetModelPropertyDefinition... properties)	The asset property definitions for this composite model.
AssetModelCompositeModelDefinition.Builder	type(String type)	The type of the composite model.

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

copy

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

applyMutation, build

Methods inherited from interface software.amazon.awssdk.core.SdkPojo

equalsBySdkFields, sdkFields

Method Detail

name

AssetModelCompositeModelDefinition.Builder name(String name)

The name of the composite model.

Parameters:

name - The name of the composite model.

Returns:

Returns a reference to this object so that method calls can be chained together.

description

AssetModelCompositeModelDefinition.Builder description(String description)

The description of the composite model.

Parameters:

description - The description of the composite model.

Returns:

Returns a reference to this object so that method calls can be chained together.

type

AssetModelCompositeModelDefinition.Builder type(String type)

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

Parameters:

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

Returns:

Returns a reference to this object so that method calls can be chained together.

properties

AssetModelCompositeModelDefinition.Builder properties(Collection<AssetModelPropertyDefinition> properties)

The asset property definitions for this composite model.

Parameters:

properties - The asset property definitions for this composite model.

Returns:

Returns a reference to this object so that method calls can be chained together.

properties

AssetModelCompositeModelDefinition.Builder properties(AssetModelPropertyDefinition... properties)

The asset property definitions for this composite model.

Parameters:

properties - The asset property definitions for this composite model.

Returns:

Returns a reference to this object so that method calls can be chained together.

properties

AssetModelCompositeModelDefinition.Builder properties(Consumer<AssetModelPropertyDefinition.Builder>... properties)

The asset property definitions for this composite model.

This is a convenience method that creates an instance of the AssetModelPropertyDefinition.Builder avoiding the need to create one manually via AssetModelPropertyDefinition.builder().

When the Consumer completes, SdkBuilder.build() is called immediately and its result is passed to #properties(List).

Parameters:

properties - a consumer that will call methods on AssetModelPropertyDefinition.Builder

Returns:

Returns a reference to this object so that method calls can be chained together.

See Also:

#properties(java.util.Collection)

id

AssetModelCompositeModelDefinition.Builder id(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.

Parameters:

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:

Returns a reference to this object so that method calls can be chained together.

externalId

AssetModelCompositeModelDefinition.Builder externalId(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.

Parameters:

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:

Returns a reference to this object so that method calls can be chained together.