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

Class DescribeDashboardSnapshotJobResultResponse

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

All Implemented Interfaces:

SdkPojo, ToCopyableBuilder<DescribeDashboardSnapshotJobResultResponse.Builder,DescribeDashboardSnapshotJobResultResponse>

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

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static interface	DescribeDashboardSnapshotJobResultResponse.Builder

Method Summary

Modifier and Type	Method	Description
String	arn()	The Amazon Resource Name (ARN) for the snapshot job.
static DescribeDashboardSnapshotJobResultResponse.Builder	builder()
Instant	createdTime()	The time that a snapshot job was created.
boolean	equals(Object obj)
boolean	equalsBySdkFields(Object obj)
SnapshotJobErrorInfo	errorInfo()	Displays information for the error that caused a job to fail.
<T> Optional<T>	getValueForField(String fieldName, Class<T> clazz)
int	hashCode()
SnapshotJobStatus	jobStatus()	Indicates the status of a job after it has reached a terminal state.
String	jobStatusAsString()	Indicates the status of a job after it has reached a terminal state.
Instant	lastUpdatedTime()	The time that a snapshot job status was last updated.
String	requestId()	The Amazon Web Services request ID for this operation.
SnapshotJobResult	result()	The result of the snapshot job.
Map<String,SdkField<?>>	sdkFieldNameToField()
List<SdkField<?>>	sdkFields()
static Class<? extends DescribeDashboardSnapshotJobResultResponse.Builder>	serializableBuilderClass()
Integer	status()	The HTTP status of the request
DescribeDashboardSnapshotJobResultResponse.Builder	toBuilder()
String	toString()	Returns a string representation of this object.

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

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 after it has reached a terminal state. A finished snapshot job will retuen a COMPLETED or FAILED status.

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 after it has reached a terminal state. A finished snapshot job will retuen a COMPLETED or FAILED status.

See Also:

SnapshotJobStatus

jobStatusAsString

public final String jobStatusAsString()

Indicates the status of a job after it has reached a terminal state. A finished snapshot job will retuen a COMPLETED or FAILED status.

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 after it has reached a terminal state. A finished snapshot job will retuen a COMPLETED or FAILED status.

See Also:

SnapshotJobStatus

createdTime

public final Instant createdTime()

The time that a snapshot job was created.

Returns:

The time that a snapshot job was created.

lastUpdatedTime

public final Instant lastUpdatedTime()

The time that a snapshot job status was last updated.

Returns:

The time that a snapshot job status was last updated.

result

public final SnapshotJobResult result()

The result of the snapshot job. Jobs that have successfully completed will return the S3Uri where they are located. Jobs that have failedwill return information on the error that caused the job to fail.

Returns:

The result of the snapshot job. Jobs that have successfully completed will return the S3Uri where they are located. Jobs that have failedwill return information on the error that caused the job to fail.

errorInfo

public final SnapshotJobErrorInfo errorInfo()

Displays information for the error that caused a job to fail.

Returns:

Displays information for the error that caused a job to fail.

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 DescribeDashboardSnapshotJobResultResponse.Builder toBuilder()

Specified by:

toBuilder in interface ToCopyableBuilder<DescribeDashboardSnapshotJobResultResponse.Builder,DescribeDashboardSnapshotJobResultResponse>

Specified by:

toBuilder in class AwsResponse

builder

public static DescribeDashboardSnapshotJobResultResponse.Builder builder()

serializableBuilderClass

public static Class<? extends DescribeDashboardSnapshotJobResultResponse.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

sdkFieldNameToField

public final Map<String,SdkField<?>> sdkFieldNameToField()

Specified by:

sdkFieldNameToField in interface SdkPojo