software.amazon.awssdk.services.quicksight.model

Class StartDashboardSnapshotJobRequest

java.lang.Object

software.amazon.awssdk.core.SdkRequest

software.amazon.awssdk.awscore.AwsRequest

software.amazon.awssdk.services.quicksight.model.QuickSightRequest

software.amazon.awssdk.services.quicksight.model.StartDashboardSnapshotJobRequest

All Implemented Interfaces:

SdkPojo, ToCopyableBuilder<StartDashboardSnapshotJobRequest.Builder,StartDashboardSnapshotJobRequest>

@Generated(value="software.amazon.awssdk:codegen")
public final class StartDashboardSnapshotJobRequest
extends QuickSightRequest
implements ToCopyableBuilder<StartDashboardSnapshotJobRequest.Builder,StartDashboardSnapshotJobRequest>

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static interface	StartDashboardSnapshotJobRequest.Builder

Method Summary

Modifier and Type	Method and Description
String	awsAccountId() The ID of the Amazon Web Services account that the dashboard snapshot job is executed in.
static StartDashboardSnapshotJobRequest.Builder	builder()
String	dashboardId() The ID of the dashboard that you want to start a snapshot job for.
boolean	equals(Object obj)
boolean	equalsBySdkFields(Object obj)
<T> Optional<T>	getValueForField(String fieldName, Class<T> clazz)
int	hashCode()
List<SdkField<?>>	sdkFields()
static Class<? extends StartDashboardSnapshotJobRequest.Builder>	serializableBuilderClass()
SnapshotConfiguration	snapshotConfiguration() A structure that describes the configuration of the dashboard snapshot.
String	snapshotJobId() An ID for the dashboard snapshot job.
StartDashboardSnapshotJobRequest.Builder	toBuilder()
String	toString() Returns a string representation of this object.
SnapshotUserConfiguration	userConfiguration() A structure that contains information about the anonymous users that the generated snapshot is for.

Methods inherited from class software.amazon.awssdk.awscore.AwsRequest

overrideConfiguration

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

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

copy

Method Detail

awsAccountId

public final String awsAccountId()

The ID of the Amazon Web Services account that the dashboard snapshot job is executed in.

Returns:

The ID of the Amazon Web Services account that the dashboard snapshot job is executed in.

dashboardId

public final String dashboardId()

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

Returns:

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

snapshotJobId

public final 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.

Returns:

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.

userConfiguration

public final 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.

Returns:

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.

snapshotConfiguration

public final SnapshotConfiguration snapshotConfiguration()

A structure that describes the configuration of the dashboard snapshot.

Returns:

A structure that describes the configuration of the dashboard snapshot.

toBuilder

public StartDashboardSnapshotJobRequest.Builder toBuilder()

Specified by:

toBuilder in interface ToCopyableBuilder<StartDashboardSnapshotJobRequest.Builder,StartDashboardSnapshotJobRequest>

Specified by:

toBuilder in class QuickSightRequest

builder

public static StartDashboardSnapshotJobRequest.Builder builder()

serializableBuilderClass

public static Class<? extends StartDashboardSnapshotJobRequest.Builder> serializableBuilderClass()

hashCode

public final int hashCode()

Overrides:

hashCode in class AwsRequest

equals

public final boolean equals(Object obj)

Overrides:

equals in class AwsRequest

equalsBySdkFields

public final boolean equalsBySdkFields(Object obj)

Specified by:

equalsBySdkFields in interface SdkPojo

toString

public final String toString()

Returns a string representation of this object. This is useful for testing and debugging. Sensitive data will be redacted from this string using a placeholder value.

Overrides:

toString in class Object

getValueForField

public final <T> Optional<T> getValueForField(String fieldName,
                                              Class<T> clazz)

Overrides:

getValueForField in class SdkRequest

sdkFields

public final List<SdkField<?>> sdkFields()

Specified by:

sdkFields in interface SdkPojo