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

Class SnapshotJobS3Result

java.lang.Object

software.amazon.awssdk.services.quicksight.model.SnapshotJobS3Result

All Implemented Interfaces:

Serializable, SdkPojo, ToCopyableBuilder<SnapshotJobS3Result.Builder,SnapshotJobS3Result>

@Generated("software.amazon.awssdk:codegen")
public final class SnapshotJobS3Result
extends Object
implements SdkPojo, Serializable, ToCopyableBuilder<SnapshotJobS3Result.Builder,SnapshotJobS3Result>

The Amazon S3 result from the snapshot job. The result includes the DestinationConfiguration and the Amazon S3 Uri. If an error occured during the job, the result returns information on the error.

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static interface	SnapshotJobS3Result.Builder

Method Summary

Modifier and Type	Method	Description
static SnapshotJobS3Result.Builder	builder()
boolean	equals(Object obj)
boolean	equalsBySdkFields(Object obj)
List<SnapshotJobResultErrorInfo>	errorInfo()	An array of error records that describe any failures that occur while the dashboard snapshot job runs.
<T> Optional<T>	getValueForField(String fieldName, Class<T> clazz)
boolean	hasErrorInfo()	For responses, this returns true if the service returned a value for the ErrorInfo property.
int	hashCode()
SnapshotS3DestinationConfiguration	s3DestinationConfiguration()	A list of Amazon S3 bucket configurations that are provided when you make a StartDashboardSnapshotJob API call.
String	s3Uri()	The Amazon S3 Uri.
List<SdkField<?>>	sdkFields()
static Class<? extends SnapshotJobS3Result.Builder>	serializableBuilderClass()
SnapshotJobS3Result.Builder	toBuilder()
String	toString()	Returns a string representation of this object.

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

s3DestinationConfiguration

public final SnapshotS3DestinationConfiguration s3DestinationConfiguration()

A list of Amazon S3 bucket configurations that are provided when you make a StartDashboardSnapshotJob API call.

Returns:

A list of Amazon S3 bucket configurations that are provided when you make a StartDashboardSnapshotJob API call.

s3Uri

public final String s3Uri()

The Amazon S3 Uri.

Returns:

The Amazon S3 Uri.

hasErrorInfo

public final boolean hasErrorInfo()

For responses, this returns true if the service returned a value for the ErrorInfo property. This DOES NOT check that the value is non-empty (for which, you should check the isEmpty() method on the property). This is useful because the SDK will never return a null collection or map, but you may need to differentiate between the service returning nothing (or null) and the service returning an empty collection or map. For requests, this returns true if a value for the property was specified in the request builder, and false if a value was not specified.

errorInfo

public final List<SnapshotJobResultErrorInfo> errorInfo()

An array of error records that describe any failures that occur while the dashboard snapshot job runs.

Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.

This method will never return null. If you would like to know whether the service returned this field (so that you can differentiate between null and empty), you can use the hasErrorInfo() method.

Returns:

An array of error records that describe any failures that occur while the dashboard snapshot job runs.

toBuilder

public SnapshotJobS3Result.Builder toBuilder()

Specified by:

toBuilder in interface ToCopyableBuilder<SnapshotJobS3Result.Builder,SnapshotJobS3Result>

builder

public static SnapshotJobS3Result.Builder builder()

serializableBuilderClass

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

hashCode

public final int hashCode()

Overrides:

hashCode in class Object

equals

public final boolean equals(Object obj)

Overrides:

equals in class Object

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)

sdkFields

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

Specified by:

sdkFields in interface SdkPojo