com.amazonaws.services.quicksight.model

Class StartDashboardSnapshotJobRequest

java.lang.Object

com.amazonaws.AmazonWebServiceRequest

com.amazonaws.services.quicksight.model.StartDashboardSnapshotJobRequest

All Implemented Interfaces:

HandlerContextAware, ReadLimitInfo, Serializable, Cloneable

@Generated(value="com.amazonaws:aws-java-sdk-code-generator")
public class StartDashboardSnapshotJobRequest
extends AmazonWebServiceRequest
implements Serializable, Cloneable

See Also:

AWS API Documentation, Serialized Form

Field Summary

Fields inherited from class com.amazonaws.AmazonWebServiceRequest

NOOP

Constructor Summary

Constructors

Constructor and Description
StartDashboardSnapshotJobRequest()

Method Summary

Modifier and Type	Method and Description
StartDashboardSnapshotJobRequest	clone() Creates a shallow clone of this object for all fields except the handler context.
boolean	equals(Object obj)
String	getAwsAccountId() The ID of the Amazon Web Services account that the dashboard snapshot job is executed in.
String	getDashboardId() The ID of the dashboard that you want to start a snapshot job for.
SnapshotConfiguration	getSnapshotConfiguration() A structure that describes the configuration of the dashboard snapshot.
String	getSnapshotJobId() An ID for the dashboard snapshot job.
SnapshotUserConfiguration	getUserConfiguration() A structure that contains information about the anonymous users that the generated snapshot is for.
int	hashCode()
void	setAwsAccountId(String awsAccountId) The ID of the Amazon Web Services account that the dashboard snapshot job is executed in.
void	setDashboardId(String dashboardId) The ID of the dashboard that you want to start a snapshot job for.
void	setSnapshotConfiguration(SnapshotConfiguration snapshotConfiguration) A structure that describes the configuration of the dashboard snapshot.
void	setSnapshotJobId(String snapshotJobId) An ID for the dashboard snapshot job.
void	setUserConfiguration(SnapshotUserConfiguration userConfiguration) A structure that contains information about the anonymous users that the generated snapshot is for.
String	toString() Returns a string representation of this object.
StartDashboardSnapshotJobRequest	withAwsAccountId(String awsAccountId) The ID of the Amazon Web Services account that the dashboard snapshot job is executed in.
StartDashboardSnapshotJobRequest	withDashboardId(String dashboardId) The ID of the dashboard that you want to start a snapshot job for.
StartDashboardSnapshotJobRequest	withSnapshotConfiguration(SnapshotConfiguration snapshotConfiguration) A structure that describes the configuration of the dashboard snapshot.
StartDashboardSnapshotJobRequest	withSnapshotJobId(String snapshotJobId) An ID for the dashboard snapshot job.
StartDashboardSnapshotJobRequest	withUserConfiguration(SnapshotUserConfiguration userConfiguration) A structure that contains information about the anonymous users that the generated snapshot is for.

Methods inherited from class com.amazonaws.AmazonWebServiceRequest

addHandlerContext, getCloneRoot, getCloneSource, getCustomQueryParameters, getCustomRequestHeaders, getGeneralProgressListener, getHandlerContext, getReadLimit, getRequestClientOptions, getRequestCredentials, getRequestCredentialsProvider, getRequestMetricCollector, getSdkClientExecutionTimeout, getSdkRequestTimeout, putCustomQueryParameter, putCustomRequestHeader, setGeneralProgressListener, setRequestCredentials, setRequestCredentialsProvider, setRequestMetricCollector, setSdkClientExecutionTimeout, setSdkRequestTimeout, withGeneralProgressListener, withRequestCredentialsProvider, withRequestMetricCollector, withSdkClientExecutionTimeout, withSdkRequestTimeout

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Constructor Detail

StartDashboardSnapshotJobRequest

public StartDashboardSnapshotJobRequest()

Method Detail

setAwsAccountId

public void setAwsAccountId(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.

getAwsAccountId

public String getAwsAccountId()

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.

withAwsAccountId

public StartDashboardSnapshotJobRequest withAwsAccountId(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.

setDashboardId

public void setDashboardId(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.

getDashboardId

public String getDashboardId()

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.

withDashboardId

public StartDashboardSnapshotJobRequest withDashboardId(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.

setSnapshotJobId

public void setSnapshotJobId(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.

getSnapshotJobId

public String getSnapshotJobId()

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.

withSnapshotJobId

public StartDashboardSnapshotJobRequest withSnapshotJobId(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.

setUserConfiguration

public void setUserConfiguration(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.

getUserConfiguration

public SnapshotUserConfiguration getUserConfiguration()

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.

withUserConfiguration

public StartDashboardSnapshotJobRequest withUserConfiguration(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.

setSnapshotConfiguration

public void setSnapshotConfiguration(SnapshotConfiguration snapshotConfiguration)

A structure that describes the configuration of the dashboard snapshot.

Parameters:

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

getSnapshotConfiguration

public SnapshotConfiguration getSnapshotConfiguration()

A structure that describes the configuration of the dashboard snapshot.

Returns:

A structure that describes the configuration of the dashboard snapshot.

withSnapshotConfiguration

public StartDashboardSnapshotJobRequest withSnapshotConfiguration(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.

toString

public 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

Returns:

A string representation of this object.

See Also:

Object.toString()

equals

public boolean equals(Object obj)

Overrides:

equals in class Object

hashCode

public int hashCode()

Overrides:

hashCode in class Object

clone

public StartDashboardSnapshotJobRequest clone()

Description copied from class: AmazonWebServiceRequest

Creates a shallow clone of this object for all fields except the handler context. Explicitly does not clone the deep structure of the other fields in the message.

Overrides:

clone in class AmazonWebServiceRequest

See Also:

Object.clone()