software.amazon.awssdk.services.redshift.model

Class SnapshotSchedule

java.lang.Object

software.amazon.awssdk.services.redshift.model.SnapshotSchedule

All Implemented Interfaces:

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

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

Describes a snapshot schedule. You can set a regular interval for creating snapshots of a cluster. You can also schedule snapshots for specific dates.

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static interface	SnapshotSchedule.Builder

Method Summary

Modifier and Type	Method and Description
Integer	associatedClusterCount() The number of clusters associated with the schedule.
List<ClusterAssociatedToSchedule>	associatedClusters() A list of clusters associated with the schedule.
static SnapshotSchedule.Builder	builder()
boolean	equals(Object obj)
boolean	equalsBySdkFields(Object obj)
<T> Optional<T>	getValueForField(String fieldName, Class<T> clazz)
boolean	hasAssociatedClusters() For responses, this returns true if the service returned a value for the AssociatedClusters property.
int	hashCode()
boolean	hasNextInvocations() For responses, this returns true if the service returned a value for the NextInvocations property.
boolean	hasScheduleDefinitions() For responses, this returns true if the service returned a value for the ScheduleDefinitions property.
boolean	hasTags() For responses, this returns true if the service returned a value for the Tags property.
List<Instant>	nextInvocations()
List<String>	scheduleDefinitions() A list of ScheduleDefinitions.
String	scheduleDescription() The description of the schedule.
String	scheduleIdentifier() A unique identifier for the schedule.
List<SdkField<?>>	sdkFields()
static Class<? extends SnapshotSchedule.Builder>	serializableBuilderClass()
List<Tag>	tags() An optional set of tags describing the schedule.
SnapshotSchedule.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

hasScheduleDefinitions

public final boolean hasScheduleDefinitions()

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

scheduleDefinitions

public final List<String> scheduleDefinitions()

A list of ScheduleDefinitions.

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

Returns:

A list of ScheduleDefinitions.

scheduleIdentifier

public final String scheduleIdentifier()

A unique identifier for the schedule.

Returns:

A unique identifier for the schedule.

scheduleDescription

public final String scheduleDescription()

The description of the schedule.

Returns:

The description of the schedule.

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 optional set of tags describing the schedule.

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 optional set of tags describing the schedule.

hasNextInvocations

public final boolean hasNextInvocations()

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

nextInvocations

public final List<Instant> nextInvocations()

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

Returns:

associatedClusterCount

public final Integer associatedClusterCount()

The number of clusters associated with the schedule.

Returns:

The number of clusters associated with the schedule.

hasAssociatedClusters

public final boolean hasAssociatedClusters()

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

associatedClusters

public final List<ClusterAssociatedToSchedule> associatedClusters()

A list of clusters associated with the schedule. A maximum of 100 clusters is returned.

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

Returns:

A list of clusters associated with the schedule. A maximum of 100 clusters is returned.

toBuilder

public SnapshotSchedule.Builder toBuilder()

Specified by:

toBuilder in interface ToCopyableBuilder<SnapshotSchedule.Builder,SnapshotSchedule>

builder

public static SnapshotSchedule.Builder builder()

serializableBuilderClass

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