CronExpressionGenerator: CronExpressionGenerator class

CronExpressionGeneratorR Documentation

CronExpressionGenerator class

Description

Generates cron expression strings for the SageMaker Model Monitoring Schedule API.

Methods

Public methods


Method hourly()

Generates hourly cron expression that denotes that a job runs at the top of every hour.

Usage
CronExpressionGenerator$hourly()
Returns

str: The cron expression format accepted by the Amazon SageMaker Model Monitoring Schedule API.


Method daily()

Generates daily cron expression that denotes that a job runs at the top of every hour.

Usage
CronExpressionGenerator$daily(hour = 0L)
Arguments
hour

(int): The hour in HH24 format (UTC) to run the job at, on a daily schedule.

Returns

str: The cron expression format accepted by the Amazon SageMaker Model Monitoring Schedule API.


Method daily_every_x_hours()

Generates "daily every x hours" cron expression. That denotes that a job runs every day at the specified hour, and then every x hours, as specified in hour_interval.

Usage
CronExpressionGenerator$daily_every_x_hours(hour_interval, starting_hour = 0L)
Arguments
hour_interval

(int): The hour interval to run the job at.

starting_hour

(int): The hour at which to begin in HH24 format (UTC).

Returns

str: The cron expression format accepted by the Amazon SageMaker Model Monitoring Schedule API.


Method format()

format class

Usage
CronExpressionGenerator$format()

Method clone()

The objects of this class are cloneable with this method.

Usage
CronExpressionGenerator$clone(deep = FALSE)
Arguments
deep

Whether to make a deep clone.


DyfanJones/sagemaker-r-mlcore documentation built on May 3, 2022, 10:08 a.m.