Interface StartDashboardSnapshotJobRequest.Builder

All Superinterfaces:

AwsRequest.Builder, Buildable, CopyableBuilder<StartDashboardSnapshotJobRequest.Builder,StartDashboardSnapshotJobRequest>, QuickSightRequest.Builder, SdkBuilder<StartDashboardSnapshotJobRequest.Builder,StartDashboardSnapshotJobRequest>, SdkPojo, SdkRequest.Builder

Enclosing class:

StartDashboardSnapshotJobRequest

@Mutable
@NotThreadSafe
public static interface StartDashboardSnapshotJobRequest.Builder
extends QuickSightRequest.Builder, SdkPojo, CopyableBuilder<StartDashboardSnapshotJobRequest.Builder,StartDashboardSnapshotJobRequest>

Method Summary

Modifier and Type	Method	Description
StartDashboardSnapshotJobRequest.Builder	awsAccountId(String awsAccountId)	The ID of the Amazon Web Services account that the dashboard snapshot job is executed in.
StartDashboardSnapshotJobRequest.Builder	dashboardId(String dashboardId)	The ID of the dashboard that you want to start a snapshot job for.
StartDashboardSnapshotJobRequest.Builder	overrideConfiguration(Consumer<AwsRequestOverrideConfiguration.Builder> builderConsumer)	Add an optional request override configuration.
StartDashboardSnapshotJobRequest.Builder	overrideConfiguration(AwsRequestOverrideConfiguration overrideConfiguration)	Add an optional request override configuration.
default StartDashboardSnapshotJobRequest.Builder	snapshotConfiguration(Consumer<SnapshotConfiguration.Builder> snapshotConfiguration)	A structure that describes the configuration of the dashboard snapshot.
StartDashboardSnapshotJobRequest.Builder	snapshotConfiguration(SnapshotConfiguration snapshotConfiguration)	A structure that describes the configuration of the dashboard snapshot.
StartDashboardSnapshotJobRequest.Builder	snapshotJobId(String snapshotJobId)	An ID for the dashboard snapshot job.
default StartDashboardSnapshotJobRequest.Builder	userConfiguration(Consumer<SnapshotUserConfiguration.Builder> userConfiguration)	A structure that contains information about the anonymous users that the generated snapshot is for.
StartDashboardSnapshotJobRequest.Builder	userConfiguration(SnapshotUserConfiguration userConfiguration)	A structure that contains information about the anonymous users that the generated snapshot is for.

Methods inherited from interface software.amazon.awssdk.awscore.AwsRequest.Builder

overrideConfiguration

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

copy

Methods inherited from interface software.amazon.awssdk.services.quicksight.model.QuickSightRequest.Builder

build

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

applyMutation, build

Methods inherited from interface software.amazon.awssdk.core.SdkPojo

equalsBySdkFields, sdkFieldNameToField, sdkFields

Method Details

awsAccountId

StartDashboardSnapshotJobRequest.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

StartDashboardSnapshotJobRequest.Builder dashboardId(String dashboardId)

The ID of the dashboard that you want to start a snapshot job for.

Parameters:

dashboardId - The ID of the dashboard that you want to start a snapshot job for.

Returns:

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

snapshotJobId

StartDashboardSnapshotJobRequest.Builder snapshotJobId(String snapshotJobId)

An ID for the dashboard snapshot job. This ID is unique to the dashboard while the job is running. This ID can be used to poll the status of a job with a DescribeDashboardSnapshotJob while the job runs. You can reuse this ID for another job 24 hours after the current job is completed.

Parameters:

snapshotJobId - An ID for the dashboard snapshot job. This ID is unique to the dashboard while the job is running. This ID can be used to poll the status of a job with a DescribeDashboardSnapshotJob while the job runs. You can reuse this ID for another job 24 hours after the current job is completed.

Returns:

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

userConfiguration

StartDashboardSnapshotJobRequest.Builder userConfiguration(SnapshotUserConfiguration userConfiguration)

A structure that contains information about the anonymous users that the generated snapshot is for. This API will not return information about registered Amazon QuickSight.

Parameters:

userConfiguration - A structure that contains information about the anonymous users that the generated snapshot is for. This API will not return information about registered Amazon QuickSight.

Returns:

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

userConfiguration

default StartDashboardSnapshotJobRequest.Builder userConfiguration(Consumer<SnapshotUserConfiguration.Builder> userConfiguration)

A structure that contains information about the anonymous users that the generated snapshot is for. This API will not return information about registered Amazon QuickSight.

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

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

Parameters:

userConfiguration - a consumer that will call methods on SnapshotUserConfiguration.Builder

Returns:

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

See Also:

• userConfiguration(SnapshotUserConfiguration)

snapshotConfiguration

StartDashboardSnapshotJobRequest.Builder snapshotConfiguration(SnapshotConfiguration snapshotConfiguration)

A structure that describes the configuration of the dashboard snapshot.

Parameters:

snapshotConfiguration - A structure that describes the configuration of the dashboard snapshot.

Returns:

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

snapshotConfiguration

default StartDashboardSnapshotJobRequest.Builder snapshotConfiguration(Consumer<SnapshotConfiguration.Builder> snapshotConfiguration)

A structure that describes the configuration of the dashboard snapshot.

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

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

Parameters:

snapshotConfiguration - a consumer that will call methods on SnapshotConfiguration.Builder

Returns:

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

See Also:

• snapshotConfiguration(SnapshotConfiguration)

overrideConfiguration

StartDashboardSnapshotJobRequest.Builder overrideConfiguration(AwsRequestOverrideConfiguration overrideConfiguration)

Description copied from interface: AwsRequest.Builder

Add an optional request override configuration.

Specified by:

overrideConfiguration in interface AwsRequest.Builder

Parameters:

overrideConfiguration - The override configuration.

Returns:

This object for method chaining.

overrideConfiguration

StartDashboardSnapshotJobRequest.Builder overrideConfiguration(Consumer<AwsRequestOverrideConfiguration.Builder> builderConsumer)

Description copied from interface: AwsRequest.Builder

Add an optional request override configuration.

Specified by:

overrideConfiguration in interface AwsRequest.Builder

Parameters:

builderConsumer - A Consumer to which an empty AwsRequestOverrideConfiguration.Builder will be given.

Returns:

This object for method chaining.