Package software.amazon.awssdk.services.iottwinmaker.model

Interface GetEntityResponse.Builder

All Superinterfaces:

AwsResponse.Builder, Buildable, CopyableBuilder<GetEntityResponse.Builder,GetEntityResponse>, IoTTwinMakerResponse.Builder, SdkBuilder<GetEntityResponse.Builder,GetEntityResponse>, SdkPojo, SdkResponse.Builder

Enclosing class:

GetEntityResponse

public static interface GetEntityResponse.Builder
extends IoTTwinMakerResponse.Builder, SdkPojo, CopyableBuilder<GetEntityResponse.Builder,GetEntityResponse>

Method Summary

Modifier and Type	Method	Description
GetEntityResponse.Builder	areAllComponentsReturned(Boolean areAllComponentsReturned)	This flag notes whether all components are returned in the API response.
GetEntityResponse.Builder	arn(String arn)	The ARN of the entity.
GetEntityResponse.Builder	components(Map<String,ComponentResponse> components)	An object that maps strings to the components in the entity.
GetEntityResponse.Builder	creationDateTime(Instant creationDateTime)	The date and time when the entity was created.
GetEntityResponse.Builder	description(String description)	The description of the entity.
GetEntityResponse.Builder	entityId(String entityId)	The ID of the entity.
GetEntityResponse.Builder	entityName(String entityName)	The name of the entity.
GetEntityResponse.Builder	hasChildEntities(Boolean hasChildEntities)	A Boolean value that specifies whether the entity has associated child entities.
GetEntityResponse.Builder	parentEntityId(String parentEntityId)	The ID of the parent entity for this entity.
default GetEntityResponse.Builder	status(Consumer<Status.Builder> status)	The current status of the entity.
GetEntityResponse.Builder	status(Status status)	The current status of the entity.
GetEntityResponse.Builder	syncSource(String syncSource)	The syncSource of the sync job, if this entity was created by a sync job.
GetEntityResponse.Builder	updateDateTime(Instant updateDateTime)	The date and time when the entity was last updated.
GetEntityResponse.Builder	workspaceId(String workspaceId)	The ID of the workspace.

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

copy

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

build, responseMetadata, responseMetadata

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

applyMutation, build

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

equalsBySdkFields, sdkFields

Methods inherited from interface software.amazon.awssdk.core.SdkResponse.Builder

sdkHttpResponse, sdkHttpResponse

Method Detail

entityId

GetEntityResponse.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

GetEntityResponse.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.

arn

GetEntityResponse.Builder arn(String arn)

The ARN of the entity.

Parameters:

arn - The ARN of the entity.

Returns:

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

status

GetEntityResponse.Builder status(Status status)

The current status of the entity.

Parameters:

status - The current status of the entity.

Returns:

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

status

default GetEntityResponse.Builder status(Consumer<Status.Builder> status)

The current status of the entity.

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

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

Parameters:

status - a consumer that will call methods on Status.Builder

Returns:

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

See Also:

status(Status)

workspaceId

GetEntityResponse.Builder workspaceId(String workspaceId)

The ID of the workspace.

Parameters:

workspaceId - The ID of the workspace.

Returns:

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

description

GetEntityResponse.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.

components

GetEntityResponse.Builder components(Map<String,ComponentResponse> components)

An object that maps strings to the components in the entity. Each string in the mapping must be unique to this object.

Parameters:

components - An object that maps strings to the components in the entity. 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.

parentEntityId

GetEntityResponse.Builder parentEntityId(String parentEntityId)

The ID of the parent entity for this entity.

Parameters:

parentEntityId - The ID of the parent entity for this entity.

Returns:

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

hasChildEntities

GetEntityResponse.Builder hasChildEntities(Boolean hasChildEntities)

A Boolean value that specifies whether the entity has associated child entities.

Parameters:

hasChildEntities - A Boolean value that specifies whether the entity has associated child entities.

Returns:

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

creationDateTime

GetEntityResponse.Builder creationDateTime(Instant creationDateTime)

The date and time when the entity was created.

Parameters:

creationDateTime - The date and time when the entity was created.

Returns:

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

updateDateTime

GetEntityResponse.Builder updateDateTime(Instant updateDateTime)

The date and time when the entity was last updated.

Parameters:

updateDateTime - The date and time when the entity was last updated.

Returns:

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

syncSource

GetEntityResponse.Builder syncSource(String syncSource)

The syncSource of the sync job, if this entity was created by a sync job.

Parameters:

syncSource - The syncSource of the sync job, if this entity was created by a sync job.

Returns:

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

areAllComponentsReturned

GetEntityResponse.Builder areAllComponentsReturned(Boolean areAllComponentsReturned)

This flag notes whether all components are returned in the API response. The maximum number of components returned is 30.

Parameters:

areAllComponentsReturned - This flag notes whether all components are returned in the API response. The maximum number of components returned is 30.

Returns:

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