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:

  • Method Details

    • 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()
      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<CreateSnapshotScheduleActionParameters.Builder,CreateSnapshotScheduleActionParameters>
      Returns:
      a builder for type T

    • 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)
      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 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
      Returns:
      List of SdkField in this POJO. May be empty list but should never be null.