Skip to main content

Represents a schedule of metric calculations. Will trigger new calculations at the specified intervals.

metricCalculationSpec
object
required

The specification to use for each metric calculation

scheduleStartTime
object
required

The time when the first metric calculation will start. This timestamp is the start time of the first metric calculation. The schedule will execute this calculation when there is enough data and the interval has passed.

scheduleIntervals
object[]
required

The intervals for which to trigger metric calculations. The first calculation will use the first interval the second will use the second iteration and so forth. Once the last interval is reached the schedule will stay at that interval

iteration
object
required

The iteration of the schedule. A new iteration is created every time the schedule is retriggered.

nextScheduledRunTime
object
required

The time when the metric calculation is scheduled to run the next time.If the calculation is cancelled, this field contains the latest time it was scheduled to run before cancellation.

nextExposureStartTime
object
required

The start time of exposure for the next scheduled run.

nextExposureEndTime
object
required

The end time of exposure for the next scheduled run.

executedCalculationsCount
object
required

The number of calculations that has been executed so far.

createTime
object
required

The time the scheduled metric calculation was first created.

updateTime
object
required

Time when the scheduled metric calculation was last updated.

status
object
required

Status of the schedule. This explains more in depth of where the schedule is now, if it's waiting for data or if it's currently executing

creator
string
required

Reference to the identity that created this scheduled metric calculation.

updater
string
required

Reference to the identity that last updated this scheduled metric calculation.

name
string

Unique identifier of the scheduled metric calculations. For example: scheduledMetricCalculations/0smva5nxuhv4yts6paxt

scheduleEndTime
object

The time when the metric calculation will end. Once the schedule reaches the end it will be cancelled and no new calculations will be triggered. If no end is specified the schedule will continue indefinitely.

state
enum<string>

The current state of the schedule

Available options:
STATE_UNSPECIFIED,
ACTIVE,
CANCELLED
latestCalculation
string

The name of the latest calculation that this schedule triggered

labels
object[]

Custom labels for this scheduled metric calculation.

owner
string

The owner of the resource. If not set will default to the creator.

activeRetrigger
string

Reference to a retrigger if one is active.