Interface UpdateEntityRequest.Builder

All Superinterfaces:

AwsRequest.Builder, Buildable, CopyableBuilder<UpdateEntityRequest.Builder,UpdateEntityRequest>, IoTTwinMakerRequest.Builder, SdkBuilder<UpdateEntityRequest.Builder,UpdateEntityRequest>, SdkPojo, SdkRequest.Builder

Enclosing class:

UpdateEntityRequest

public static interface UpdateEntityRequest.Builder
extends IoTTwinMakerRequest.Builder, SdkPojo, CopyableBuilder<UpdateEntityRequest.Builder,UpdateEntityRequest>

Method Summary

Modifier and Type	Method	Description
UpdateEntityRequest.Builder	componentUpdates(Map<String,ComponentUpdateRequest> componentUpdates)	An object that maps strings to the component updates in the request.
UpdateEntityRequest.Builder	compositeComponentUpdates(Map<String,CompositeComponentUpdateRequest> compositeComponentUpdates)	This is an object that maps strings to compositeComponent updates in the request.
UpdateEntityRequest.Builder	description(String description)	The description of the entity.
UpdateEntityRequest.Builder	entityId(String entityId)	The ID of the entity.
UpdateEntityRequest.Builder	entityName(String entityName)	The name of the entity.
UpdateEntityRequest.Builder	overrideConfiguration(Consumer<AwsRequestOverrideConfiguration.Builder> builderConsumer)	Add an optional request override configuration.
UpdateEntityRequest.Builder	overrideConfiguration(AwsRequestOverrideConfiguration overrideConfiguration)	Add an optional request override configuration.
default UpdateEntityRequest.Builder	parentEntityUpdate(Consumer<ParentEntityUpdateRequest.Builder> parentEntityUpdate)	An object that describes the update request for a parent entity.
UpdateEntityRequest.Builder	parentEntityUpdate(ParentEntityUpdateRequest parentEntityUpdate)	An object that describes the update request for a parent entity.
UpdateEntityRequest.Builder	workspaceId(String workspaceId)	The ID of the workspace that contains the entity.

Methods inherited from interface software.amazon.awssdk.awscore.AwsRequest.Builder

overrideConfiguration

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

copy

Methods inherited from interface software.amazon.awssdk.services.iottwinmaker.model.IoTTwinMakerRequest.Builder

build

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

applyMutation, build

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

equalsBySdkFields, sdkFieldNameToField, sdkFields

Method Details

workspaceId

UpdateEntityRequest.Builder workspaceId(String workspaceId)

The ID of the workspace that contains the entity.

Parameters:

workspaceId - The ID of the workspace that contains the entity.

Returns:

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

entityId

UpdateEntityRequest.Builder entityId(String entityId)

The ID of the entity.

Parameters:

entityId - The ID of the entity.

Returns:

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

entityName

UpdateEntityRequest.Builder entityName(String entityName)

The name of the entity.

Parameters:

entityName - The name of the entity.

Returns:

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

description

UpdateEntityRequest.Builder description(String description)

The description of the entity.

Parameters:

description - The description of the entity.

Returns:

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

componentUpdates

UpdateEntityRequest.Builder componentUpdates(Map<String,ComponentUpdateRequest> componentUpdates)

An object that maps strings to the component updates in the request. Each string in the mapping must be unique to this object.

Parameters:

componentUpdates - An object that maps strings to the component updates in the request. Each string in the mapping must be unique to this object.

Returns:

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

compositeComponentUpdates

UpdateEntityRequest.Builder compositeComponentUpdates(Map<String,CompositeComponentUpdateRequest> compositeComponentUpdates)

This is an object that maps strings to compositeComponent updates in the request. Each key of the map represents the componentPath of the compositeComponent.

Parameters:

compositeComponentUpdates - This is an object that maps strings to compositeComponent updates in the request. Each key of the map represents the componentPath of the compositeComponent.

Returns:

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

parentEntityUpdate

UpdateEntityRequest.Builder parentEntityUpdate(ParentEntityUpdateRequest parentEntityUpdate)

An object that describes the update request for a parent entity.

Parameters:

parentEntityUpdate - An object that describes the update request for a parent entity.

Returns:

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

parentEntityUpdate

default UpdateEntityRequest.Builder parentEntityUpdate(Consumer<ParentEntityUpdateRequest.Builder> parentEntityUpdate)

An object that describes the update request for a parent entity.

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

When the Consumer completes, SdkBuilder.build() is called immediately and its result is passed to parentEntityUpdate(ParentEntityUpdateRequest).

Parameters:

parentEntityUpdate - a consumer that will call methods on ParentEntityUpdateRequest.Builder

Returns:

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

See Also:

• parentEntityUpdate(ParentEntityUpdateRequest)

overrideConfiguration

UpdateEntityRequest.Builder overrideConfiguration(AwsRequestOverrideConfiguration overrideConfiguration)

Description copied from interface: AwsRequest.Builder

Add an optional request override configuration.

Specified by:

overrideConfiguration in interface AwsRequest.Builder

Parameters:

overrideConfiguration - The override configuration.

Returns:

This object for method chaining.

overrideConfiguration

UpdateEntityRequest.Builder overrideConfiguration(Consumer<AwsRequestOverrideConfiguration.Builder> builderConsumer)

Description copied from interface: AwsRequest.Builder

Add an optional request override configuration.

Specified by:

overrideConfiguration in interface AwsRequest.Builder

Parameters:

builderConsumer - A Consumer to which an empty AwsRequestOverrideConfiguration.Builder will be given.

Returns:

This object for method chaining.