com.amazonaws.services.sagemaker.model

Class ScheduleConfig

java.lang.Object

com.amazonaws.services.sagemaker.model.ScheduleConfig

All Implemented Interfaces:

StructuredPojo, Serializable, Cloneable

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

Configuration details about the monitoring schedule.

See Also:

AWS API Documentation, Serialized Form

Constructor Summary

Constructors

Constructor and Description
ScheduleConfig()

Method Summary

Modifier and Type	Method and Description
ScheduleConfig	clone()
boolean	equals(Object obj)
String	getScheduleExpression() A cron expression that describes details about the monitoring schedule.
int	hashCode()
void	marshall(ProtocolMarshaller protocolMarshaller) Marshalls this structured data using the given ProtocolMarshaller.
void	setScheduleExpression(String scheduleExpression) A cron expression that describes details about the monitoring schedule.
String	toString() Returns a string representation of this object.
ScheduleConfig	withScheduleExpression(String scheduleExpression) A cron expression that describes details about the monitoring schedule.

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Constructor Detail

ScheduleConfig

public ScheduleConfig()

Method Detail

setScheduleExpression

public void setScheduleExpression(String scheduleExpression)

A cron expression that describes details about the monitoring schedule.

Currently the only supported cron expressions are:

• If you want to set the job to start every hour, please use the following:

  Hourly: cron(0 * ? * * *)

• If you want to start the job daily:

  cron(0 [00-23] ? * * *)

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.

Parameters:

scheduleExpression - A cron expression that describes details about the monitoring schedule.

Currently the only supported cron expressions are:

• If you want to set the job to start every hour, please use the following:

  Hourly: cron(0 * ? * * *)

• If you want to start the job daily:

  cron(0 [00-23] ? * * *)

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.

getScheduleExpression

public String getScheduleExpression()

A cron expression that describes details about the monitoring schedule.

Currently the only supported cron expressions are:

• If you want to set the job to start every hour, please use the following:

  Hourly: cron(0 * ? * * *)

• If you want to start the job daily:

  cron(0 [00-23] ? * * *)

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.

Returns:

A cron expression that describes details about the monitoring schedule.

Currently the only supported cron expressions are:

• If you want to set the job to start every hour, please use the following:

  Hourly: cron(0 * ? * * *)

• If you want to start the job daily:

  cron(0 [00-23] ? * * *)

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.

withScheduleExpression

public ScheduleConfig withScheduleExpression(String scheduleExpression)

A cron expression that describes details about the monitoring schedule.

Currently the only supported cron expressions are:

• If you want to set the job to start every hour, please use the following:

  Hourly: cron(0 * ? * * *)

• If you want to start the job daily:

  cron(0 [00-23] ? * * *)

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.

Parameters:

scheduleExpression - A cron expression that describes details about the monitoring schedule.

Currently the only supported cron expressions are:

• If you want to set the job to start every hour, please use the following:

  Hourly: cron(0 * ? * * *)

• If you want to start the job daily:

  cron(0 [00-23] ? * * *)

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.

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 ScheduleConfig clone()

Overrides:

clone in class Object

marshall

public void marshall(ProtocolMarshaller protocolMarshaller)

Description copied from interface: StructuredPojo

Marshalls this structured data using the given ProtocolMarshaller.

Specified by:

marshall in interface StructuredPojo

Parameters:

protocolMarshaller - Implementation of ProtocolMarshaller used to marshall this object's data.