software.amazon.awssdk.services.quicksight.model

Class SnapshotConfiguration

java.lang.Object

software.amazon.awssdk.services.quicksight.model.SnapshotConfiguration

All Implemented Interfaces:

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

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

Describes the configuration of the dashboard snapshot.

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static interface	SnapshotConfiguration.Builder

Method Summary

Modifier and Type	Method and Description
static SnapshotConfiguration.Builder	builder()
SnapshotDestinationConfiguration	destinationConfiguration() A structure that contains information on the Amazon S3 bucket that the generated snapshot is stored in.
boolean	equals(Object obj)
boolean	equalsBySdkFields(Object obj)
List<SnapshotFileGroup>	fileGroups() A list of SnapshotJobResultFileGroup objects that contain information about the snapshot that is generated.
<T> Optional<T>	getValueForField(String fieldName, Class<T> clazz)
boolean	hasFileGroups() For responses, this returns true if the service returned a value for the FileGroups property.
int	hashCode()
Parameters	parameters() Returns the value of the Parameters property for this object.
List<SdkField<?>>	sdkFields()
static Class<? extends SnapshotConfiguration.Builder>	serializableBuilderClass()
SnapshotConfiguration.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

hasFileGroups

public final boolean hasFileGroups()

For responses, this returns true if the service returned a value for the FileGroups 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.

fileGroups

public final List<SnapshotFileGroup> fileGroups()

A list of SnapshotJobResultFileGroup objects that contain information about the snapshot that is generated. This list can hold a maximum of 6 FileGroup configurations.

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 hasFileGroups() method.

Returns:

A list of SnapshotJobResultFileGroup objects that contain information about the snapshot that is generated. This list can hold a maximum of 6 FileGroup configurations.

destinationConfiguration

public final SnapshotDestinationConfiguration destinationConfiguration()

A structure that contains information on the Amazon S3 bucket that the generated snapshot is stored in.

Returns:

A structure that contains information on the Amazon S3 bucket that the generated snapshot is stored in.

parameters

public final Parameters parameters()

Returns the value of the Parameters property for this object.

Returns:

The value of the Parameters property for this object.

toBuilder

public SnapshotConfiguration.Builder toBuilder()

Specified by:

toBuilder in interface ToCopyableBuilder<SnapshotConfiguration.Builder,SnapshotConfiguration>

builder

public static SnapshotConfiguration.Builder builder()

serializableBuilderClass

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