Class ScheduledAction

java.lang.Object
software.amazon.awssdk.services.redshift.model.ScheduledAction
All Implemented Interfaces:
Serializable, SdkPojo, ToCopyableBuilder<ScheduledAction.Builder,ScheduledAction>
@Generated("software.amazon.awssdk:codegen") public final class ScheduledAction extends Object implements SdkPojo, Serializable, ToCopyableBuilder<ScheduledAction.Builder,ScheduledAction>

Describes a scheduled action. You can use a scheduled action to trigger some Amazon Redshift API operations on a schedule. For information about which API operations can be scheduled, see ScheduledActionType.

See Also:

  • Method Details

    • scheduledActionName

      public final String scheduledActionName()

      The name of the scheduled action.

      Returns:
      The name of the scheduled action.

    • targetAction

      public final ScheduledActionType targetAction()

      A JSON format string of the Amazon Redshift API operation with input parameters.

      " {\"ResizeCluster\":{\"NodeType\":\"ra3.4xlarge\",\"ClusterIdentifier\":\"my-test-cluster\",\"NumberOfNodes\":3}} ".

      Returns:
      A JSON format string of the Amazon Redshift API operation with input parameters.

      " {\"ResizeCluster\":{\"NodeType\":\"ra3.4xlarge\",\"ClusterIdentifier\":\"my-test-cluster\",\"NumberOfNodes\":3}} ".

    • schedule

      public final String schedule()

      The schedule for a one-time (at format) or recurring (cron format) scheduled action. Schedule invocations must be separated by at least one hour.

      Format of at expressions is "at(yyyy-mm-ddThh:mm:ss)". For example, " at(2016-03-04T17:27:00)".

      Format of cron expressions is "cron(Minutes Hours Day-of-month Month Day-of-week Year) ". For example, "cron(0 10 ? * MON *) ". For more information, see Cron Expressions in the Amazon CloudWatch Events User Guide.

      Returns:
      The schedule for a one-time (at format) or recurring (cron format) scheduled action. Schedule invocations must be separated by at least one hour.

      Format of at expressions is "at(yyyy-mm-ddThh:mm:ss)". For example, " at(2016-03-04T17:27:00)".

      Format of cron expressions is "cron(Minutes Hours Day-of-month Month Day-of-week Year) ". For example, "cron(0 10 ? * MON *) ". For more information, see Cron Expressions in the Amazon CloudWatch Events User Guide.

    • iamRole

      public final String iamRole()

      The IAM role to assume to run the scheduled action. This IAM role must have permission to run the Amazon Redshift API operation in the scheduled action. This IAM role must allow the Amazon Redshift scheduler (Principal scheduler.redshift.amazonaws.com) to assume permissions on your behalf. For more information about the IAM role to use with the Amazon Redshift scheduler, see Using Identity-Based Policies for Amazon Redshift in the Amazon Redshift Cluster Management Guide.

      Returns:
      The IAM role to assume to run the scheduled action. This IAM role must have permission to run the Amazon Redshift API operation in the scheduled action. This IAM role must allow the Amazon Redshift scheduler (Principal scheduler.redshift.amazonaws.com) to assume permissions on your behalf. For more information about the IAM role to use with the Amazon Redshift scheduler, see Using Identity-Based Policies for Amazon Redshift in the Amazon Redshift Cluster Management Guide.

    • scheduledActionDescription

      public final String scheduledActionDescription()

      The description of the scheduled action.

      Returns:
      The description of the scheduled action.

    • state

      public final ScheduledActionState state()

      The state of the scheduled action. For example, DISABLED.

      If the service returns an enum value that is not available in the current SDK version, state will return ScheduledActionState.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from stateAsString().

      Returns:
      The state of the scheduled action. For example, DISABLED.
      See Also:

    • stateAsString

      public final String stateAsString()

      The state of the scheduled action. For example, DISABLED.

      If the service returns an enum value that is not available in the current SDK version, state will return ScheduledActionState.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from stateAsString().

      Returns:
      The state of the scheduled action. For example, DISABLED.
      See Also:

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

      List of times when the scheduled action will run.

      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:
      List of times when the scheduled action will run.

    • startTime

      public final Instant startTime()

      The start time in UTC when the schedule is active. Before this time, the scheduled action does not trigger.

      Returns:
      The start time in UTC when the schedule is active. Before this time, the scheduled action does not trigger.

    • endTime

      public final Instant endTime()

      The end time in UTC when the schedule is no longer active. After this time, the scheduled action does not trigger.

      Returns:
      The end time in UTC when the schedule is no longer active. After this time, the scheduled action does not trigger.

    • toBuilder

      public ScheduledAction.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<ScheduledAction.Builder,ScheduledAction>
      Returns:
      a builder for type T

    • builder

      public static ScheduledAction.Builder builder()

    • serializableBuilderClass

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

    • sdkFieldNameToField

      public final Map<String,SdkField<?>> sdkFieldNameToField()
      Specified by:
      sdkFieldNameToField in interface SdkPojo
      Returns:
      The mapping between the field name and its corresponding field.