Package software.amazon.awssdk.services.redshift.model

Class BatchModifyClusterSnapshotsRequest

java.lang.Object

software.amazon.awssdk.core.SdkRequest

software.amazon.awssdk.awscore.AwsRequest

software.amazon.awssdk.services.redshift.model.RedshiftRequest

software.amazon.awssdk.services.redshift.model.BatchModifyClusterSnapshotsRequest

All Implemented Interfaces:

SdkPojo, ToCopyableBuilder<BatchModifyClusterSnapshotsRequest.Builder,BatchModifyClusterSnapshotsRequest>

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

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static interface	BatchModifyClusterSnapshotsRequest.Builder

Method Summary

Modifier and Type	Method	Description
static BatchModifyClusterSnapshotsRequest.Builder	builder()
boolean	equals(Object obj)
boolean	equalsBySdkFields(Object obj)
Boolean	force()	A boolean value indicating whether to override an exception if the retention period has passed.
<T> Optional<T>	getValueForField(String fieldName, Class<T> clazz)
int	hashCode()
boolean	hasSnapshotIdentifierList()	For responses, this returns true if the service returned a value for the SnapshotIdentifierList property.
Integer	manualSnapshotRetentionPeriod()	The number of days that a manual snapshot is retained.
List<SdkField<?>>	sdkFields()
static Class<? extends BatchModifyClusterSnapshotsRequest.Builder>	serializableBuilderClass()
List<String>	snapshotIdentifierList()	A list of snapshot identifiers you want to modify.
BatchModifyClusterSnapshotsRequest.Builder	toBuilder()
String	toString()	Returns a string representation of this object.

Methods inherited from class software.amazon.awssdk.awscore.AwsRequest

overrideConfiguration

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

hasSnapshotIdentifierList

public final boolean hasSnapshotIdentifierList()

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

snapshotIdentifierList

public final List<String> snapshotIdentifierList()

A list of snapshot identifiers you want to modify.

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

Returns:

A list of snapshot identifiers you want to modify.

manualSnapshotRetentionPeriod

public final Integer manualSnapshotRetentionPeriod()

The number of days that a manual snapshot is retained. If you specify the value -1, the manual snapshot is retained indefinitely.

The number must be either -1 or an integer between 1 and 3,653.

If you decrease the manual snapshot retention period from its current value, existing manual snapshots that fall outside of the new retention period will return an error. If you want to suppress the errors and delete the snapshots, use the force option.

Returns:

The number of days that a manual snapshot is retained. If you specify the value -1, the manual snapshot is retained indefinitely.

The number must be either -1 or an integer between 1 and 3,653.

If you decrease the manual snapshot retention period from its current value, existing manual snapshots that fall outside of the new retention period will return an error. If you want to suppress the errors and delete the snapshots, use the force option.

force

public final Boolean force()

A boolean value indicating whether to override an exception if the retention period has passed.

Returns:

A boolean value indicating whether to override an exception if the retention period has passed.

toBuilder

public BatchModifyClusterSnapshotsRequest.Builder toBuilder()

Specified by:

toBuilder in interface ToCopyableBuilder<BatchModifyClusterSnapshotsRequest.Builder,BatchModifyClusterSnapshotsRequest>

Specified by:

toBuilder in class RedshiftRequest

builder

public static BatchModifyClusterSnapshotsRequest.Builder builder()

serializableBuilderClass

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

hashCode

public final int hashCode()

Overrides:

hashCode in class AwsRequest

equals

public final boolean equals(Object obj)

Overrides:

equals in class AwsRequest

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 SdkRequest

sdkFields

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

Specified by:

sdkFields in interface SdkPojo