Package software.amazon.awssdk.services.quicksight.model

Class DescribeDashboardSnapshotJobResponse

java.lang.Object

software.amazon.awssdk.core.SdkResponse

software.amazon.awssdk.awscore.AwsResponse

software.amazon.awssdk.services.quicksight.model.QuickSightResponse

software.amazon.awssdk.services.quicksight.model.DescribeDashboardSnapshotJobResponse

All Implemented Interfaces:

SdkPojo, ToCopyableBuilder<DescribeDashboardSnapshotJobResponse.Builder,DescribeDashboardSnapshotJobResponse>

@Generated("software.amazon.awssdk:codegen")
public final class DescribeDashboardSnapshotJobResponse
extends QuickSightResponse
implements ToCopyableBuilder<DescribeDashboardSnapshotJobResponse.Builder,DescribeDashboardSnapshotJobResponse>

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static interface	DescribeDashboardSnapshotJobResponse.Builder

Method Summary

Modifier and Type	Method	Description
String	arn()	The Amazon Resource Name (ARN) for the snapshot job.
String	awsAccountId()	The ID of the Amazon Web Services account that the dashboard snapshot job is executed in.
static DescribeDashboardSnapshotJobResponse.Builder	builder()
Instant	createdTime()	The time that the snapshot job was created.
String	dashboardId()	The ID of the dashboard that you have started a snapshot job for.
boolean	equals(Object obj)
boolean	equalsBySdkFields(Object obj)
<T> Optional<T>	getValueForField(String fieldName, Class<T> clazz)
int	hashCode()
SnapshotJobStatus	jobStatus()	Indicates the status of a job.
String	jobStatusAsString()	Indicates the status of a job.
Instant	lastUpdatedTime()	The time that the snapshot job status was last updated.
String	requestId()	The Amazon Web Services request ID for this operation.
List<SdkField<?>>	sdkFields()
static Class<? extends DescribeDashboardSnapshotJobResponse.Builder>	serializableBuilderClass()
SnapshotConfiguration	snapshotConfiguration()	The snapshot configuration of the job.
String	snapshotJobId()	The ID of the job to be described.
Integer	status()	The HTTP status of the request
DescribeDashboardSnapshotJobResponse.Builder	toBuilder()
String	toString()	Returns a string representation of this object.
SnapshotUserConfigurationRedacted	userConfiguration()	The user configuration for the snapshot job.

Methods inherited from class software.amazon.awssdk.services.quicksight.model.QuickSightResponse

responseMetadata

Methods inherited from class software.amazon.awssdk.core.SdkResponse

sdkHttpResponse

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 have started a snapshot job for.

Returns:

The ID of the dashboard that you have started a snapshot job for.

snapshotJobId

public final String snapshotJobId()

The ID of the job to be described. The job ID is set when you start a new job with a StartDashboardSnapshotJob API call.

Returns:

The ID of the job to be described. The job ID is set when you start a new job with a StartDashboardSnapshotJob API call.

userConfiguration

public final SnapshotUserConfigurationRedacted userConfiguration()

The user configuration for the snapshot job. This information is provided when you make a StartDashboardSnapshotJob API call.

Returns:

The user configuration for the snapshot job. This information is provided when you make a StartDashboardSnapshotJob API call.

snapshotConfiguration

public final SnapshotConfiguration snapshotConfiguration()

The snapshot configuration of the job. This information is provided when you make a StartDashboardSnapshotJob API call.

Returns:

The snapshot configuration of the job. This information is provided when you make a StartDashboardSnapshotJob API call.

arn

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

Returns:

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.

jobStatus

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

If the service returns an enum value that is not available in the current SDK version, jobStatus will return SnapshotJobStatus.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from jobStatusAsString().

Returns:

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.

See Also:

SnapshotJobStatus

jobStatusAsString

public final String jobStatusAsString()

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.

If the service returns an enum value that is not available in the current SDK version, jobStatus will return SnapshotJobStatus.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from jobStatusAsString().

Returns:

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.

See Also:

SnapshotJobStatus

createdTime

public final Instant createdTime()

The time that the snapshot job was created.

Returns:

The time that the snapshot job was created.

lastUpdatedTime

public final Instant lastUpdatedTime()

The time that the snapshot job status was last updated.

Returns:

The time that the snapshot job status was last updated.

requestId

public final String requestId()

The Amazon Web Services request ID for this operation.

Returns:

The Amazon Web Services request ID for this operation.

status

public final Integer status()

The HTTP status of the request

Returns:

The HTTP status of the request

toBuilder

public DescribeDashboardSnapshotJobResponse.Builder toBuilder()

Specified by:

toBuilder in interface ToCopyableBuilder<DescribeDashboardSnapshotJobResponse.Builder,DescribeDashboardSnapshotJobResponse>

Specified by:

toBuilder in class AwsResponse

builder

public static DescribeDashboardSnapshotJobResponse.Builder builder()

serializableBuilderClass

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

hashCode

public final int hashCode()

Overrides:

hashCode in class AwsResponse

equals

public final boolean equals(Object obj)

Overrides:

equals in class AwsResponse

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 SdkResponse

sdkFields

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

Specified by:

sdkFields in interface SdkPojo