Interface DescribeDashboardSnapshotJobResultResponse.Builder

All Superinterfaces:

AwsResponse.Builder, Buildable, CopyableBuilder<DescribeDashboardSnapshotJobResultResponse.Builder,DescribeDashboardSnapshotJobResultResponse>, QuickSightResponse.Builder, SdkBuilder<DescribeDashboardSnapshotJobResultResponse.Builder,DescribeDashboardSnapshotJobResultResponse>, SdkPojo, SdkResponse.Builder

Enclosing class:

DescribeDashboardSnapshotJobResultResponse

@Mutable
@NotThreadSafe
public static interface DescribeDashboardSnapshotJobResultResponse.Builder
extends QuickSightResponse.Builder, SdkPojo, CopyableBuilder<DescribeDashboardSnapshotJobResultResponse.Builder,DescribeDashboardSnapshotJobResultResponse>

Method Summary

Modifier and Type	Method	Description
DescribeDashboardSnapshotJobResultResponse.Builder	arn(String arn)	The Amazon Resource Name (ARN) for the snapshot job.
DescribeDashboardSnapshotJobResultResponse.Builder	createdTime(Instant createdTime)	The time that a snapshot job was created.
default DescribeDashboardSnapshotJobResultResponse.Builder	errorInfo(Consumer<SnapshotJobErrorInfo.Builder> errorInfo)	Displays information for the error that caused a job to fail.
DescribeDashboardSnapshotJobResultResponse.Builder	errorInfo(SnapshotJobErrorInfo errorInfo)	Displays information for the error that caused a job to fail.
DescribeDashboardSnapshotJobResultResponse.Builder	jobStatus(String jobStatus)	Indicates the status of a job after it has reached a terminal state.
DescribeDashboardSnapshotJobResultResponse.Builder	jobStatus(SnapshotJobStatus jobStatus)	Indicates the status of a job after it has reached a terminal state.
DescribeDashboardSnapshotJobResultResponse.Builder	lastUpdatedTime(Instant lastUpdatedTime)	The time that a snapshot job status was last updated.
DescribeDashboardSnapshotJobResultResponse.Builder	requestId(String requestId)	The Amazon Web Services request ID for this operation.
default DescribeDashboardSnapshotJobResultResponse.Builder	result(Consumer<SnapshotJobResult.Builder> result)	The result of the snapshot job.
DescribeDashboardSnapshotJobResultResponse.Builder	result(SnapshotJobResult result)	The result of the snapshot job.
DescribeDashboardSnapshotJobResultResponse.Builder	status(Integer status)	The HTTP status of the request

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

copy

Methods inherited from interface software.amazon.awssdk.services.quicksight.model.QuickSightResponse.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, sdkFieldNameToField, sdkFields

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

sdkHttpResponse, sdkHttpResponse

Method Details

arn

DescribeDashboardSnapshotJobResultResponse.Builder arn(String arn)

The Amazon Resource Name (ARN) for the snapshot job. The job ARN is generated when you start a new job with a StartDashboardSnapshotJob API call.

Parameters:

arn - The Amazon Resource Name (ARN) for the snapshot job. The job ARN is generated when you start a new job with a StartDashboardSnapshotJob API call.

Returns:

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

jobStatus

DescribeDashboardSnapshotJobResultResponse.Builder jobStatus(String jobStatus)

Indicates the status of a job after it has reached a terminal state. A finished snapshot job will retuen a COMPLETED or FAILED status.

Parameters:

jobStatus - Indicates the status of a job after it has reached a terminal state. A finished snapshot job will retuen a COMPLETED or FAILED status.

Returns:

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

See Also:

• SnapshotJobStatus
• SnapshotJobStatus

jobStatus

DescribeDashboardSnapshotJobResultResponse.Builder jobStatus(SnapshotJobStatus jobStatus)

Indicates the status of a job after it has reached a terminal state. A finished snapshot job will retuen a COMPLETED or FAILED status.

Parameters:

jobStatus - Indicates the status of a job after it has reached a terminal state. A finished snapshot job will retuen a COMPLETED or FAILED status.

Returns:

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

See Also:

• SnapshotJobStatus
• SnapshotJobStatus

createdTime

DescribeDashboardSnapshotJobResultResponse.Builder createdTime(Instant createdTime)

The time that a snapshot job was created.

Parameters:

createdTime - The time that a snapshot job was created.

Returns:

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

lastUpdatedTime

DescribeDashboardSnapshotJobResultResponse.Builder lastUpdatedTime(Instant lastUpdatedTime)

The time that a snapshot job status was last updated.

Parameters:

lastUpdatedTime - The time that a snapshot job status was last updated.

Returns:

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

result

DescribeDashboardSnapshotJobResultResponse.Builder result(SnapshotJobResult result)

The result of the snapshot job. Jobs that have successfully completed will return the S3Uri where they are located. Jobs that have failedwill return information on the error that caused the job to fail.

Parameters:

result - The result of the snapshot job. Jobs that have successfully completed will return the S3Uri where they are located. Jobs that have failedwill return information on the error that caused the job to fail.

Returns:

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

result

default DescribeDashboardSnapshotJobResultResponse.Builder result(Consumer<SnapshotJobResult.Builder> result)

The result of the snapshot job. Jobs that have successfully completed will return the S3Uri where they are located. Jobs that have failedwill return information on the error that caused the job to fail.

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

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

Parameters:

result - a consumer that will call methods on SnapshotJobResult.Builder

Returns:

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

See Also:

• result(SnapshotJobResult)

errorInfo

DescribeDashboardSnapshotJobResultResponse.Builder errorInfo(SnapshotJobErrorInfo errorInfo)

Displays information for the error that caused a job to fail.

Parameters:

errorInfo - Displays information for the error that caused a job to fail.

Returns:

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

errorInfo

default DescribeDashboardSnapshotJobResultResponse.Builder errorInfo(Consumer<SnapshotJobErrorInfo.Builder> errorInfo)

Displays information for the error that caused a job to fail.

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

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

Parameters:

errorInfo - a consumer that will call methods on SnapshotJobErrorInfo.Builder

Returns:

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

See Also:

• errorInfo(SnapshotJobErrorInfo)

requestId

DescribeDashboardSnapshotJobResultResponse.Builder requestId(String requestId)

The Amazon Web Services request ID for this operation.

Parameters:

requestId - The Amazon Web Services request ID for this operation.

Returns:

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

status

DescribeDashboardSnapshotJobResultResponse.Builder status(Integer status)

The HTTP status of the request

Parameters:

status - The HTTP status of the request

Returns:

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