Class CreateScheduledActionRequest

java.lang.Object
software.amazon.awssdk.core.SdkRequest
software.amazon.awssdk.awscore.AwsRequest
software.amazon.awssdk.services.redshift.model.RedshiftRequest
software.amazon.awssdk.services.redshift.model.CreateScheduledActionRequest
All Implemented Interfaces:
SdkPojo, ToCopyableBuilder<CreateScheduledActionRequest.Builder,CreateScheduledActionRequest>
@Generated("software.amazon.awssdk:codegen") public final class CreateScheduledActionRequest extends RedshiftRequest implements ToCopyableBuilder<CreateScheduledActionRequest.Builder,CreateScheduledActionRequest>

  • Method Details

    • scheduledActionName

      public final String scheduledActionName()

      The name of the scheduled action. The name must be unique within an account. For more information about this parameter, see ScheduledAction.

      Returns:
      The name of the scheduled action. The name must be unique within an account. For more information about this parameter, see ScheduledAction.

    • targetAction

      public final ScheduledActionType targetAction()

      A JSON format string of the Amazon Redshift API operation with input parameters. For more information about this parameter, see ScheduledAction.

      Returns:
      A JSON format string of the Amazon Redshift API operation with input parameters. For more information about this parameter, see ScheduledAction.

    • schedule

      public final String schedule()

      The schedule in at( ) or cron( ) format. For more information about this parameter, see ScheduledAction.

      Returns:
      The schedule in at( ) or cron( ) format. For more information about this parameter, see ScheduledAction.

    • iamRole

      public final String iamRole()

      The IAM role to assume to run the target action. For more information about this parameter, see ScheduledAction.

      Returns:
      The IAM role to assume to run the target action. For more information about this parameter, see ScheduledAction.

    • scheduledActionDescription

      public final String scheduledActionDescription()

      The description of the scheduled action.

      Returns:
      The description of the scheduled action.

    • startTime

      public final Instant startTime()

      The start time in UTC of the scheduled action. Before this time, the scheduled action does not trigger. For more information about this parameter, see ScheduledAction.

      Returns:
      The start time in UTC of the scheduled action. Before this time, the scheduled action does not trigger. For more information about this parameter, see ScheduledAction.

    • endTime

      public final Instant endTime()

      The end time in UTC of the scheduled action. After this time, the scheduled action does not trigger. For more information about this parameter, see ScheduledAction.

      Returns:
      The end time in UTC of the scheduled action. After this time, the scheduled action does not trigger. For more information about this parameter, see ScheduledAction.

    • enable

      public final Boolean enable()

      If true, the schedule is enabled. If false, the scheduled action does not trigger. For more information about state of the scheduled action, see ScheduledAction.

      Returns:
      If true, the schedule is enabled. If false, the scheduled action does not trigger. For more information about state of the scheduled action, see ScheduledAction.

    • toBuilder

      public CreateScheduledActionRequest.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<CreateScheduledActionRequest.Builder,CreateScheduledActionRequest>
      Specified by:
      toBuilder in class RedshiftRequest
      Returns:
      a builder for type T

    • builder

      public static CreateScheduledActionRequest.Builder builder()

    • serializableBuilderClass

      public static Class<? extends CreateScheduledActionRequest.Builder> serializableBuilderClass()

    • hashCode

      public final int hashCode()
      Overrides:
      hashCode in class AwsRequest

    • equals

      public final boolean equals(Object obj)
      Overrides:
      equals in class AwsRequest

    • 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)
      Description copied from class: SdkRequest
      Used to retrieve the value of a field from any class that extends SdkRequest. The field name specified should match the member name from the corresponding service-2.json model specified in the codegen-resources folder for a given service. The class specifies what class to cast the returned value to. If the returned value is also a modeled class, the SdkRequest.getValueForField(String, Class) method will again be available.
      Overrides:
      getValueForField in class SdkRequest
      Parameters:
      fieldName - The name of the member to be retrieved.
      clazz - The class to cast the returned object to.
      Returns:
      Optional containing the casted return value

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