@Generated(value="com.amazonaws:aws-java-sdk-code-generator") public class GetScheduleResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable, Cloneable
Constructor and Description |
---|
GetScheduleResult() |
Modifier and Type | Method and Description |
---|---|
GetScheduleResult |
clone() |
boolean |
equals(Object obj) |
String |
getActionAfterCompletion()
Indicates the action that EventBridge Scheduler applies to the schedule after the schedule completes invoking the
target.
|
String |
getArn()
The Amazon Resource Name (ARN) of the schedule.
|
Date |
getCreationDate()
The time at which the schedule was created.
|
String |
getDescription()
The description of 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 associated with this schedule.
|
String |
getKmsKeyArn()
The ARN for a customer managed KMS Key that is be used to encrypt and decrypt your data.
|
Date |
getLastModificationDate()
The time at which the schedule was last modified.
|
String |
getName()
The name of the schedule.
|
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 target.
|
int |
hashCode() |
void |
setActionAfterCompletion(String actionAfterCompletion)
Indicates the action that EventBridge Scheduler applies to the schedule after the schedule completes invoking the
target.
|
void |
setArn(String arn)
The Amazon Resource Name (ARN) of the schedule.
|
void |
setCreationDate(Date creationDate)
The time at which the schedule was created.
|
void |
setDescription(String description)
The description of 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 associated with this schedule.
|
void |
setKmsKeyArn(String kmsKeyArn)
The ARN for a customer managed KMS Key that is be used to encrypt and decrypt your data.
|
void |
setLastModificationDate(Date lastModificationDate)
The time at which the schedule was last modified.
|
void |
setName(String name)
The name of the schedule.
|
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 target.
|
String |
toString()
Returns a string representation of this object.
|
GetScheduleResult |
withActionAfterCompletion(ActionAfterCompletion actionAfterCompletion)
Indicates the action that EventBridge Scheduler applies to the schedule after the schedule completes invoking the
target.
|
GetScheduleResult |
withActionAfterCompletion(String actionAfterCompletion)
Indicates the action that EventBridge Scheduler applies to the schedule after the schedule completes invoking the
target.
|
GetScheduleResult |
withArn(String arn)
The Amazon Resource Name (ARN) of the schedule.
|
GetScheduleResult |
withCreationDate(Date creationDate)
The time at which the schedule was created.
|
GetScheduleResult |
withDescription(String description)
The description of the schedule.
|
GetScheduleResult |
withEndDate(Date endDate)
The date, in UTC, before which the schedule can invoke its target.
|
GetScheduleResult |
withFlexibleTimeWindow(FlexibleTimeWindow flexibleTimeWindow)
Allows you to configure a time window during which EventBridge Scheduler invokes the schedule.
|
GetScheduleResult |
withGroupName(String groupName)
The name of the schedule group associated with this schedule.
|
GetScheduleResult |
withKmsKeyArn(String kmsKeyArn)
The ARN for a customer managed KMS Key that is be used to encrypt and decrypt your data.
|
GetScheduleResult |
withLastModificationDate(Date lastModificationDate)
The time at which the schedule was last modified.
|
GetScheduleResult |
withName(String name)
The name of the schedule.
|
GetScheduleResult |
withScheduleExpression(String scheduleExpression)
The expression that defines when the schedule runs.
|
GetScheduleResult |
withScheduleExpressionTimezone(String scheduleExpressionTimezone)
The timezone in which the scheduling expression is evaluated.
|
GetScheduleResult |
withStartDate(Date startDate)
The date, in UTC, after which the schedule can begin invoking its target.
|
GetScheduleResult |
withState(ScheduleState state)
Specifies whether the schedule is enabled or disabled.
|
GetScheduleResult |
withState(String state)
Specifies whether the schedule is enabled or disabled.
|
GetScheduleResult |
withTarget(Target target)
The schedule target.
|
getSdkHttpMetadata, getSdkResponseMetadata, setSdkHttpMetadata, setSdkResponseMetadata
public void setActionAfterCompletion(String actionAfterCompletion)
Indicates the action that EventBridge Scheduler applies to the schedule after the schedule completes invoking the target.
actionAfterCompletion
- Indicates the action that EventBridge Scheduler applies to the schedule after the schedule completes
invoking the target.ActionAfterCompletion
public String getActionAfterCompletion()
Indicates the action that EventBridge Scheduler applies to the schedule after the schedule completes invoking the target.
ActionAfterCompletion
public GetScheduleResult withActionAfterCompletion(String actionAfterCompletion)
Indicates the action that EventBridge Scheduler applies to the schedule after the schedule completes invoking the target.
actionAfterCompletion
- Indicates the action that EventBridge Scheduler applies to the schedule after the schedule completes
invoking the target.ActionAfterCompletion
public GetScheduleResult withActionAfterCompletion(ActionAfterCompletion actionAfterCompletion)
Indicates the action that EventBridge Scheduler applies to the schedule after the schedule completes invoking the target.
actionAfterCompletion
- Indicates the action that EventBridge Scheduler applies to the schedule after the schedule completes
invoking the target.ActionAfterCompletion
public void setArn(String arn)
The Amazon Resource Name (ARN) of the schedule.
arn
- The Amazon Resource Name (ARN) of the schedule.public String getArn()
The Amazon Resource Name (ARN) of the schedule.
public GetScheduleResult withArn(String arn)
The Amazon Resource Name (ARN) of the schedule.
arn
- The Amazon Resource Name (ARN) of the schedule.public void setCreationDate(Date creationDate)
The time at which the schedule was created.
creationDate
- The time at which the schedule was created.public Date getCreationDate()
The time at which the schedule was created.
public GetScheduleResult withCreationDate(Date creationDate)
The time at which the schedule was created.
creationDate
- The time at which the schedule was created.public void setDescription(String description)
The description of the schedule.
description
- The description of the schedule.public String getDescription()
The description of the schedule.
public GetScheduleResult withDescription(String description)
The description of the schedule.
description
- The description of the schedule.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.
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.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.
EndDate
you specify. EventBridge
Scheduler ignores EndDate
for one-time schedules.public GetScheduleResult 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.
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.public void setFlexibleTimeWindow(FlexibleTimeWindow flexibleTimeWindow)
Allows you to configure a time window during which EventBridge Scheduler invokes the schedule.
flexibleTimeWindow
- Allows you to configure a time window during which EventBridge Scheduler invokes the schedule.public FlexibleTimeWindow getFlexibleTimeWindow()
Allows you to configure a time window during which EventBridge Scheduler invokes the schedule.
public GetScheduleResult withFlexibleTimeWindow(FlexibleTimeWindow flexibleTimeWindow)
Allows you to configure a time window during which EventBridge Scheduler invokes the schedule.
flexibleTimeWindow
- Allows you to configure a time window during which EventBridge Scheduler invokes the schedule.public void setGroupName(String groupName)
The name of the schedule group associated with this schedule.
groupName
- The name of the schedule group associated with this schedule.public String getGroupName()
The name of the schedule group associated with this schedule.
public GetScheduleResult withGroupName(String groupName)
The name of the schedule group associated with this schedule.
groupName
- The name of the schedule group associated with this schedule.public void setKmsKeyArn(String kmsKeyArn)
The ARN for a customer managed KMS Key that is be used to encrypt and decrypt your data.
kmsKeyArn
- The ARN for a customer managed KMS Key that is be used to encrypt and decrypt your data.public String getKmsKeyArn()
The ARN for a customer managed KMS Key that is be used to encrypt and decrypt your data.
public GetScheduleResult withKmsKeyArn(String kmsKeyArn)
The ARN for a customer managed KMS Key that is be used to encrypt and decrypt your data.
kmsKeyArn
- The ARN for a customer managed KMS Key that is be used to encrypt and decrypt your data.public void setLastModificationDate(Date lastModificationDate)
The time at which the schedule was last modified.
lastModificationDate
- The time at which the schedule was last modified.public Date getLastModificationDate()
The time at which the schedule was last modified.
public GetScheduleResult withLastModificationDate(Date lastModificationDate)
The time at which the schedule was last modified.
lastModificationDate
- The time at which the schedule was last modified.public void setName(String name)
The name of the schedule.
name
- The name of the schedule.public String getName()
The name of the schedule.
public GetScheduleResult withName(String name)
The name of the schedule.
name
- The name of the schedule.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.
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.
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.
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.
public GetScheduleResult 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.
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.
public void setScheduleExpressionTimezone(String scheduleExpressionTimezone)
The timezone in which the scheduling expression is evaluated.
scheduleExpressionTimezone
- The timezone in which the scheduling expression is evaluated.public String getScheduleExpressionTimezone()
The timezone in which the scheduling expression is evaluated.
public GetScheduleResult withScheduleExpressionTimezone(String scheduleExpressionTimezone)
The timezone in which the scheduling expression is evaluated.
scheduleExpressionTimezone
- The timezone in which the scheduling expression is evaluated.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.
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.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.
StartDate
you specify.
EventBridge Scheduler ignores StartDate
for one-time schedules.public GetScheduleResult 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.
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.public void setState(String state)
Specifies whether the schedule is enabled or disabled.
state
- Specifies whether the schedule is enabled or disabled.ScheduleState
public String getState()
Specifies whether the schedule is enabled or disabled.
ScheduleState
public GetScheduleResult withState(String state)
Specifies whether the schedule is enabled or disabled.
state
- Specifies whether the schedule is enabled or disabled.ScheduleState
public GetScheduleResult withState(ScheduleState state)
Specifies whether the schedule is enabled or disabled.
state
- Specifies whether the schedule is enabled or disabled.ScheduleState
public void setTarget(Target target)
The schedule target.
target
- The schedule target.public Target getTarget()
The schedule target.
public GetScheduleResult withTarget(Target target)
The schedule target.
target
- The schedule target.public String toString()
toString
in class Object
Object.toString()
public GetScheduleResult clone()