* 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. *
*/ private String clientToken; /** ** The description you specify for the schedule. *
*/ private String description; /** *
* 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.
*
* Allows you to configure a time window during which EventBridge Scheduler invokes the schedule. *
*/ private FlexibleTimeWindow flexibleTimeWindow; /** ** The name of the schedule group to associate with this schedule. If you omit this, the default schedule group is * used. *
*/ private String groupName; /** ** The Amazon Resource Name (ARN) for the customer managed KMS key that EventBridge Scheduler will use to encrypt * and decrypt your data. *
*/ private String kmsKeyArn; /** ** The name of the schedule that you are creating. *
*/ private String name; /** ** 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. *
*/ private String scheduleExpression; /** ** The timezone in which the scheduling expression is evaluated. *
*/ private String scheduleExpressionTimezone; /** *
* 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.
*
* Specifies whether the schedule is enabled or disabled. *
*/ private String state; /** ** The schedule's target. *
*/ private Target target; /** ** 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. *
* * @param 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. */ public void setClientToken(String clientToken) { this.clientToken = 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. *
* * @return 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. */ public String getClientToken() { return this.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. *
* * @param 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. * @return Returns a reference to this object so that method calls can be chained together. */ public CreateScheduleRequest withClientToken(String clientToken) { setClientToken(clientToken); return this; } /** ** The description you specify for the schedule. *
* * @param description * The description you specify for the schedule. */ public void setDescription(String description) { this.description = description; } /** ** The description you specify for the schedule. *
* * @return The description you specify for the schedule. */ public String getDescription() { return this.description; } /** ** The description you specify for the schedule. *
* * @param description * The description you specify for the schedule. * @return Returns a reference to this object so that method calls can be chained together. */ public CreateScheduleRequest withDescription(String description) { setDescription(description); return this; } /** *
* 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 void setEndDate(java.util.Date endDate) {
this.endDate = 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 you specify. EventBridge
* Scheduler ignores EndDate for one-time schedules.
*/
public java.util.Date getEndDate() {
return this.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 you specify. EventBridge
* Scheduler ignores EndDate for one-time schedules.
* @return Returns a reference to this object so that method calls can be chained together.
*/
public CreateScheduleRequest withEndDate(java.util.Date endDate) {
setEndDate(endDate);
return this;
}
/**
* * Allows you to configure a time window during which EventBridge Scheduler invokes the schedule. *
* * @param flexibleTimeWindow * Allows you to configure a time window during which EventBridge Scheduler invokes the schedule. */ public void setFlexibleTimeWindow(FlexibleTimeWindow flexibleTimeWindow) { this.flexibleTimeWindow = flexibleTimeWindow; } /** ** Allows you to configure a time window during which EventBridge Scheduler invokes the schedule. *
* * @return Allows you to configure a time window during which EventBridge Scheduler invokes the schedule. */ public FlexibleTimeWindow getFlexibleTimeWindow() { return this.flexibleTimeWindow; } /** ** Allows you to configure a time window during which EventBridge Scheduler invokes the schedule. *
* * @param flexibleTimeWindow * Allows you to configure a time window during which EventBridge Scheduler invokes the schedule. * @return Returns a reference to this object so that method calls can be chained together. */ public CreateScheduleRequest withFlexibleTimeWindow(FlexibleTimeWindow flexibleTimeWindow) { setFlexibleTimeWindow(flexibleTimeWindow); return this; } /** ** The name of the schedule group to associate with this schedule. If you omit this, the default schedule group is * used. *
* * @param groupName * The name of the schedule group to associate with this schedule. If you omit this, the default schedule * group is used. */ public void setGroupName(String groupName) { this.groupName = groupName; } /** ** The name of the schedule group to associate with this schedule. If you omit this, the default schedule group is * used. *
* * @return The name of the schedule group to associate with this schedule. If you omit this, the default schedule * group is used. */ public String getGroupName() { return this.groupName; } /** ** The name of the schedule group to associate with this schedule. If you omit this, the default schedule group is * used. *
* * @param groupName * The name of the schedule group to associate with this schedule. If you omit this, the default schedule * group is used. * @return Returns a reference to this object so that method calls can be chained together. */ public CreateScheduleRequest withGroupName(String groupName) { setGroupName(groupName); return this; } /** ** The Amazon Resource Name (ARN) for the customer managed KMS key that EventBridge Scheduler will use to encrypt * and decrypt your data. *
* * @param kmsKeyArn * The Amazon Resource Name (ARN) for the customer managed KMS key that EventBridge Scheduler will use to * encrypt and decrypt your data. */ public void setKmsKeyArn(String kmsKeyArn) { this.kmsKeyArn = kmsKeyArn; } /** ** The Amazon Resource Name (ARN) for the customer managed KMS key that EventBridge Scheduler will use to encrypt * and decrypt your data. *
* * @return The Amazon Resource Name (ARN) for the customer managed KMS key that EventBridge Scheduler will use to * encrypt and decrypt your data. */ public String getKmsKeyArn() { return this.kmsKeyArn; } /** ** The Amazon Resource Name (ARN) for the customer managed KMS key that EventBridge Scheduler will use to encrypt * and decrypt your data. *
* * @param kmsKeyArn * The Amazon Resource Name (ARN) for the customer managed KMS key that EventBridge Scheduler will use to * encrypt and decrypt your data. * @return Returns a reference to this object so that method calls can be chained together. */ public CreateScheduleRequest withKmsKeyArn(String kmsKeyArn) { setKmsKeyArn(kmsKeyArn); return this; } /** ** The name of the schedule that you are creating. *
* * @param name * The name of the schedule that you are creating. */ public void setName(String name) { this.name = name; } /** ** The name of the schedule that you are creating. *
* * @return The name of the schedule that you are creating. */ public String getName() { return this.name; } /** ** The name of the schedule that you are creating. *
* * @param name * The name of the schedule that you are creating. * @return Returns a reference to this object so that method calls can be chained together. */ public CreateScheduleRequest withName(String name) { setName(name); return this; } /** ** 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. *
* * @param 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. */ public void setScheduleExpression(String scheduleExpression) { this.scheduleExpression = 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. *
* * @return 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. */ public String getScheduleExpression() { return this.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. *
* * @param 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. * @return Returns a reference to this object so that method calls can be chained together. */ public CreateScheduleRequest withScheduleExpression(String scheduleExpression) { setScheduleExpression(scheduleExpression); return this; } /** *
* The timezone in which the scheduling expression is evaluated. *
* * @param scheduleExpressionTimezone * The timezone in which the scheduling expression is evaluated. */ public void setScheduleExpressionTimezone(String scheduleExpressionTimezone) { this.scheduleExpressionTimezone = scheduleExpressionTimezone; } /** ** The timezone in which the scheduling expression is evaluated. *
* * @return The timezone in which the scheduling expression is evaluated. */ public String getScheduleExpressionTimezone() { return this.scheduleExpressionTimezone; } /** ** The timezone in which the scheduling expression is evaluated. *
* * @param scheduleExpressionTimezone * The timezone in which the scheduling expression is evaluated. * @return Returns a reference to this object so that method calls can be chained together. */ public CreateScheduleRequest withScheduleExpressionTimezone(String scheduleExpressionTimezone) { setScheduleExpressionTimezone(scheduleExpressionTimezone); return this; } /** *
* 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 void setStartDate(java.util.Date startDate) {
this.startDate = 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 you specify.
* EventBridge Scheduler ignores StartDate for one-time schedules.
*/
public java.util.Date getStartDate() {
return this.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 you specify.
* EventBridge Scheduler ignores StartDate for one-time schedules.
* @return Returns a reference to this object so that method calls can be chained together.
*/
public CreateScheduleRequest withStartDate(java.util.Date startDate) {
setStartDate(startDate);
return this;
}
/**
* * Specifies whether the schedule is enabled or disabled. *
* * @param state * Specifies whether the schedule is enabled or disabled. * @see ScheduleState */ public void setState(String state) { this.state = state; } /** ** Specifies whether the schedule is enabled or disabled. *
* * @return Specifies whether the schedule is enabled or disabled. * @see ScheduleState */ public String getState() { return this.state; } /** ** Specifies whether the schedule is enabled or disabled. *
* * @param state * Specifies whether the schedule is enabled or disabled. * @return Returns a reference to this object so that method calls can be chained together. * @see ScheduleState */ public CreateScheduleRequest withState(String state) { setState(state); return this; } /** ** Specifies whether the schedule is enabled or disabled. *
* * @param state * Specifies whether the schedule is enabled or disabled. * @return Returns a reference to this object so that method calls can be chained together. * @see ScheduleState */ public CreateScheduleRequest withState(ScheduleState state) { this.state = state.toString(); return this; } /** ** The schedule's target. *
* * @param target * The schedule's target. */ public void setTarget(Target target) { this.target = target; } /** ** The schedule's target. *
* * @return The schedule's target. */ public Target getTarget() { return this.target; } /** ** The schedule's target. *
* * @param target * The schedule's target. * @return Returns a reference to this object so that method calls can be chained together. */ public CreateScheduleRequest withTarget(Target target) { setTarget(target); return this; } /** * 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. * * @return A string representation of this object. * * @see java.lang.Object#toString() */ @Override public String toString() { StringBuilder sb = new StringBuilder(); sb.append("{"); if (getClientToken() != null) sb.append("ClientToken: ").append(getClientToken()).append(","); if (getDescription() != null) sb.append("Description: ").append(getDescription()).append(","); if (getEndDate() != null) sb.append("EndDate: ").append(getEndDate()).append(","); if (getFlexibleTimeWindow() != null) sb.append("FlexibleTimeWindow: ").append(getFlexibleTimeWindow()).append(","); if (getGroupName() != null) sb.append("GroupName: ").append(getGroupName()).append(","); if (getKmsKeyArn() != null) sb.append("KmsKeyArn: ").append(getKmsKeyArn()).append(","); if (getName() != null) sb.append("Name: ").append(getName()).append(","); if (getScheduleExpression() != null) sb.append("ScheduleExpression: ").append(getScheduleExpression()).append(","); if (getScheduleExpressionTimezone() != null) sb.append("ScheduleExpressionTimezone: ").append(getScheduleExpressionTimezone()).append(","); if (getStartDate() != null) sb.append("StartDate: ").append(getStartDate()).append(","); if (getState() != null) sb.append("State: ").append(getState()).append(","); if (getTarget() != null) sb.append("Target: ").append(getTarget()); sb.append("}"); return sb.toString(); } @Override public boolean equals(Object obj) { if (this == obj) return true; if (obj == null) return false; if (obj instanceof CreateScheduleRequest == false) return false; CreateScheduleRequest other = (CreateScheduleRequest) obj; if (other.getClientToken() == null ^ this.getClientToken() == null) return false; if (other.getClientToken() != null && other.getClientToken().equals(this.getClientToken()) == false) return false; if (other.getDescription() == null ^ this.getDescription() == null) return false; if (other.getDescription() != null && other.getDescription().equals(this.getDescription()) == false) return false; if (other.getEndDate() == null ^ this.getEndDate() == null) return false; if (other.getEndDate() != null && other.getEndDate().equals(this.getEndDate()) == false) return false; if (other.getFlexibleTimeWindow() == null ^ this.getFlexibleTimeWindow() == null) return false; if (other.getFlexibleTimeWindow() != null && other.getFlexibleTimeWindow().equals(this.getFlexibleTimeWindow()) == false) return false; if (other.getGroupName() == null ^ this.getGroupName() == null) return false; if (other.getGroupName() != null && other.getGroupName().equals(this.getGroupName()) == false) return false; if (other.getKmsKeyArn() == null ^ this.getKmsKeyArn() == null) return false; if (other.getKmsKeyArn() != null && other.getKmsKeyArn().equals(this.getKmsKeyArn()) == false) return false; if (other.getName() == null ^ this.getName() == null) return false; if (other.getName() != null && other.getName().equals(this.getName()) == false) return false; if (other.getScheduleExpression() == null ^ this.getScheduleExpression() == null) return false; if (other.getScheduleExpression() != null && other.getScheduleExpression().equals(this.getScheduleExpression()) == false) return false; if (other.getScheduleExpressionTimezone() == null ^ this.getScheduleExpressionTimezone() == null) return false; if (other.getScheduleExpressionTimezone() != null && other.getScheduleExpressionTimezone().equals(this.getScheduleExpressionTimezone()) == false) return false; if (other.getStartDate() == null ^ this.getStartDate() == null) return false; if (other.getStartDate() != null && other.getStartDate().equals(this.getStartDate()) == false) return false; if (other.getState() == null ^ this.getState() == null) return false; if (other.getState() != null && other.getState().equals(this.getState()) == false) return false; if (other.getTarget() == null ^ this.getTarget() == null) return false; if (other.getTarget() != null && other.getTarget().equals(this.getTarget()) == false) return false; return true; } @Override public int hashCode() { final int prime = 31; int hashCode = 1; hashCode = prime * hashCode + ((getClientToken() == null) ? 0 : getClientToken().hashCode()); hashCode = prime * hashCode + ((getDescription() == null) ? 0 : getDescription().hashCode()); hashCode = prime * hashCode + ((getEndDate() == null) ? 0 : getEndDate().hashCode()); hashCode = prime * hashCode + ((getFlexibleTimeWindow() == null) ? 0 : getFlexibleTimeWindow().hashCode()); hashCode = prime * hashCode + ((getGroupName() == null) ? 0 : getGroupName().hashCode()); hashCode = prime * hashCode + ((getKmsKeyArn() == null) ? 0 : getKmsKeyArn().hashCode()); hashCode = prime * hashCode + ((getName() == null) ? 0 : getName().hashCode()); hashCode = prime * hashCode + ((getScheduleExpression() == null) ? 0 : getScheduleExpression().hashCode()); hashCode = prime * hashCode + ((getScheduleExpressionTimezone() == null) ? 0 : getScheduleExpressionTimezone().hashCode()); hashCode = prime * hashCode + ((getStartDate() == null) ? 0 : getStartDate().hashCode()); hashCode = prime * hashCode + ((getState() == null) ? 0 : getState().hashCode()); hashCode = prime * hashCode + ((getTarget() == null) ? 0 : getTarget().hashCode()); return hashCode; } @Override public CreateScheduleRequest clone() { return (CreateScheduleRequest) super.clone(); } }