Class ScheduledActionResponse

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

The returned scheduled action object.

See Also:

  • Method Details

    • endTime

      public final Instant endTime()

      The end time of

      Returns:
      The end time of

    • namespaceName

      public final String namespaceName()

      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.

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

      An array of timestamps of when the next scheduled actions will trigger.

      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:
      An array of timestamps of when the next scheduled actions will trigger.

    • roleArn

      public final String roleArn()

      The ARN of the IAM role to assume to run the scheduled action. This IAM role must have permission to run the Amazon Redshift Serverless API operation in the scheduled action. This IAM role must allow the Amazon Redshift scheduler to schedule creating snapshots. (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 Management Guide

      Returns:
      The ARN of the IAM role to assume to run the scheduled action. This IAM role must have permission to run the Amazon Redshift Serverless API operation in the scheduled action. This IAM role must allow the Amazon Redshift scheduler to schedule creating snapshots. (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 Management Guide

    • schedule

      public final Schedule schedule()

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

      • Format of at timestamp is yyyy-mm-ddThh:mm:ss. For example, 2016-03-04T17:27:00.

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

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

      • Format of at timestamp is yyyy-mm-ddThh:mm:ss. For example, 2016-03-04T17:27:00 .

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

    • scheduledActionDescription

      public final String scheduledActionDescription()

      The description of the scheduled action.

      Returns:
      The description of the scheduled action.

    • scheduledActionName

      public final String scheduledActionName()

      The name of the scheduled action.

      Returns:
      The name of the scheduled action.

    • scheduledActionUuid

      public final String scheduledActionUuid()

      The uuid of the scheduled action.

      Returns:
      The uuid of the scheduled action.

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

    • state

      public final State state()

      The state of the scheduled action.

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

      Returns:
      The state of the scheduled action.
      See Also:

    • stateAsString

      public final String stateAsString()

      The state of the scheduled action.

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

      Returns:
      The state of the scheduled action.
      See Also:

    • targetAction

      public final TargetAction targetAction()
      Returns the value of the TargetAction property for this object.
      Returns:
      The value of the TargetAction property for this object.

    • toBuilder

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

    • builder

      public static ScheduledActionResponse.Builder builder()

    • serializableBuilderClass

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