Interface DescribeDashboardSnapshotJobResponse.Builder
-
- All Superinterfaces:
AwsResponse.Builder,Buildable,CopyableBuilder<DescribeDashboardSnapshotJobResponse.Builder,DescribeDashboardSnapshotJobResponse>,QuickSightResponse.Builder,SdkBuilder<DescribeDashboardSnapshotJobResponse.Builder,DescribeDashboardSnapshotJobResponse>,SdkPojo,SdkResponse.Builder
- Enclosing class:
- DescribeDashboardSnapshotJobResponse
@Mutable @NotThreadSafe public static interface DescribeDashboardSnapshotJobResponse.Builder extends QuickSightResponse.Builder, SdkPojo, CopyableBuilder<DescribeDashboardSnapshotJobResponse.Builder,DescribeDashboardSnapshotJobResponse>
-
-
Method Summary
-
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 Detail
-
awsAccountId
DescribeDashboardSnapshotJobResponse.Builder awsAccountId(String awsAccountId)
The ID of the Amazon Web Services account that the dashboard snapshot job is executed in.
- Parameters:
awsAccountId- The ID of the Amazon Web Services account that the dashboard snapshot job is executed in.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
dashboardId
DescribeDashboardSnapshotJobResponse.Builder dashboardId(String dashboardId)
The ID of the dashboard that you have started a snapshot job for.
- Parameters:
dashboardId- The ID of the dashboard that you have started a snapshot job for.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
snapshotJobId
DescribeDashboardSnapshotJobResponse.Builder snapshotJobId(String snapshotJobId)
The ID of the job to be described. The job ID is set when you start a new job with a
StartDashboardSnapshotJobAPI call.- Parameters:
snapshotJobId- The ID of the job to be described. The job ID is set when you start a new job with aStartDashboardSnapshotJobAPI call.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
userConfiguration
DescribeDashboardSnapshotJobResponse.Builder userConfiguration(SnapshotUserConfigurationRedacted userConfiguration)
The user configuration for the snapshot job. This information is provided when you make a
StartDashboardSnapshotJobAPI call.- Parameters:
userConfiguration- The user configuration for the snapshot job. This information is provided when you make aStartDashboardSnapshotJobAPI call.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
userConfiguration
default DescribeDashboardSnapshotJobResponse.Builder userConfiguration(Consumer<SnapshotUserConfigurationRedacted.Builder> userConfiguration)
The user configuration for the snapshot job. This information is provided when you make a
This is a convenience method that creates an instance of theStartDashboardSnapshotJobAPI call.SnapshotUserConfigurationRedacted.Builderavoiding the need to create one manually viaSnapshotUserConfigurationRedacted.builder().When the
Consumercompletes,SdkBuilder.build()is called immediately and its result is passed touserConfiguration(SnapshotUserConfigurationRedacted).- Parameters:
userConfiguration- a consumer that will call methods onSnapshotUserConfigurationRedacted.Builder- Returns:
- Returns a reference to this object so that method calls can be chained together.
- See Also:
userConfiguration(SnapshotUserConfigurationRedacted)
-
snapshotConfiguration
DescribeDashboardSnapshotJobResponse.Builder snapshotConfiguration(SnapshotConfiguration snapshotConfiguration)
The snapshot configuration of the job. This information is provided when you make a
StartDashboardSnapshotJobAPI call.- Parameters:
snapshotConfiguration- The snapshot configuration of the job. This information is provided when you make aStartDashboardSnapshotJobAPI call.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
snapshotConfiguration
default DescribeDashboardSnapshotJobResponse.Builder snapshotConfiguration(Consumer<SnapshotConfiguration.Builder> snapshotConfiguration)
The snapshot configuration of the job. This information is provided when you make a
This is a convenience method that creates an instance of theStartDashboardSnapshotJobAPI call.SnapshotConfiguration.Builderavoiding the need to create one manually viaSnapshotConfiguration.builder().When the
Consumercompletes,SdkBuilder.build()is called immediately and its result is passed tosnapshotConfiguration(SnapshotConfiguration).- Parameters:
snapshotConfiguration- a consumer that will call methods onSnapshotConfiguration.Builder- Returns:
- Returns a reference to this object so that method calls can be chained together.
- See Also:
snapshotConfiguration(SnapshotConfiguration)
-
arn
DescribeDashboardSnapshotJobResponse.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
StartDashboardSnapshotJobAPI call.- Parameters:
arn- The Amazon Resource Name (ARN) for the snapshot job. The job ARN is generated when you start a new job with aStartDashboardSnapshotJobAPI call.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
jobStatus
DescribeDashboardSnapshotJobResponse.Builder jobStatus(String jobStatus)
Indicates the status of a job. The status updates as the job executes. This shows one of the following values.
-
COMPLETED- The job was completed successfully. -
FAILED- The job failed to execute. -
QUEUED- The job is queued and hasn't started yet. -
RUNNING- The job is still running.
- Parameters:
jobStatus- Indicates the status of a job. The status updates as the job executes. This shows one of the following values.-
COMPLETED- The job was completed successfully. -
FAILED- The job failed to execute. -
QUEUED- The job is queued and hasn't started yet. -
RUNNING- The job is still running.
-
- Returns:
- Returns a reference to this object so that method calls can be chained together.
- See Also:
SnapshotJobStatus,SnapshotJobStatus
-
-
jobStatus
DescribeDashboardSnapshotJobResponse.Builder jobStatus(SnapshotJobStatus jobStatus)
Indicates the status of a job. The status updates as the job executes. This shows one of the following values.
-
COMPLETED- The job was completed successfully. -
FAILED- The job failed to execute. -
QUEUED- The job is queued and hasn't started yet. -
RUNNING- The job is still running.
- Parameters:
jobStatus- Indicates the status of a job. The status updates as the job executes. This shows one of the following values.-
COMPLETED- The job was completed successfully. -
FAILED- The job failed to execute. -
QUEUED- The job is queued and hasn't started yet. -
RUNNING- The job is still running.
-
- Returns:
- Returns a reference to this object so that method calls can be chained together.
- See Also:
SnapshotJobStatus,SnapshotJobStatus
-
-
createdTime
DescribeDashboardSnapshotJobResponse.Builder createdTime(Instant createdTime)
The time that the snapshot job was created.
- Parameters:
createdTime- The time that the snapshot job was created.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
lastUpdatedTime
DescribeDashboardSnapshotJobResponse.Builder lastUpdatedTime(Instant lastUpdatedTime)
The time that the snapshot job status was last updated.
- Parameters:
lastUpdatedTime- The time that the snapshot job status was last updated.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
requestId
DescribeDashboardSnapshotJobResponse.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
DescribeDashboardSnapshotJobResponse.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.
-
-