Class CreateScheduleRequest

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

  • Method Details

    • actionAfterCompletion

      public final ActionAfterCompletion actionAfterCompletion()

      Specifies the action that EventBridge Scheduler applies to the schedule after the schedule completes invoking the target.

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

      Returns:
      Specifies the action that EventBridge Scheduler applies to the schedule after the schedule completes invoking the target.
      See Also:

    • actionAfterCompletionAsString

      public final String actionAfterCompletionAsString()

      Specifies the action that EventBridge Scheduler applies to the schedule after the schedule completes invoking the target.

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

      Returns:
      Specifies the action that EventBridge Scheduler applies to the schedule after the schedule completes invoking the target.
      See Also:

    • clientToken

      public final String clientToken()

      Unique, case-sensitive identifier you provide to ensure the idempotency of the request. If you do not specify a client token, EventBridge Scheduler uses a randomly generated token for the request to ensure idempotency.

      Returns:
      Unique, case-sensitive identifier you provide to ensure the idempotency of the request. If you do not specify a client token, EventBridge Scheduler uses a randomly generated token for the request to ensure idempotency.

    • description

      public final String description()

      The description you specify for the schedule.

      Returns:
      The description you specify for the schedule.

    • endDate

      public final Instant endDate()

      The date, in UTC, before which the schedule can invoke its target. Depending on the schedule's recurrence expression, invocations might stop on, or before, the EndDate you specify. EventBridge Scheduler ignores EndDate for one-time schedules.

      Returns:
      The date, in UTC, before which the schedule can invoke its target. Depending on the schedule's recurrence expression, invocations might stop on, or before, the EndDate you specify. EventBridge Scheduler ignores EndDate for one-time schedules.

    • flexibleTimeWindow

      public final FlexibleTimeWindow flexibleTimeWindow()

      Allows you to configure a time window during which EventBridge Scheduler invokes the schedule.

      Returns:
      Allows you to configure a time window during which EventBridge Scheduler invokes the schedule.

    • groupName

      public final String groupName()

      The name of the schedule group to associate with this schedule. If you omit this, the default schedule group is used.

      Returns:
      The name of the schedule group to associate with this schedule. If you omit this, the default schedule group is used.

    • kmsKeyArn

      public final String kmsKeyArn()

      The Amazon Resource Name (ARN) for the customer managed KMS key that EventBridge Scheduler will use to encrypt and decrypt your data.

      Returns:
      The Amazon Resource Name (ARN) for the customer managed KMS key that EventBridge Scheduler will use to encrypt and decrypt your data.

    • name

      public final String name()

      The name of the schedule that you are creating.

      Returns:
      The name of the schedule that you are creating.

    • scheduleExpression

      public final String scheduleExpression()

      The expression that defines when the schedule runs. The following formats are supported.

      • at expression - at(yyyy-mm-ddThh:mm:ss)

      • rate expression - rate(value unit)

      • cron expression - cron(fields)

      You can use at expressions to create one-time schedules that invoke a target once, at the time and in the time zone, that you specify. You can use rate and cron expressions to create recurring schedules. Rate-based schedules are useful when you want to invoke a target at regular intervals, such as every 15 minutes or every five days. Cron-based schedules are useful when you want to invoke a target periodically at a specific time, such as at 8:00 am (UTC+0) every 1st day of the month.

      A cron expression consists of six fields separated by white spaces: (minutes hours day_of_month month day_of_week year).

      A rate expression consists of a value as a positive integer, and a unit with the following options: minute | minutes | hour | hours | day | days

      For more information and examples, see Schedule types on EventBridge Scheduler in the EventBridge Scheduler User Guide.

      Returns:
      The expression that defines when the schedule runs. The following formats are supported.

      • at expression - at(yyyy-mm-ddThh:mm:ss)

      • rate expression - rate(value unit)

      • cron expression - cron(fields)

      You can use at expressions to create one-time schedules that invoke a target once, at the time and in the time zone, that you specify. You can use rate and cron expressions to create recurring schedules. Rate-based schedules are useful when you want to invoke a target at regular intervals, such as every 15 minutes or every five days. Cron-based schedules are useful when you want to invoke a target periodically at a specific time, such as at 8:00 am (UTC+0) every 1st day of the month.

      A cron expression consists of six fields separated by white spaces: (minutes hours day_of_month month day_of_week year).

      A rate expression consists of a value as a positive integer, and a unit with the following options: minute | minutes | hour | hours | day | days

      For more information and examples, see Schedule types on EventBridge Scheduler in the EventBridge Scheduler User Guide.

    • scheduleExpressionTimezone

      public final String scheduleExpressionTimezone()

      The timezone in which the scheduling expression is evaluated.

      Returns:
      The timezone in which the scheduling expression is evaluated.

    • startDate

      public final Instant startDate()

      The date, in UTC, after which the schedule can begin invoking its target. Depending on the schedule's recurrence expression, invocations might occur on, or after, the StartDate you specify. EventBridge Scheduler ignores StartDate for one-time schedules.

      Returns:
      The date, in UTC, after which the schedule can begin invoking its target. Depending on the schedule's recurrence expression, invocations might occur on, or after, the StartDate you specify. EventBridge Scheduler ignores StartDate for one-time schedules.

    • state

      public final ScheduleState state()

      Specifies whether the schedule is enabled or disabled.

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

      Returns:
      Specifies whether the schedule is enabled or disabled.
      See Also:

    • stateAsString

      public final String stateAsString()

      Specifies whether the schedule is enabled or disabled.

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

      Returns:
      Specifies whether the schedule is enabled or disabled.
      See Also:

    • target

      public final Target target()

      The schedule's target.

      Returns:
      The schedule's target.

    • toBuilder

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

    • builder

      public static CreateScheduleRequest.Builder builder()

    • serializableBuilderClass

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

    • sdkFieldNameToField

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