Interface GetEntityResponse.Builder
- All Superinterfaces:
AwsResponse.Builder
,Buildable
,CopyableBuilder<GetEntityResponse.Builder,
,GetEntityResponse> IoTTwinMakerResponse.Builder
,SdkBuilder<GetEntityResponse.Builder,
,GetEntityResponse> SdkPojo
,SdkResponse.Builder
- Enclosing class:
GetEntityResponse
-
Method Summary
Modifier and TypeMethodDescriptionareAllComponentsReturned
(Boolean areAllComponentsReturned) This flag notes whether all components are returned in the API response.The ARN of the entity.components
(Map<String, ComponentResponse> components) An object that maps strings to the components in the entity.creationDateTime
(Instant creationDateTime) The date and time when the entity was created.description
(String description) The description of the entity.The ID of the entity.entityName
(String entityName) The name of the entity.hasChildEntities
(Boolean hasChildEntities) A Boolean value that specifies whether the entity has associated child entities.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.The current status of the entity.syncSource
(String syncSource) The syncSource of the sync job, if this entity was created by a sync job.updateDateTime
(Instant updateDateTime) The date and time when the entity was last updated.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 Details
-
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
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
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
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
The current status of the entity.
This is a convenience method that creates an instance of theStatus.Builder
avoiding the need to create one manually viaStatus.builder()
.When the
Consumer
completes,SdkBuilder.build()
is called immediately and its result is passed tostatus(Status)
.- Parameters:
status
- a consumer that will call methods onStatus.Builder
- Returns:
- Returns a reference to this object so that method calls can be chained together.
- See Also:
-
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
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
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
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
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
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
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
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
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.
-