com.amazonaws.services.sagemaker.model.ScheduleConfig Maven / Gradle / Ivy
Show all versions of aws-java-sdk-sagemaker Show documentation
/*
* Copyright 2019-2024 Amazon.com, Inc. or its affiliates. All Rights Reserved.
*
* Licensed under the Apache License, Version 2.0 (the "License"). You may not use this file except in compliance with
* the License. A copy of the License is located at
*
* http://aws.amazon.com/apache2.0
*
* or in the "license" file accompanying this file. This file is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR
* CONDITIONS OF ANY KIND, either express or implied. See the License for the specific language governing permissions
* and limitations under the License.
*/
package com.amazonaws.services.sagemaker.model;
import java.io.Serializable;
import javax.annotation.Generated;
import com.amazonaws.protocol.StructuredPojo;
import com.amazonaws.protocol.ProtocolMarshaller;
/**
*
* Configuration details about the monitoring schedule.
*
*
* @see AWS API
* Documentation
*/
@Generated("com.amazonaws:aws-java-sdk-code-generator")
public class ScheduleConfig implements Serializable, Cloneable, StructuredPojo {
/**
*
* A cron expression that describes details about the monitoring schedule.
*
*
* The supported cron expressions are:
*
*
* -
*
* If you want to set the job to start every hour, use the following:
*
*
* Hourly: cron(0 * ? * * *)
*
*
* -
*
* If you want to start the job daily:
*
*
* cron(0 [00-23] ? * * *)
*
*
* -
*
* If you want to run the job one time, immediately, use the following keyword:
*
*
* NOW
*
*
*
*
* For example, the following are valid cron expressions:
*
*
* -
*
* Daily at noon UTC: cron(0 12 ? * * *)
*
*
* -
*
* Daily at midnight UTC: cron(0 0 ? * * *)
*
*
*
*
* To support running every 6, 12 hours, the following are also supported:
*
*
* cron(0 [00-23]/[01-24] ? * * *)
*
*
* For example, the following are valid cron expressions:
*
*
* -
*
* Every 12 hours, starting at 5pm UTC: cron(0 17/12 ? * * *)
*
*
* -
*
* Every two hours starting at midnight: cron(0 0/2 ? * * *)
*
*
*
*
*
* -
*
* Even though the cron expression is set to start at 5PM UTC, note that there could be a delay of 0-20 minutes from
* the actual requested time to run the execution.
*
*
* -
*
* We recommend that if you would like a daily schedule, you do not provide this parameter. Amazon SageMaker will
* pick a time for running every day.
*
*
*
*
*
* You can also specify the keyword NOW to run the monitoring job immediately, one time, without
* recurring.
*
*/
private String scheduleExpression;
/**
*
* Sets the start time for a monitoring job window. Express this time as an offset to the times that you schedule
* your monitoring jobs to run. You schedule monitoring jobs with the ScheduleExpression parameter.
* Specify this offset in ISO 8601 duration format. For example, if you want to monitor the five hours of data in
* your dataset that precede the start of each monitoring job, you would specify: "-PT5H".
*
*
* The start time that you specify must not precede the end time that you specify by more than 24 hours. You specify
* the end time with the DataAnalysisEndTime parameter.
*
*
* If you set ScheduleExpression to NOW, this parameter is required.
*
*/
private String dataAnalysisStartTime;
/**
*
* Sets the end time for a monitoring job window. Express this time as an offset to the times that you schedule your
* monitoring jobs to run. You schedule monitoring jobs with the ScheduleExpression parameter. Specify
* this offset in ISO 8601 duration format. For example, if you want to end the window one hour before the start of
* each monitoring job, you would specify: "-PT1H".
*
*
* The end time that you specify must not follow the start time that you specify by more than 24 hours. You specify
* the start time with the DataAnalysisStartTime parameter.
*
*
* If you set ScheduleExpression to NOW, this parameter is required.
*
*/
private String dataAnalysisEndTime;
/**
*
* A cron expression that describes details about the monitoring schedule.
*
*
* The supported cron expressions are:
*
*
* -
*
* If you want to set the job to start every hour, use the following:
*
*
* Hourly: cron(0 * ? * * *)
*
*
* -
*
* If you want to start the job daily:
*
*
* cron(0 [00-23] ? * * *)
*
*
* -
*
* If you want to run the job one time, immediately, use the following keyword:
*
*
* NOW
*
*
*
*
* For example, the following are valid cron expressions:
*
*
* -
*
* Daily at noon UTC: cron(0 12 ? * * *)
*
*
* -
*
* Daily at midnight UTC: cron(0 0 ? * * *)
*
*
*
*
* To support running every 6, 12 hours, the following are also supported:
*
*
* cron(0 [00-23]/[01-24] ? * * *)
*
*
* For example, the following are valid cron expressions:
*
*
* -
*
* Every 12 hours, starting at 5pm UTC: cron(0 17/12 ? * * *)
*
*
* -
*
* Every two hours starting at midnight: cron(0 0/2 ? * * *)
*
*
*
*
*
* -
*
* Even though the cron expression is set to start at 5PM UTC, note that there could be a delay of 0-20 minutes from
* the actual requested time to run the execution.
*
*
* -
*
* We recommend that if you would like a daily schedule, you do not provide this parameter. Amazon SageMaker will
* pick a time for running every day.
*
*
*
*
*
* You can also specify the keyword NOW to run the monitoring job immediately, one time, without
* recurring.
*
*
* @param scheduleExpression
* A cron expression that describes details about the monitoring schedule.
*
* The supported cron expressions are:
*
*
* -
*
* If you want to set the job to start every hour, use the following:
*
*
* Hourly: cron(0 * ? * * *)
*
*
* -
*
* If you want to start the job daily:
*
*
* cron(0 [00-23] ? * * *)
*
*
* -
*
* If you want to run the job one time, immediately, use the following keyword:
*
*
* NOW
*
*
*
*
* For example, the following are valid cron expressions:
*
*
* -
*
* Daily at noon UTC: cron(0 12 ? * * *)
*
*
* -
*
* Daily at midnight UTC: cron(0 0 ? * * *)
*
*
*
*
* To support running every 6, 12 hours, the following are also supported:
*
*
* cron(0 [00-23]/[01-24] ? * * *)
*
*
* For example, the following are valid cron expressions:
*
*
* -
*
* Every 12 hours, starting at 5pm UTC: cron(0 17/12 ? * * *)
*
*
* -
*
* Every two hours starting at midnight: cron(0 0/2 ? * * *)
*
*
*
*
*
* -
*
* Even though the cron expression is set to start at 5PM UTC, note that there could be a delay of 0-20
* minutes from the actual requested time to run the execution.
*
*
* -
*
* We recommend that if you would like a daily schedule, you do not provide this parameter. Amazon SageMaker
* will pick a time for running every day.
*
*
*
*
*
* You can also specify the keyword NOW to run the monitoring job immediately, one time, without
* recurring.
*/
public void setScheduleExpression(String scheduleExpression) {
this.scheduleExpression = scheduleExpression;
}
/**
*
* A cron expression that describes details about the monitoring schedule.
*
*
* The supported cron expressions are:
*
*
* -
*
* If you want to set the job to start every hour, use the following:
*
*
* Hourly: cron(0 * ? * * *)
*
*
* -
*
* If you want to start the job daily:
*
*
* cron(0 [00-23] ? * * *)
*
*
* -
*
* If you want to run the job one time, immediately, use the following keyword:
*
*
* NOW
*
*
*
*
* For example, the following are valid cron expressions:
*
*
* -
*
* Daily at noon UTC: cron(0 12 ? * * *)
*
*
* -
*
* Daily at midnight UTC: cron(0 0 ? * * *)
*
*
*
*
* To support running every 6, 12 hours, the following are also supported:
*
*
* cron(0 [00-23]/[01-24] ? * * *)
*
*
* For example, the following are valid cron expressions:
*
*
* -
*
* Every 12 hours, starting at 5pm UTC: cron(0 17/12 ? * * *)
*
*
* -
*
* Every two hours starting at midnight: cron(0 0/2 ? * * *)
*
*
*
*
*
* -
*
* Even though the cron expression is set to start at 5PM UTC, note that there could be a delay of 0-20 minutes from
* the actual requested time to run the execution.
*
*
* -
*
* We recommend that if you would like a daily schedule, you do not provide this parameter. Amazon SageMaker will
* pick a time for running every day.
*
*
*
*
*
* You can also specify the keyword NOW to run the monitoring job immediately, one time, without
* recurring.
*
*
* @return A cron expression that describes details about the monitoring schedule.
*
* The supported cron expressions are:
*
*
* -
*
* If you want to set the job to start every hour, use the following:
*
*
* Hourly: cron(0 * ? * * *)
*
*
* -
*
* If you want to start the job daily:
*
*
* cron(0 [00-23] ? * * *)
*
*
* -
*
* If you want to run the job one time, immediately, use the following keyword:
*
*
* NOW
*
*
*
*
* For example, the following are valid cron expressions:
*
*
* -
*
* Daily at noon UTC: cron(0 12 ? * * *)
*
*
* -
*
* Daily at midnight UTC: cron(0 0 ? * * *)
*
*
*
*
* To support running every 6, 12 hours, the following are also supported:
*
*
* cron(0 [00-23]/[01-24] ? * * *)
*
*
* For example, the following are valid cron expressions:
*
*
* -
*
* Every 12 hours, starting at 5pm UTC: cron(0 17/12 ? * * *)
*
*
* -
*
* Every two hours starting at midnight: cron(0 0/2 ? * * *)
*
*
*
*
*
* -
*
* Even though the cron expression is set to start at 5PM UTC, note that there could be a delay of 0-20
* minutes from the actual requested time to run the execution.
*
*
* -
*
* We recommend that if you would like a daily schedule, you do not provide this parameter. Amazon SageMaker
* will pick a time for running every day.
*
*
*
*
*
* You can also specify the keyword NOW to run the monitoring job immediately, one time,
* without recurring.
*/
public String getScheduleExpression() {
return this.scheduleExpression;
}
/**
*
* A cron expression that describes details about the monitoring schedule.
*
*
* The supported cron expressions are:
*
*
* -
*
* If you want to set the job to start every hour, use the following:
*
*
* Hourly: cron(0 * ? * * *)
*
*
* -
*
* If you want to start the job daily:
*
*
* cron(0 [00-23] ? * * *)
*
*
* -
*
* If you want to run the job one time, immediately, use the following keyword:
*
*
* NOW
*
*
*
*
* For example, the following are valid cron expressions:
*
*
* -
*
* Daily at noon UTC: cron(0 12 ? * * *)
*
*
* -
*
* Daily at midnight UTC: cron(0 0 ? * * *)
*
*
*
*
* To support running every 6, 12 hours, the following are also supported:
*
*
* cron(0 [00-23]/[01-24] ? * * *)
*
*
* For example, the following are valid cron expressions:
*
*
* -
*
* Every 12 hours, starting at 5pm UTC: cron(0 17/12 ? * * *)
*
*
* -
*
* Every two hours starting at midnight: cron(0 0/2 ? * * *)
*
*
*
*
*
* -
*
* Even though the cron expression is set to start at 5PM UTC, note that there could be a delay of 0-20 minutes from
* the actual requested time to run the execution.
*
*
* -
*
* We recommend that if you would like a daily schedule, you do not provide this parameter. Amazon SageMaker will
* pick a time for running every day.
*
*
*
*
*
* You can also specify the keyword NOW to run the monitoring job immediately, one time, without
* recurring.
*
*
* @param scheduleExpression
* A cron expression that describes details about the monitoring schedule.
*
* The supported cron expressions are:
*
*
* -
*
* If you want to set the job to start every hour, use the following:
*
*
* Hourly: cron(0 * ? * * *)
*
*
* -
*
* If you want to start the job daily:
*
*
* cron(0 [00-23] ? * * *)
*
*
* -
*
* If you want to run the job one time, immediately, use the following keyword:
*
*
* NOW
*
*
*
*
* For example, the following are valid cron expressions:
*
*
* -
*
* Daily at noon UTC: cron(0 12 ? * * *)
*
*
* -
*
* Daily at midnight UTC: cron(0 0 ? * * *)
*
*
*
*
* To support running every 6, 12 hours, the following are also supported:
*
*
* cron(0 [00-23]/[01-24] ? * * *)
*
*
* For example, the following are valid cron expressions:
*
*
* -
*
* Every 12 hours, starting at 5pm UTC: cron(0 17/12 ? * * *)
*
*
* -
*
* Every two hours starting at midnight: cron(0 0/2 ? * * *)
*
*
*
*
*
* -
*
* Even though the cron expression is set to start at 5PM UTC, note that there could be a delay of 0-20
* minutes from the actual requested time to run the execution.
*
*
* -
*
* We recommend that if you would like a daily schedule, you do not provide this parameter. Amazon SageMaker
* will pick a time for running every day.
*
*
*
*
*
* You can also specify the keyword NOW to run the monitoring job immediately, one time, without
* recurring.
* @return Returns a reference to this object so that method calls can be chained together.
*/
public ScheduleConfig withScheduleExpression(String scheduleExpression) {
setScheduleExpression(scheduleExpression);
return this;
}
/**
*
* Sets the start time for a monitoring job window. Express this time as an offset to the times that you schedule
* your monitoring jobs to run. You schedule monitoring jobs with the ScheduleExpression parameter.
* Specify this offset in ISO 8601 duration format. For example, if you want to monitor the five hours of data in
* your dataset that precede the start of each monitoring job, you would specify: "-PT5H".
*
*
* The start time that you specify must not precede the end time that you specify by more than 24 hours. You specify
* the end time with the DataAnalysisEndTime parameter.
*
*
* If you set ScheduleExpression to NOW, this parameter is required.
*
*
* @param dataAnalysisStartTime
* Sets the start time for a monitoring job window. Express this time as an offset to the times that you
* schedule your monitoring jobs to run. You schedule monitoring jobs with the
* ScheduleExpression parameter. Specify this offset in ISO 8601 duration format. For example,
* if you want to monitor the five hours of data in your dataset that precede the start of each monitoring
* job, you would specify: "-PT5H".
*
* The start time that you specify must not precede the end time that you specify by more than 24 hours. You
* specify the end time with the DataAnalysisEndTime parameter.
*
*
* If you set ScheduleExpression to NOW, this parameter is required.
*/
public void setDataAnalysisStartTime(String dataAnalysisStartTime) {
this.dataAnalysisStartTime = dataAnalysisStartTime;
}
/**
*
* Sets the start time for a monitoring job window. Express this time as an offset to the times that you schedule
* your monitoring jobs to run. You schedule monitoring jobs with the ScheduleExpression parameter.
* Specify this offset in ISO 8601 duration format. For example, if you want to monitor the five hours of data in
* your dataset that precede the start of each monitoring job, you would specify: "-PT5H".
*
*
* The start time that you specify must not precede the end time that you specify by more than 24 hours. You specify
* the end time with the DataAnalysisEndTime parameter.
*
*
* If you set ScheduleExpression to NOW, this parameter is required.
*
*
* @return Sets the start time for a monitoring job window. Express this time as an offset to the times that you
* schedule your monitoring jobs to run. You schedule monitoring jobs with the
* ScheduleExpression parameter. Specify this offset in ISO 8601 duration format. For example,
* if you want to monitor the five hours of data in your dataset that precede the start of each monitoring
* job, you would specify: "-PT5H".
*
* The start time that you specify must not precede the end time that you specify by more than 24 hours. You
* specify the end time with the DataAnalysisEndTime parameter.
*
*
* If you set ScheduleExpression to NOW, this parameter is required.
*/
public String getDataAnalysisStartTime() {
return this.dataAnalysisStartTime;
}
/**
*
* Sets the start time for a monitoring job window. Express this time as an offset to the times that you schedule
* your monitoring jobs to run. You schedule monitoring jobs with the ScheduleExpression parameter.
* Specify this offset in ISO 8601 duration format. For example, if you want to monitor the five hours of data in
* your dataset that precede the start of each monitoring job, you would specify: "-PT5H".
*
*
* The start time that you specify must not precede the end time that you specify by more than 24 hours. You specify
* the end time with the DataAnalysisEndTime parameter.
*
*
* If you set ScheduleExpression to NOW, this parameter is required.
*
*
* @param dataAnalysisStartTime
* Sets the start time for a monitoring job window. Express this time as an offset to the times that you
* schedule your monitoring jobs to run. You schedule monitoring jobs with the
* ScheduleExpression parameter. Specify this offset in ISO 8601 duration format. For example,
* if you want to monitor the five hours of data in your dataset that precede the start of each monitoring
* job, you would specify: "-PT5H".
*
* The start time that you specify must not precede the end time that you specify by more than 24 hours. You
* specify the end time with the DataAnalysisEndTime parameter.
*
*
* If you set ScheduleExpression to NOW, this parameter is required.
* @return Returns a reference to this object so that method calls can be chained together.
*/
public ScheduleConfig withDataAnalysisStartTime(String dataAnalysisStartTime) {
setDataAnalysisStartTime(dataAnalysisStartTime);
return this;
}
/**
*
* Sets the end time for a monitoring job window. Express this time as an offset to the times that you schedule your
* monitoring jobs to run. You schedule monitoring jobs with the ScheduleExpression parameter. Specify
* this offset in ISO 8601 duration format. For example, if you want to end the window one hour before the start of
* each monitoring job, you would specify: "-PT1H".
*
*
* The end time that you specify must not follow the start time that you specify by more than 24 hours. You specify
* the start time with the DataAnalysisStartTime parameter.
*
*
* If you set ScheduleExpression to NOW, this parameter is required.
*
*
* @param dataAnalysisEndTime
* Sets the end time for a monitoring job window. Express this time as an offset to the times that you
* schedule your monitoring jobs to run. You schedule monitoring jobs with the
* ScheduleExpression parameter. Specify this offset in ISO 8601 duration format. For example,
* if you want to end the window one hour before the start of each monitoring job, you would specify:
* "-PT1H".
*
* The end time that you specify must not follow the start time that you specify by more than 24 hours. You
* specify the start time with the DataAnalysisStartTime parameter.
*
*
* If you set ScheduleExpression to NOW, this parameter is required.
*/
public void setDataAnalysisEndTime(String dataAnalysisEndTime) {
this.dataAnalysisEndTime = dataAnalysisEndTime;
}
/**
*
* Sets the end time for a monitoring job window. Express this time as an offset to the times that you schedule your
* monitoring jobs to run. You schedule monitoring jobs with the ScheduleExpression parameter. Specify
* this offset in ISO 8601 duration format. For example, if you want to end the window one hour before the start of
* each monitoring job, you would specify: "-PT1H".
*
*
* The end time that you specify must not follow the start time that you specify by more than 24 hours. You specify
* the start time with the DataAnalysisStartTime parameter.
*
*
* If you set ScheduleExpression to NOW, this parameter is required.
*
*
* @return Sets the end time for a monitoring job window. Express this time as an offset to the times that you
* schedule your monitoring jobs to run. You schedule monitoring jobs with the
* ScheduleExpression parameter. Specify this offset in ISO 8601 duration format. For example,
* if you want to end the window one hour before the start of each monitoring job, you would specify:
* "-PT1H".
*
* The end time that you specify must not follow the start time that you specify by more than 24 hours. You
* specify the start time with the DataAnalysisStartTime parameter.
*
*
* If you set ScheduleExpression to NOW, this parameter is required.
*/
public String getDataAnalysisEndTime() {
return this.dataAnalysisEndTime;
}
/**
*
* Sets the end time for a monitoring job window. Express this time as an offset to the times that you schedule your
* monitoring jobs to run. You schedule monitoring jobs with the ScheduleExpression parameter. Specify
* this offset in ISO 8601 duration format. For example, if you want to end the window one hour before the start of
* each monitoring job, you would specify: "-PT1H".
*
*
* The end time that you specify must not follow the start time that you specify by more than 24 hours. You specify
* the start time with the DataAnalysisStartTime parameter.
*
*
* If you set ScheduleExpression to NOW, this parameter is required.
*
*
* @param dataAnalysisEndTime
* Sets the end time for a monitoring job window. Express this time as an offset to the times that you
* schedule your monitoring jobs to run. You schedule monitoring jobs with the
* ScheduleExpression parameter. Specify this offset in ISO 8601 duration format. For example,
* if you want to end the window one hour before the start of each monitoring job, you would specify:
* "-PT1H".
*
* The end time that you specify must not follow the start time that you specify by more than 24 hours. You
* specify the start time with the DataAnalysisStartTime parameter.
*
*
* If you set ScheduleExpression to NOW, this parameter is required.
* @return Returns a reference to this object so that method calls can be chained together.
*/
public ScheduleConfig withDataAnalysisEndTime(String dataAnalysisEndTime) {
setDataAnalysisEndTime(dataAnalysisEndTime);
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 (getScheduleExpression() != null)
sb.append("ScheduleExpression: ").append(getScheduleExpression()).append(",");
if (getDataAnalysisStartTime() != null)
sb.append("DataAnalysisStartTime: ").append(getDataAnalysisStartTime()).append(",");
if (getDataAnalysisEndTime() != null)
sb.append("DataAnalysisEndTime: ").append(getDataAnalysisEndTime());
sb.append("}");
return sb.toString();
}
@Override
public boolean equals(Object obj) {
if (this == obj)
return true;
if (obj == null)
return false;
if (obj instanceof ScheduleConfig == false)
return false;
ScheduleConfig other = (ScheduleConfig) obj;
if (other.getScheduleExpression() == null ^ this.getScheduleExpression() == null)
return false;
if (other.getScheduleExpression() != null && other.getScheduleExpression().equals(this.getScheduleExpression()) == false)
return false;
if (other.getDataAnalysisStartTime() == null ^ this.getDataAnalysisStartTime() == null)
return false;
if (other.getDataAnalysisStartTime() != null && other.getDataAnalysisStartTime().equals(this.getDataAnalysisStartTime()) == false)
return false;
if (other.getDataAnalysisEndTime() == null ^ this.getDataAnalysisEndTime() == null)
return false;
if (other.getDataAnalysisEndTime() != null && other.getDataAnalysisEndTime().equals(this.getDataAnalysisEndTime()) == false)
return false;
return true;
}
@Override
public int hashCode() {
final int prime = 31;
int hashCode = 1;
hashCode = prime * hashCode + ((getScheduleExpression() == null) ? 0 : getScheduleExpression().hashCode());
hashCode = prime * hashCode + ((getDataAnalysisStartTime() == null) ? 0 : getDataAnalysisStartTime().hashCode());
hashCode = prime * hashCode + ((getDataAnalysisEndTime() == null) ? 0 : getDataAnalysisEndTime().hashCode());
return hashCode;
}
@Override
public ScheduleConfig clone() {
try {
return (ScheduleConfig) super.clone();
} catch (CloneNotSupportedException e) {
throw new IllegalStateException("Got a CloneNotSupportedException from Object.clone() " + "even though we're Cloneable!", e);
}
}
@com.amazonaws.annotation.SdkInternalApi
@Override
public void marshall(ProtocolMarshaller protocolMarshaller) {
com.amazonaws.services.sagemaker.model.transform.ScheduleConfigMarshaller.getInstance().marshall(this, protocolMarshaller);
}
}