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

Class CreateClusterSnapshotRequest

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

All Implemented Interfaces:

SdkPojo, ToCopyableBuilder<CreateClusterSnapshotRequest.Builder,CreateClusterSnapshotRequest>

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

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static interface	CreateClusterSnapshotRequest.Builder

Method Summary

Modifier and Type	Method	Description
static CreateClusterSnapshotRequest.Builder	builder()
String	clusterIdentifier()	The cluster identifier for which you want a snapshot.
boolean	equals(Object obj)
boolean	equalsBySdkFields(Object obj)
<T> Optional<T>	getValueForField(String fieldName, Class<T> clazz)
int	hashCode()
boolean	hasTags()	For responses, this returns true if the service returned a value for the Tags property.
Integer	manualSnapshotRetentionPeriod()	The number of days that a manual snapshot is retained.
Map<String,SdkField<?>>	sdkFieldNameToField()
List<SdkField<?>>	sdkFields()
static Class<? extends CreateClusterSnapshotRequest.Builder>	serializableBuilderClass()
String	snapshotIdentifier()	A unique identifier for the snapshot that you are requesting.
List<Tag>	tags()	A list of tag instances.
CreateClusterSnapshotRequest.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

snapshotIdentifier

public final String snapshotIdentifier()

A unique identifier for the snapshot that you are requesting. This identifier must be unique for all snapshots within the Amazon Web Services account.

Constraints:

• Cannot be null, empty, or blank

• Must contain from 1 to 255 alphanumeric characters or hyphens

• First character must be a letter

• Cannot end with a hyphen or contain two consecutive hyphens

Example: my-snapshot-id

Returns:

A unique identifier for the snapshot that you are requesting. This identifier must be unique for all snapshots within the Amazon Web Services account.

Constraints:

• Cannot be null, empty, or blank

• Must contain from 1 to 255 alphanumeric characters or hyphens

• First character must be a letter

• Cannot end with a hyphen or contain two consecutive hyphens

Example: my-snapshot-id

clusterIdentifier

public final String clusterIdentifier()

The cluster identifier for which you want a snapshot.

Returns:

The cluster identifier for which you want a snapshot.

manualSnapshotRetentionPeriod

public final Integer manualSnapshotRetentionPeriod()

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.

hasTags

public final boolean hasTags()

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

tags

public final List<Tag> tags()

A list of tag instances.

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

Returns:

A list of tag instances.

toBuilder

public CreateClusterSnapshotRequest.Builder toBuilder()

Specified by:

toBuilder in interface ToCopyableBuilder<CreateClusterSnapshotRequest.Builder,CreateClusterSnapshotRequest>

Specified by:

toBuilder in class RedshiftRequest

builder

public static CreateClusterSnapshotRequest.Builder builder()

serializableBuilderClass

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

sdkFieldNameToField

public final Map<String,SdkField<?>> sdkFieldNameToField()

Specified by:

sdkFieldNameToField in interface SdkPojo