Package software.amazon.awssdk.services.redshiftserverless.model

Class CreateSnapshotScheduleActionParameters

java.lang.Object

software.amazon.awssdk.services.redshiftserverless.model.CreateSnapshotScheduleActionParameters

All Implemented Interfaces:

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

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

The parameters that you can use to configure a scheduled action to create a snapshot. For more information about creating a scheduled action, see CreateScheduledAction.

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static interface	CreateSnapshotScheduleActionParameters.Builder

Method Summary

Modifier and Type	Method	Description
static CreateSnapshotScheduleActionParameters.Builder	builder()
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.
String	namespaceName()	The name of the namespace for which you want to configure a scheduled action to create a snapshot.
Integer	retentionPeriod()	The retention period of the snapshot created by the scheduled action.
List<SdkField<?>>	sdkFields()
static Class<? extends CreateSnapshotScheduleActionParameters.Builder>	serializableBuilderClass()
String	snapshotNamePrefix()	A string prefix that is attached to the name of the snapshot created by the scheduled action.
List<Tag>	tags()	An array of Tag objects to associate with the snapshot.
CreateSnapshotScheduleActionParameters.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

namespaceName

public final String namespaceName()

The name of the namespace for which you want to configure a scheduled action to create a snapshot.

Returns:

The name of the namespace for which you want to configure a scheduled action to create a snapshot.

retentionPeriod

public final Integer retentionPeriod()

The retention period of the snapshot created by the scheduled action.

Returns:

The retention period of the snapshot created by the scheduled action.

snapshotNamePrefix

public final String snapshotNamePrefix()

A string prefix that is attached to the name of the snapshot created by the scheduled action. The final name of the snapshot is the string prefix appended by the date and time of when the snapshot was created.

Returns:

A string prefix that is attached to the name of the snapshot created by the scheduled action. The final name of the snapshot is the string prefix appended by the date and time of when the snapshot was created.

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

An array of Tag objects to associate with the snapshot.

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:

An array of Tag objects to associate with the snapshot.

toBuilder

public CreateSnapshotScheduleActionParameters.Builder toBuilder()

Specified by:

toBuilder in interface ToCopyableBuilder<CreateSnapshotScheduleActionParameters.Builder,CreateSnapshotScheduleActionParameters>

builder

public static CreateSnapshotScheduleActionParameters.Builder builder()

serializableBuilderClass

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