Attributes of a fleet schedule in the v2 API response.

Hierarchy

  • FleetScheduleV2Attributes

Constructors

Properties

additionalProperties?: {
    [key: string]: any;
}

A container for additional, undeclared properties. This is a holder for any undeclared properties as specified with the 'additionalProperties' keyword in the OAS document.

Type declaration

  • [key: string]: any
createdAt?: string

RFC3339 timestamp when the schedule was created.

createdBy?: string

User handle of the person who created the schedule.

isDefault?: boolean

Whether this is the default schedule for the organization.

name?: string

Human-readable name for the schedule.

nextRun?: string

RFC3339 timestamp of the next scheduled maintenance window start time. Absent when the next run time cannot be computed.

Notification configuration attached to a schedule.

Included when available. If the notification rule cannot be retrieved, this field is omitted and the schedule is still returned. If the notification rule is retrieved but its handles cannot be resolved, it is still included with an empty handles array.

query?: string

Query used to filter and select target hosts for scheduled deployments.

Defines the recurrence pattern for the schedule.

The status of the schedule.

  • active: The schedule is active and will create deployments according to its recurrence rule.
  • inactive: The schedule is inactive and will not create any deployments.
updatedAt?: string

RFC3339 timestamp when the schedule was last updated.

updatedBy?: string

User handle of the person who last updated the schedule.

versionToLatest?: number

Number of major versions behind the latest to target for upgrades.

  • 0: Always upgrade to the latest version.
  • 1: Upgrade to latest minus 1 major version.
  • 2: Upgrade to latest minus 2 major versions.

Generated using TypeDoc