com.amazonaws.services.scheduler.model

Class CreateScheduleRequest

java.lang.Object

com.amazonaws.AmazonWebServiceRequest

com.amazonaws.services.scheduler.model.CreateScheduleRequest

All Implemented Interfaces:

HandlerContextAware, ReadLimitInfo, Serializable, Cloneable

@Generated(value="com.amazonaws:aws-java-sdk-code-generator")
public class CreateScheduleRequest
extends AmazonWebServiceRequest
implements Serializable, Cloneable

See Also:

AWS API Documentation, Serialized Form

Field Summary

Fields inherited from class com.amazonaws.AmazonWebServiceRequest

NOOP

Constructor Summary

Constructors

Constructor and Description
CreateScheduleRequest()

Method Summary

Modifier and Type	Method and Description
CreateScheduleRequest	clone() Creates a shallow clone of this object for all fields except the handler context.
boolean	equals(Object obj)
String	getActionAfterCompletion() Specifies the action that EventBridge Scheduler applies to the schedule after the schedule completes invoking the target.
String	getClientToken() Unique, case-sensitive identifier you provide to ensure the idempotency of the request.
String	getDescription() The description you specify for the schedule.
Date	getEndDate() The date, in UTC, before which the schedule can invoke its target.
FlexibleTimeWindow	getFlexibleTimeWindow() Allows you to configure a time window during which EventBridge Scheduler invokes the schedule.
String	getGroupName() The name of the schedule group to associate with this schedule.
String	getKmsKeyArn() The Amazon Resource Name (ARN) for the customer managed KMS key that EventBridge Scheduler will use to encrypt and decrypt your data.
String	getName() The name of the schedule that you are creating.
String	getScheduleExpression() The expression that defines when the schedule runs.
String	getScheduleExpressionTimezone() The timezone in which the scheduling expression is evaluated.
Date	getStartDate() The date, in UTC, after which the schedule can begin invoking its target.
String	getState() Specifies whether the schedule is enabled or disabled.
Target	getTarget() The schedule's target.
int	hashCode()
void	setActionAfterCompletion(String actionAfterCompletion) Specifies the action that EventBridge Scheduler applies to the schedule after the schedule completes invoking the target.
void	setClientToken(String clientToken) Unique, case-sensitive identifier you provide to ensure the idempotency of the request.
void	setDescription(String description) The description you specify for the schedule.
void	setEndDate(Date endDate) The date, in UTC, before which the schedule can invoke its target.
void	setFlexibleTimeWindow(FlexibleTimeWindow flexibleTimeWindow) Allows you to configure a time window during which EventBridge Scheduler invokes the schedule.
void	setGroupName(String groupName) The name of the schedule group to associate with this schedule.
void	setKmsKeyArn(String kmsKeyArn) The Amazon Resource Name (ARN) for the customer managed KMS key that EventBridge Scheduler will use to encrypt and decrypt your data.
void	setName(String name) The name of the schedule that you are creating.
void	setScheduleExpression(String scheduleExpression) The expression that defines when the schedule runs.
void	setScheduleExpressionTimezone(String scheduleExpressionTimezone) The timezone in which the scheduling expression is evaluated.
void	setStartDate(Date startDate) The date, in UTC, after which the schedule can begin invoking its target.
void	setState(String state) Specifies whether the schedule is enabled or disabled.
void	setTarget(Target target) The schedule's target.
String	toString() Returns a string representation of this object.
CreateScheduleRequest	withActionAfterCompletion(ActionAfterCompletion actionAfterCompletion) Specifies the action that EventBridge Scheduler applies to the schedule after the schedule completes invoking the target.
CreateScheduleRequest	withActionAfterCompletion(String actionAfterCompletion) Specifies the action that EventBridge Scheduler applies to the schedule after the schedule completes invoking the target.
CreateScheduleRequest	withClientToken(String clientToken) Unique, case-sensitive identifier you provide to ensure the idempotency of the request.
CreateScheduleRequest	withDescription(String description) The description you specify for the schedule.
CreateScheduleRequest	withEndDate(Date endDate) The date, in UTC, before which the schedule can invoke its target.
CreateScheduleRequest	withFlexibleTimeWindow(FlexibleTimeWindow flexibleTimeWindow) Allows you to configure a time window during which EventBridge Scheduler invokes the schedule.
CreateScheduleRequest	withGroupName(String groupName) The name of the schedule group to associate with this schedule.
CreateScheduleRequest	withKmsKeyArn(String kmsKeyArn) The Amazon Resource Name (ARN) for the customer managed KMS key that EventBridge Scheduler will use to encrypt and decrypt your data.
CreateScheduleRequest	withName(String name) The name of the schedule that you are creating.
CreateScheduleRequest	withScheduleExpression(String scheduleExpression) The expression that defines when the schedule runs.
CreateScheduleRequest	withScheduleExpressionTimezone(String scheduleExpressionTimezone) The timezone in which the scheduling expression is evaluated.
CreateScheduleRequest	withStartDate(Date startDate) The date, in UTC, after which the schedule can begin invoking its target.
CreateScheduleRequest	withState(ScheduleState state) Specifies whether the schedule is enabled or disabled.
CreateScheduleRequest	withState(String state) Specifies whether the schedule is enabled or disabled.
CreateScheduleRequest	withTarget(Target target) The schedule's target.

Methods inherited from class com.amazonaws.AmazonWebServiceRequest

addHandlerContext, getCloneRoot, getCloneSource, getCustomQueryParameters, getCustomRequestHeaders, getGeneralProgressListener, getHandlerContext, getReadLimit, getRequestClientOptions, getRequestCredentials, getRequestCredentialsProvider, getRequestMetricCollector, getSdkClientExecutionTimeout, getSdkRequestTimeout, putCustomQueryParameter, putCustomRequestHeader, setGeneralProgressListener, setRequestCredentials, setRequestCredentialsProvider, setRequestMetricCollector, setSdkClientExecutionTimeout, setSdkRequestTimeout, withGeneralProgressListener, withRequestCredentialsProvider, withRequestMetricCollector, withSdkClientExecutionTimeout, withSdkRequestTimeout

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Constructor Detail

CreateScheduleRequest

public CreateScheduleRequest()

Method Detail

setActionAfterCompletion

public void setActionAfterCompletion(String actionAfterCompletion)

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

Parameters:

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

See Also:

ActionAfterCompletion

getActionAfterCompletion

public String getActionAfterCompletion()

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

Returns:

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

See Also:

ActionAfterCompletion

withActionAfterCompletion

public CreateScheduleRequest withActionAfterCompletion(String actionAfterCompletion)

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

Parameters:

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

Returns:

Returns a reference to this object so that method calls can be chained together.

See Also:

ActionAfterCompletion

withActionAfterCompletion

public CreateScheduleRequest withActionAfterCompletion(ActionAfterCompletion actionAfterCompletion)

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

Parameters:

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

Returns:

Returns a reference to this object so that method calls can be chained together.

See Also:

ActionAfterCompletion

setClientToken

public void setClientToken(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.

Parameters:

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.

getClientToken

public String getClientToken()

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.

withClientToken

public CreateScheduleRequest withClientToken(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.

Parameters:

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:

Returns a reference to this object so that method calls can be chained together.

setDescription

public void setDescription(String description)

The description you specify for the schedule.

Parameters:

description - The description you specify for the schedule.

getDescription

public String getDescription()

The description you specify for the schedule.

Returns:

The description you specify for the schedule.

withDescription

public CreateScheduleRequest withDescription(String description)

The description you specify for the schedule.

Parameters:

description - The description you specify for the schedule.

Returns:

Returns a reference to this object so that method calls can be chained together.

setEndDate

public void setEndDate(Date 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.

Parameters:

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.

getEndDate

public Date getEndDate()

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.

withEndDate

public CreateScheduleRequest withEndDate(Date 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.

Parameters:

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:

Returns a reference to this object so that method calls can be chained together.

setFlexibleTimeWindow

public void setFlexibleTimeWindow(FlexibleTimeWindow flexibleTimeWindow)

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

Parameters:

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

getFlexibleTimeWindow

public FlexibleTimeWindow getFlexibleTimeWindow()

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.

withFlexibleTimeWindow

public CreateScheduleRequest withFlexibleTimeWindow(FlexibleTimeWindow flexibleTimeWindow)

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

Parameters:

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

Returns:

Returns a reference to this object so that method calls can be chained together.

setGroupName

public void setGroupName(String groupName)

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

Parameters:

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

getGroupName

public String getGroupName()

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.

withGroupName

public CreateScheduleRequest withGroupName(String groupName)

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

Parameters:

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

Returns:

Returns a reference to this object so that method calls can be chained together.

setKmsKeyArn

public void setKmsKeyArn(String kmsKeyArn)

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

Parameters:

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

getKmsKeyArn

public String getKmsKeyArn()

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.

withKmsKeyArn

public CreateScheduleRequest withKmsKeyArn(String kmsKeyArn)

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

Parameters:

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

Returns:

Returns a reference to this object so that method calls can be chained together.

setName

public void setName(String name)

The name of the schedule that you are creating.

Parameters:

name - The name of the schedule that you are creating.

getName

public String getName()

The name of the schedule that you are creating.

Returns:

The name of the schedule that you are creating.

withName

public CreateScheduleRequest withName(String name)

The name of the schedule that you are creating.

Parameters:

name - The name of the schedule that you are creating.

Returns:

Returns a reference to this object so that method calls can be chained together.

setScheduleExpression

public void setScheduleExpression(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.

Parameters:

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.

getScheduleExpression

public String getScheduleExpression()

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.

withScheduleExpression

public CreateScheduleRequest withScheduleExpression(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.

Parameters:

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:

Returns a reference to this object so that method calls can be chained together.

setScheduleExpressionTimezone

public void setScheduleExpressionTimezone(String scheduleExpressionTimezone)

The timezone in which the scheduling expression is evaluated.

Parameters:

scheduleExpressionTimezone - The timezone in which the scheduling expression is evaluated.

getScheduleExpressionTimezone

public String getScheduleExpressionTimezone()

The timezone in which the scheduling expression is evaluated.

Returns:

The timezone in which the scheduling expression is evaluated.

withScheduleExpressionTimezone

public CreateScheduleRequest withScheduleExpressionTimezone(String scheduleExpressionTimezone)

The timezone in which the scheduling expression is evaluated.

Parameters:

scheduleExpressionTimezone - The timezone in which the scheduling expression is evaluated.

Returns:

Returns a reference to this object so that method calls can be chained together.

setStartDate

public void setStartDate(Date 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.

Parameters:

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.

getStartDate

public Date getStartDate()

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.

withStartDate

public CreateScheduleRequest withStartDate(Date 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.

Parameters:

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:

Returns a reference to this object so that method calls can be chained together.

setState

public void setState(String state)

Specifies whether the schedule is enabled or disabled.

Parameters:

state - Specifies whether the schedule is enabled or disabled.

See Also:

ScheduleState

getState

public String getState()

Specifies whether the schedule is enabled or disabled.

Returns:

Specifies whether the schedule is enabled or disabled.

See Also:

ScheduleState

withState

public CreateScheduleRequest withState(String state)

Specifies whether the schedule is enabled or disabled.

Parameters:

state - Specifies whether the schedule is enabled or disabled.

Returns:

Returns a reference to this object so that method calls can be chained together.

See Also:

ScheduleState

withState

public CreateScheduleRequest withState(ScheduleState state)

Specifies whether the schedule is enabled or disabled.

Parameters:

state - Specifies whether the schedule is enabled or disabled.

Returns:

Returns a reference to this object so that method calls can be chained together.

See Also:

ScheduleState

setTarget

public void setTarget(Target target)

The schedule's target.

Parameters:

target - The schedule's target.

getTarget

public Target getTarget()

The schedule's target.

Returns:

The schedule's target.

withTarget

public CreateScheduleRequest withTarget(Target target)

The schedule's target.

Parameters:

target - The schedule's target.

Returns:

Returns a reference to this object so that method calls can be chained together.

toString

public 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

Returns:

A string representation of this object.

See Also:

Object.toString()

equals

public boolean equals(Object obj)

Overrides:

equals in class Object

hashCode

public int hashCode()

Overrides:

hashCode in class Object

clone

public CreateScheduleRequest clone()

Description copied from class: AmazonWebServiceRequest

Creates a shallow clone of this object for all fields except the handler context. Explicitly does not clone the deep structure of the other fields in the message.

Overrides:

clone in class AmazonWebServiceRequest

See Also:

Object.clone()