software.amazon.awssdk.services.redshift.model

Class DeleteClusterRequest

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

All Implemented Interfaces:

SdkPojo, ToCopyableBuilder<DeleteClusterRequest.Builder,DeleteClusterRequest>

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

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static interface	DeleteClusterRequest.Builder

Method Summary

Modifier and Type	Method and Description
static DeleteClusterRequest.Builder	builder()
String	clusterIdentifier() The identifier of the cluster to be deleted.
boolean	equals(Object obj)
boolean	equalsBySdkFields(Object obj) Indicates whether some other object is "equal to" this one by SDK fields.
String	finalClusterSnapshotIdentifier() The identifier of the final snapshot that is to be created immediately before deleting the cluster.
Integer	finalClusterSnapshotRetentionPeriod() The number of days that a manual snapshot is retained.
<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()
List<SdkField<?>>	sdkFields()
static Class<? extends DeleteClusterRequest.Builder>	serializableBuilderClass()
Boolean	skipFinalClusterSnapshot() Determines whether a final snapshot of the cluster is created before Amazon Redshift deletes the cluster.
DeleteClusterRequest.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

clusterIdentifier

public String clusterIdentifier()

The identifier of the cluster to be deleted.

Constraints:

• Must contain lowercase characters.

• Must contain from 1 to 63 alphanumeric characters or hyphens.

• First character must be a letter.

• Cannot end with a hyphen or contain two consecutive hyphens.

Returns:

The identifier of the cluster to be deleted.

Constraints:

• Must contain lowercase characters.

• Must contain from 1 to 63 alphanumeric characters or hyphens.

• First character must be a letter.

• Cannot end with a hyphen or contain two consecutive hyphens.

skipFinalClusterSnapshot

public Boolean skipFinalClusterSnapshot()

Determines whether a final snapshot of the cluster is created before Amazon Redshift deletes the cluster. If true, a final cluster snapshot is not created. If false, a final cluster snapshot is created before the cluster is deleted.

The FinalClusterSnapshotIdentifier parameter must be specified if SkipFinalClusterSnapshot is false.

Default: false

Returns:

Determines whether a final snapshot of the cluster is created before Amazon Redshift deletes the cluster. If true, a final cluster snapshot is not created. If false, a final cluster snapshot is created before the cluster is deleted.

The FinalClusterSnapshotIdentifier parameter must be specified if SkipFinalClusterSnapshot is false.

Default: false

finalClusterSnapshotIdentifier

public String finalClusterSnapshotIdentifier()

The identifier of the final snapshot that is to be created immediately before deleting the cluster. If this parameter is provided, SkipFinalClusterSnapshot must be false.

Constraints:

• Must be 1 to 255 alphanumeric characters.

• First character must be a letter.

• Cannot end with a hyphen or contain two consecutive hyphens.

Returns:

The identifier of the final snapshot that is to be created immediately before deleting the cluster. If this parameter is provided, SkipFinalClusterSnapshot must be false.

Constraints:

• Must be 1 to 255 alphanumeric characters.

• First character must be a letter.

• Cannot end with a hyphen or contain two consecutive hyphens.

finalClusterSnapshotRetentionPeriod

public Integer finalClusterSnapshotRetentionPeriod()

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

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

The default value is -1.

Returns:

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

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

The default value is -1.

toBuilder

public DeleteClusterRequest.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<DeleteClusterRequest.Builder,DeleteClusterRequest>

Specified by:

toBuilder in class RedshiftRequest

Returns:

a builder for type T

builder

public static DeleteClusterRequest.Builder builder()

serializableBuilderClass

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