Interface DescribeDashboardSnapshotJobResultResponse.Builder
- All Superinterfaces:
AwsResponse.Builder
,Buildable
,CopyableBuilder<DescribeDashboardSnapshotJobResultResponse.Builder,
,DescribeDashboardSnapshotJobResultResponse> QuickSightResponse.Builder
,SdkBuilder<DescribeDashboardSnapshotJobResultResponse.Builder,
,DescribeDashboardSnapshotJobResultResponse> SdkPojo
,SdkResponse.Builder
- Enclosing class:
DescribeDashboardSnapshotJobResultResponse
-
Method Summary
Modifier and TypeMethodDescriptionThe Amazon Resource Name (ARN) for the snapshot job.createdTime
(Instant createdTime) The time that a snapshot job was created.errorInfo
(Consumer<SnapshotJobErrorInfo.Builder> errorInfo) Displays information for the error that caused a job to fail.errorInfo
(SnapshotJobErrorInfo errorInfo) Displays information for the error that caused a job to fail.Indicates the status of a job after it has reached a terminal state.jobStatus
(SnapshotJobStatus jobStatus) Indicates the status of a job after it has reached a terminal state.lastUpdatedTime
(Instant lastUpdatedTime) The time that a snapshot job status was last updated.The Amazon Web Services request ID for this operation.result
(Consumer<SnapshotJobResult.Builder> result) The result of the snapshot job.result
(SnapshotJobResult result) The result of the snapshot job.The HTTP status of the requestMethods 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, sdkFields
Methods inherited from interface software.amazon.awssdk.core.SdkResponse.Builder
sdkHttpResponse, sdkHttpResponse
-
Method Details
-
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 aStartDashboardSnapshotJob
API call.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
jobStatus
Indicates the status of a job after it has reached a terminal state. A finished snapshot job will retuen a
COMPLETED
orFAILED
status.- Parameters:
jobStatus
- Indicates the status of a job after it has reached a terminal state. A finished snapshot job will retuen aCOMPLETED
orFAILED
status.- Returns:
- Returns a reference to this object so that method calls can be chained together.
- See Also:
-
jobStatus
Indicates the status of a job after it has reached a terminal state. A finished snapshot job will retuen a
COMPLETED
orFAILED
status.- Parameters:
jobStatus
- Indicates the status of a job after it has reached a terminal state. A finished snapshot job will retuen aCOMPLETED
orFAILED
status.- Returns:
- Returns a reference to this object so that method calls can be chained together.
- See Also:
-
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
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
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 theSnapshotJobResult.Builder
avoiding the need to create one manually viaSnapshotJobResult.builder()
.When the
Consumer
completes,SdkBuilder.build()
is called immediately and its result is passed toresult(SnapshotJobResult)
.- Parameters:
result
- a consumer that will call methods onSnapshotJobResult.Builder
- Returns:
- Returns a reference to this object so that method calls can be chained together.
- See Also:
-
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 theSnapshotJobErrorInfo.Builder
avoiding the need to create one manually viaSnapshotJobErrorInfo.builder()
.When the
Consumer
completes,SdkBuilder.build()
is called immediately and its result is passed toerrorInfo(SnapshotJobErrorInfo)
.- Parameters:
errorInfo
- a consumer that will call methods onSnapshotJobErrorInfo.Builder
- Returns:
- Returns a reference to this object so that method calls can be chained together.
- See Also:
-
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
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.
-