software.amazon.awssdk.services.scheduler.model

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(value="software.amazon.awssdk:codegen")
public final class CreateScheduleRequest
extends SchedulerRequest
implements ToCopyableBuilder<CreateScheduleRequest.Builder,CreateScheduleRequest>

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static interface	CreateScheduleRequest.Builder

Method Summary

Modifier and Type	Method and Description
static CreateScheduleRequest.Builder	builder()
String	clientToken() Unique, case-sensitive identifier you provide to ensure the idempotency of the request.
String	description() The description you specify for the schedule.
Instant	endDate() The date, in UTC, before which the schedule can invoke its target.
boolean	equals(Object obj)
boolean	equalsBySdkFields(Object obj)
FlexibleTimeWindow	flexibleTimeWindow() Allows you to configure a time window during which EventBridge Scheduler invokes the schedule.
<T> Optional<T>	getValueForField(String fieldName, Class<T> clazz)
String	groupName() The name of the schedule group to associate with this schedule.
int	hashCode()
String	kmsKeyArn() The Amazon Resource Name (ARN) for the customer managed KMS key that EventBridge Scheduler will use to encrypt and decrypt your data.
String	name() The name of the schedule that you are creating.
String	scheduleExpression() The expression that defines when the schedule runs.
String	scheduleExpressionTimezone() The timezone in which the scheduling expression is evaluated.
List<SdkField<?>>	sdkFields()
static Class<? extends CreateScheduleRequest.Builder>	serializableBuilderClass()
Instant	startDate() The date, in UTC, after which the schedule can begin invoking its target.
ScheduleState	state() Specifies whether the schedule is enabled or disabled.
String	stateAsString() Specifies whether the schedule is enabled or disabled.
Target	target() The schedule's target.
CreateScheduleRequest.Builder	toBuilder()
String	toString() Returns a string representation of this object.

Methods inherited from class software.amazon.awssdk.awscore.AwsRequest

overrideConfiguration

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface software.amazon.awssdk.utils.builder.ToCopyableBuilder

copy

Method Detail

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(unit value)

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

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

ScheduleState

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:

ScheduleState

target

public final Target target()

The schedule's target.

Returns:

The schedule's target.

toBuilder

public CreateScheduleRequest.Builder toBuilder()

Specified by:

toBuilder in interface ToCopyableBuilder<CreateScheduleRequest.Builder,CreateScheduleRequest>

Specified by:

toBuilder in class SchedulerRequest

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)

Specified by:

equalsBySdkFields in interface SdkPojo

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)

Overrides:

getValueForField in class SdkRequest

sdkFields

public final List<SdkField<?>> sdkFields()

Specified by:

sdkFields in interface SdkPojo