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(value="software.amazon.awssdk:codegen")
public final class BatchModifyClusterSnapshotsRequest
extends RedshiftRequest
implements ToCopyableBuilder<BatchModifyClusterSnapshotsRequest.Builder,BatchModifyClusterSnapshotsRequest>

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static interface	BatchModifyClusterSnapshotsRequest.Builder

Method Summary

Modifier and Type	Method and Description
static BatchModifyClusterSnapshotsRequest.Builder	builder()
boolean	equals(Object obj)
boolean	equalsBySdkFields(Object obj) Indicates whether some other object is "equal to" this one by SDK fields.
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) Used to retrieve the value of a field from any class that extends SdkRequest.
int	hashCode()
boolean	hasSnapshotIdentifierList() Returns true if the SnapshotIdentifierList property was specified by the sender (it may be empty), or false if the sender did not specify the value (it will be empty).
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() Take this object and create a builder that contains all of the current property values of this object.
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

getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface software.amazon.awssdk.utils.builder.ToCopyableBuilder

copy

Method Detail

hasSnapshotIdentifierList

public boolean hasSnapshotIdentifierList()

Returns true if the SnapshotIdentifierList property was specified by the sender (it may be empty), or false if the sender did not specify the value (it will be empty). For responses returned by the SDK, the sender is the AWS service.

snapshotIdentifierList

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

You can use hasSnapshotIdentifierList() to see if a value was sent in this field.

Returns:

A list of snapshot identifiers you want to modify.

manualSnapshotRetentionPeriod

public 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 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()

Description copied from interface: ToCopyableBuilder

Take this object and create a builder that contains all of the current property values of this object.

Specified by:

toBuilder in interface ToCopyableBuilder<BatchModifyClusterSnapshotsRequest.Builder,BatchModifyClusterSnapshotsRequest>

Specified by:

toBuilder in class RedshiftRequest

Returns:

a builder for type T

builder

public static BatchModifyClusterSnapshotsRequest.Builder builder()

serializableBuilderClass

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

hashCode

public int hashCode()

Overrides:

hashCode in class AwsRequest

equals

public boolean equals(Object obj)

Overrides:

equals in class AwsRequest

equalsBySdkFields

public boolean equalsBySdkFields(Object obj)

Description copied from interface: SdkPojo

Indicates whether some other object is "equal to" this one by SDK fields. An SDK field is a modeled, non-inherited field in an SdkPojo class, and is generated based on a service model.

If an SdkPojo class does not have any inherited fields, equalsBySdkFields and equals are essentially the same.

Specified by:

equalsBySdkFields in interface SdkPojo

Parameters:

obj - the object to be compared with

Returns:

true if the other object equals to this object by sdk fields, false otherwise.

toString

public 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 <T> Optional<T> getValueForField(String fieldName,
                                        Class<T> clazz)

Description copied from class: SdkRequest

Used to retrieve the value of a field from any class that extends SdkRequest. The field name specified should match the member name from the corresponding service-2.json model specified in the codegen-resources folder for a given service. The class specifies what class to cast the returned value to. If the returned value is also a modeled class, the SdkRequest.getValueForField(String, Class) method will again be available.

Overrides:

getValueForField in class SdkRequest

Parameters:

fieldName - The name of the member to be retrieved.

clazz - The class to cast the returned object to.

Returns:

Optional containing the casted return value

sdkFields

public List<SdkField<?>> sdkFields()

Specified by:

sdkFields in interface SdkPojo

Returns:

List of SdkField in this POJO. May be empty list but should never be null.