Package software.amazon.awssdk.services.sagemaker.model

Class ScheduleConfig

java.lang.Object

software.amazon.awssdk.services.sagemaker.model.ScheduleConfig

All Implemented Interfaces:

Serializable, SdkPojo, ToCopyableBuilder<ScheduleConfig.Builder,ScheduleConfig>

@Generated("software.amazon.awssdk:codegen")
public final class ScheduleConfig
extends Object
implements SdkPojo, Serializable, ToCopyableBuilder<ScheduleConfig.Builder,ScheduleConfig>

Configuration details about the monitoring schedule.

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static interface	ScheduleConfig.Builder

Method Summary

Modifier and Type	Method	Description
static ScheduleConfig.Builder	builder()
String	dataAnalysisEndTime()	Sets the end time for a monitoring job window.
String	dataAnalysisStartTime()	Sets the start time for a monitoring job window.
boolean	equals(Object obj)
boolean	equalsBySdkFields(Object obj)
<T> Optional<T>	getValueForField(String fieldName, Class<T> clazz)
int	hashCode()
String	scheduleExpression()	A cron expression that describes details about the monitoring schedule.
List<SdkField<?>>	sdkFields()
static Class<? extends ScheduleConfig.Builder>	serializableBuilderClass()
ScheduleConfig.Builder	toBuilder()
String	toString()	Returns a string representation of this object.

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface software.amazon.awssdk.utils.builder.ToCopyableBuilder

copy

Method Detail

scheduleExpression

public final String 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.

Returns:

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.

dataAnalysisStartTime

public final String 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.

Returns:

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.

dataAnalysisEndTime

public final String 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.

Returns:

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.

toBuilder

public ScheduleConfig.Builder toBuilder()

Specified by:

toBuilder in interface ToCopyableBuilder<ScheduleConfig.Builder,ScheduleConfig>

builder

public static ScheduleConfig.Builder builder()

serializableBuilderClass

public static Class<? extends ScheduleConfig.Builder> serializableBuilderClass()

hashCode

public final int hashCode()

Overrides:

hashCode in class Object

equals

public final boolean equals(Object obj)

Overrides:

equals in class Object

equalsBySdkFields

public final boolean equalsBySdkFields(Object obj)

Specified by:

equalsBySdkFields in interface SdkPojo

toString

public final 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

getValueForField

public final <T> Optional<T> getValueForField(String fieldName,
                                              Class<T> clazz)

sdkFields

public final List<SdkField<?>> sdkFields()

Specified by:

sdkFields in interface SdkPojo