Interface DescribeWorldGenerationJobResponse.Builder
-
- All Superinterfaces:
AwsResponse.Builder,Buildable,CopyableBuilder<DescribeWorldGenerationJobResponse.Builder,DescribeWorldGenerationJobResponse>,RoboMakerResponse.Builder,SdkBuilder<DescribeWorldGenerationJobResponse.Builder,DescribeWorldGenerationJobResponse>,SdkPojo,SdkResponse.Builder
- Enclosing class:
- DescribeWorldGenerationJobResponse
public static interface DescribeWorldGenerationJobResponse.Builder extends RoboMakerResponse.Builder, SdkPojo, CopyableBuilder<DescribeWorldGenerationJobResponse.Builder,DescribeWorldGenerationJobResponse>
-
-
Method Summary
All Methods Instance Methods Abstract Methods Default Methods Modifier and Type Method Description DescribeWorldGenerationJobResponse.Builderarn(String arn)The Amazon Resource Name (ARN) of the world generation job.DescribeWorldGenerationJobResponse.BuilderclientRequestToken(String clientRequestToken)Unique, case-sensitive identifier that you provide to ensure the idempotency of the request.DescribeWorldGenerationJobResponse.BuildercreatedAt(Instant createdAt)The time, in milliseconds since the epoch, when the world generation job was created.DescribeWorldGenerationJobResponse.BuilderfailureCode(String failureCode)The failure code of the world generation job if it failed:DescribeWorldGenerationJobResponse.BuilderfailureCode(WorldGenerationJobErrorCode failureCode)The failure code of the world generation job if it failed:DescribeWorldGenerationJobResponse.BuilderfailureReason(String failureReason)The reason why the world generation job failed.default DescribeWorldGenerationJobResponse.BuilderfinishedWorldsSummary(Consumer<FinishedWorldsSummary.Builder> finishedWorldsSummary)Summary information about finished worlds.DescribeWorldGenerationJobResponse.BuilderfinishedWorldsSummary(FinishedWorldsSummary finishedWorldsSummary)Summary information about finished worlds.DescribeWorldGenerationJobResponse.Builderstatus(String status)The status of the world generation job:DescribeWorldGenerationJobResponse.Builderstatus(WorldGenerationJobStatus status)The status of the world generation job:DescribeWorldGenerationJobResponse.Buildertags(Map<String,String> tags)A map that contains tag keys and tag values that are attached to the world generation job.DescribeWorldGenerationJobResponse.Buildertemplate(String template)The Amazon Resource Name (arn) of the world template.default DescribeWorldGenerationJobResponse.BuilderworldCount(Consumer<WorldCount.Builder> worldCount)Information about the world count.DescribeWorldGenerationJobResponse.BuilderworldCount(WorldCount worldCount)Information about the world count.DescribeWorldGenerationJobResponse.BuilderworldTags(Map<String,String> worldTags)A map that contains tag keys and tag values that are attached to the generated worlds.-
Methods inherited from interface software.amazon.awssdk.utils.builder.CopyableBuilder
copy
-
Methods inherited from interface software.amazon.awssdk.services.robomaker.model.RoboMakerResponse.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
-
arn
DescribeWorldGenerationJobResponse.Builder arn(String arn)
The Amazon Resource Name (ARN) of the world generation job.
- Parameters:
arn- The Amazon Resource Name (ARN) of the world generation job.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
status
DescribeWorldGenerationJobResponse.Builder status(String status)
The status of the world generation job:
- Pending
-
The world generation job request is pending.
- Running
-
The world generation job is running.
- Completed
-
The world generation job completed.
- Failed
-
The world generation job failed. See
failureCodefor more information. - PartialFailed
-
Some worlds did not generate.
- Canceled
-
The world generation job was cancelled.
- Canceling
-
The world generation job is being cancelled.
- Parameters:
status- The status of the world generation job:- Pending
-
The world generation job request is pending.
- Running
-
The world generation job is running.
- Completed
-
The world generation job completed.
- Failed
-
The world generation job failed. See
failureCodefor more information. - PartialFailed
-
Some worlds did not generate.
- Canceled
-
The world generation job was cancelled.
- Canceling
-
The world generation job is being cancelled.
- Returns:
- Returns a reference to this object so that method calls can be chained together.
- See Also:
WorldGenerationJobStatus,WorldGenerationJobStatus
-
status
DescribeWorldGenerationJobResponse.Builder status(WorldGenerationJobStatus status)
The status of the world generation job:
- Pending
-
The world generation job request is pending.
- Running
-
The world generation job is running.
- Completed
-
The world generation job completed.
- Failed
-
The world generation job failed. See
failureCodefor more information. - PartialFailed
-
Some worlds did not generate.
- Canceled
-
The world generation job was cancelled.
- Canceling
-
The world generation job is being cancelled.
- Parameters:
status- The status of the world generation job:- Pending
-
The world generation job request is pending.
- Running
-
The world generation job is running.
- Completed
-
The world generation job completed.
- Failed
-
The world generation job failed. See
failureCodefor more information. - PartialFailed
-
Some worlds did not generate.
- Canceled
-
The world generation job was cancelled.
- Canceling
-
The world generation job is being cancelled.
- Returns:
- Returns a reference to this object so that method calls can be chained together.
- See Also:
WorldGenerationJobStatus,WorldGenerationJobStatus
-
createdAt
DescribeWorldGenerationJobResponse.Builder createdAt(Instant createdAt)
The time, in milliseconds since the epoch, when the world generation job was created.
- Parameters:
createdAt- The time, in milliseconds since the epoch, when the world generation job was created.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
failureCode
DescribeWorldGenerationJobResponse.Builder failureCode(String failureCode)
The failure code of the world generation job if it failed:
- InternalServiceError
-
Internal service error.
- LimitExceeded
-
The requested resource exceeds the maximum number allowed, or the number of concurrent stream requests exceeds the maximum number allowed.
- ResourceNotFound
-
The specified resource could not be found.
- RequestThrottled
-
The request was throttled.
- InvalidInput
-
An input parameter in the request is not valid.
- Parameters:
failureCode- The failure code of the world generation job if it failed:- InternalServiceError
-
Internal service error.
- LimitExceeded
-
The requested resource exceeds the maximum number allowed, or the number of concurrent stream requests exceeds the maximum number allowed.
- ResourceNotFound
-
The specified resource could not be found.
- RequestThrottled
-
The request was throttled.
- InvalidInput
-
An input parameter in the request is not valid.
- Returns:
- Returns a reference to this object so that method calls can be chained together.
- See Also:
WorldGenerationJobErrorCode,WorldGenerationJobErrorCode
-
failureCode
DescribeWorldGenerationJobResponse.Builder failureCode(WorldGenerationJobErrorCode failureCode)
The failure code of the world generation job if it failed:
- InternalServiceError
-
Internal service error.
- LimitExceeded
-
The requested resource exceeds the maximum number allowed, or the number of concurrent stream requests exceeds the maximum number allowed.
- ResourceNotFound
-
The specified resource could not be found.
- RequestThrottled
-
The request was throttled.
- InvalidInput
-
An input parameter in the request is not valid.
- Parameters:
failureCode- The failure code of the world generation job if it failed:- InternalServiceError
-
Internal service error.
- LimitExceeded
-
The requested resource exceeds the maximum number allowed, or the number of concurrent stream requests exceeds the maximum number allowed.
- ResourceNotFound
-
The specified resource could not be found.
- RequestThrottled
-
The request was throttled.
- InvalidInput
-
An input parameter in the request is not valid.
- Returns:
- Returns a reference to this object so that method calls can be chained together.
- See Also:
WorldGenerationJobErrorCode,WorldGenerationJobErrorCode
-
failureReason
DescribeWorldGenerationJobResponse.Builder failureReason(String failureReason)
The reason why the world generation job failed.
- Parameters:
failureReason- The reason why the world generation job failed.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
clientRequestToken
DescribeWorldGenerationJobResponse.Builder clientRequestToken(String clientRequestToken)
Unique, case-sensitive identifier that you provide to ensure the idempotency of the request.
- Parameters:
clientRequestToken- Unique, case-sensitive identifier that you provide to ensure the idempotency of the request.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
template
DescribeWorldGenerationJobResponse.Builder template(String template)
The Amazon Resource Name (arn) of the world template.
- Parameters:
template- The Amazon Resource Name (arn) of the world template.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
worldCount
DescribeWorldGenerationJobResponse.Builder worldCount(WorldCount worldCount)
Information about the world count.
- Parameters:
worldCount- Information about the world count.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
worldCount
default DescribeWorldGenerationJobResponse.Builder worldCount(Consumer<WorldCount.Builder> worldCount)
Information about the world count.
This is a convenience method that creates an instance of theWorldCount.Builderavoiding the need to create one manually viaWorldCount.builder().When the
Consumercompletes,SdkBuilder.build()is called immediately and its result is passed toworldCount(WorldCount).- Parameters:
worldCount- a consumer that will call methods onWorldCount.Builder- Returns:
- Returns a reference to this object so that method calls can be chained together.
- See Also:
worldCount(WorldCount)
-
finishedWorldsSummary
DescribeWorldGenerationJobResponse.Builder finishedWorldsSummary(FinishedWorldsSummary finishedWorldsSummary)
Summary information about finished worlds.
- Parameters:
finishedWorldsSummary- Summary information about finished worlds.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
finishedWorldsSummary
default DescribeWorldGenerationJobResponse.Builder finishedWorldsSummary(Consumer<FinishedWorldsSummary.Builder> finishedWorldsSummary)
Summary information about finished worlds.
This is a convenience method that creates an instance of theFinishedWorldsSummary.Builderavoiding the need to create one manually viaFinishedWorldsSummary.builder().When the
Consumercompletes,SdkBuilder.build()is called immediately and its result is passed tofinishedWorldsSummary(FinishedWorldsSummary).- Parameters:
finishedWorldsSummary- a consumer that will call methods onFinishedWorldsSummary.Builder- Returns:
- Returns a reference to this object so that method calls can be chained together.
- See Also:
finishedWorldsSummary(FinishedWorldsSummary)
-
tags
DescribeWorldGenerationJobResponse.Builder tags(Map<String,String> tags)
A map that contains tag keys and tag values that are attached to the world generation job.
- Parameters:
tags- A map that contains tag keys and tag values that are attached to the world generation job.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
worldTags
DescribeWorldGenerationJobResponse.Builder worldTags(Map<String,String> worldTags)
A map that contains tag keys and tag values that are attached to the generated worlds.
- Parameters:
worldTags- A map that contains tag keys and tag values that are attached to the generated worlds.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
-