Attributes of a deployment in the v2 API response.

Hierarchy

  • FleetDeploymentV2Attributes

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
author?: string

Handle of the user who triggered the deployment.

configOperations?: FleetDeploymentOperation[]

Ordered list of configuration file operations applied by this deployment. Absent for package deployments, which have no configuration file operations.

durationSeconds?: number

Duration of the deployment in seconds, computed as finished_at - started_at. Zero if the deployment has not finished.

errorSummary?: string

Top-level error message for the deployment. Populated only when the deployment has failed.

estimatedFinishedAt?: number

Estimated completion time of the deployment as a Unix timestamp. Zero if not available.

finishedAt?: number

Time the deployment finished as a Unix timestamp. Zero if not yet finished.

isScheduled?: boolean

Whether this deployment was triggered by a schedule (schedule_id is non-empty).

query?: string

Query used to filter and select target hosts for the deployment.

scheduleId?: string

Identifier of the schedule that triggered this deployment. Empty if triggered manually.

startedAt?: number

Time the deployment started as a Unix timestamp. Zero if not yet started.

status?: string

Current high-level status of the deployment (for example, "pending", "running", "completed", "failed").

targetVersions?: string[]

Package versions targeted by this deployment.

totalHosts?: number

Total number of hosts targeted by this deployment.

updateType?: string

Type of update operation performed by this deployment (for example, "update_config_operations", "update_package").

Generated using TypeDoc