Rollout

import type { Rollout } from "https://googleapis.deno.dev/v1/saasservicemgmt:v1beta1.ts";

Represents a single rollout execution and its results

interface Rollout {

annotations?: {

[key: string]: string;

};

control?: RolloutControl;

readonly createTime?: Date;

readonly endTime?: Date;

readonly etag?: string;

labels?: {

[key: string]: string;

};

name?: string;

readonly parentRollout?: string;

release?: string;

rolloutKind?: string;

rolloutOrchestrationStrategy?: string;

readonly rootRollout?: string;

readonly startTime?: Date;

readonly state?:

| "ROLLOUT_STATE_UNSPECIFIED"

| "ROLLOUT_STATE_RUNNING"

| "ROLLOUT_STATE_PAUSED"

| "ROLLOUT_STATE_SUCCEEDED"

| "ROLLOUT_STATE_FAILED"

| "ROLLOUT_STATE_CANCELLED"

| "ROLLOUT_STATE_WAITING"

| "ROLLOUT_STATE_CANCELLING"

| "ROLLOUT_STATE_RESUMING"

| "ROLLOUT_STATE_PAUSING";

readonly stateMessage?: string;

readonly stateTransitionTime?: Date;

readonly stats?: RolloutStats;

readonly uid?: string;

unitFilter?: string;

readonly updateTime?: Date;

}

§Properties

annotations?: {

[key: string]: string;

}

[src]

Optional. Annotations is an unstructured key-value map stored with a resource that may be set by external tools to store and retrieve arbitrary metadata. They are not queryable and should be preserved when modifying objects. More info: https://kubernetes.io/docs/user-guide/annotations

control?: RolloutControl

[src]

Optional. Requested change to the execution of this rollout. Default RolloutControl.action is ROLLOUT_ACTION_RUN meaning the rollout will be executed to completion while progressing through all natural Rollout States (such as RUNNING -> SUCCEEDED or RUNNING -> FAILED). Requests can only be made when the Rollout is in a non-terminal state.

readonly createTime?: Date

[src]

Output only. The timestamp when the resource was created.

readonly endTime?: Date

[src]

Optional. Output only. The time when the rollout finished execution (regardless of success, failure, or cancellation). Will be empty if the rollout hasn't finished yet. Once set, the rollout is in terminal state and all the results are final.

readonly etag?: string

[src]

Output only. An opaque value that uniquely identifies a version or generation of a resource. It can be used to confirm that the client and server agree on the ordering of a resource being written.

labels?: {

[key: string]: string;

}

[src]

Optional. The labels on the resource, which can be used for categorization. similar to Kubernetes resource labels.

name?: string

[src]

Identifier. The resource name (full URI of the resource) following the standard naming scheme: "projects/{project}/locations/{location}/rollout/{rollout_id}"

readonly parentRollout?: string

[src]

Optional. Output only. The direct parent rollout that this rollout is stemming from. The resource name (full URI of the resource) following the standard naming scheme: "projects/{project}/locations/{location}/rollouts/{rollout_id}"

release?: string

[src]

Optional. Immutable. Name of the Release that gets rolled out to target Units. Required if no other type of release is specified.

rolloutKind?: string

[src]

Optional. Immutable. Name of the RolloutKind this rollout is stemming from and adhering to.

rolloutOrchestrationStrategy?: string

[src]

Optional. The strategy used for executing this Rollout. This strategy will override whatever strategy is specified in the RolloutType. If not specified on creation, the strategy from RolloutType will be used. There are two supported values strategies which are used to control - "Google.Cloud.Simple.AllAtOnce" - "Google.Cloud.Simple.OneLocationAtATime" A rollout with one of these simple strategies will rollout across all locations defined in the targeted UnitKind's Saas Locations.

readonly rootRollout?: string

[src]

Optional. Output only. The root rollout that this rollout is stemming from. The resource name (full URI of the resource) following the standard naming scheme: "projects/{project}/locations/{location}/rollouts/{rollout_id}"

readonly startTime?: Date

[src]

Optional. Output only. The time when the rollout started executing. Will be empty if the rollout hasn't started yet.

[src]

Output only. Current state of the rollout.

readonly stateMessage?: string

[src]

Output only. Human readable message indicating details about the last state transition.

readonly stateTransitionTime?: Date

[src]

Optional. Output only. The time when the rollout transitioned into its current state.

readonly stats?: RolloutStats

[src]

Optional. Output only. Details about the progress of the rollout.

readonly uid?: string

[src]

Output only. The unique identifier of the resource. UID is unique in the time and space for this resource within the scope of the service. It is typically generated by the server on successful creation of a resource and must not be changed. UID is used to uniquely identify resources with resource name reuses. This should be a UUID4.

unitFilter?: string

[src]

Optional. CEL(https://github.com/google/cel-spec) formatted filter string against Unit. The filter will be applied to determine the eligible unit population. This filter can only reduce, but not expand the scope of the rollout. If not provided, the unit_filter from the RolloutType will be used.

readonly updateTime?: Date

[src]

Output only. The timestamp when the resource was last updated. Any change to the resource made by users must refresh this value. Changes to a resource made by the service should refresh this value.