RolloutKind

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

An object that describes various settings of Rollout execution. Includes built-in policies across GCP and GDC, and customizable policies.

interface RolloutKind {

annotations?: {

[key: string]: string;

};

readonly createTime?: Date;

errorBudget?: ErrorBudget;

readonly etag?: string;

labels?: {

[key: string]: string;

};

name?: string;

rolloutOrchestrationStrategy?: string;

readonly uid?: string;

unitFilter?: string;

unitKind?: string;

readonly updateTime?: Date;

updateUnitKindStrategy?: "UPDATE_UNIT_KIND_STRATEGY_UNSPECIFIED" | "UPDATE_UNIT_KIND_STRATEGY_ON_START" | "UPDATE_UNIT_KIND_STRATEGY_NEVER";

}

§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

readonly createTime?: Date

[src]

Output only. The timestamp when the resource was created.

errorBudget?: ErrorBudget

[src]

Optional. The configuration for error budget. If the number of failed units exceeds max(allowed_count, allowed_ratio * total_units), the rollout will be paused. If not set, all units will be attempted to be updated regardless of the number of failures encountered.

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}/rolloutKinds/{rollout_kind_id}"

rolloutOrchestrationStrategy?: string

[src]

Optional. The strategy used for executing a Rollout. This is a required field. 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 associated UnitKind's Saas Locations.

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.

unitKind?: string

[src]

Required. Immutable. UnitKind that this rollout kind corresponds to. Rollouts stemming from this rollout kind will target the units of this unit kind. In other words, this defines the population of target units to be upgraded by rollouts.

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.

updateUnitKindStrategy?: "UPDATE_UNIT_KIND_STRATEGY_UNSPECIFIED" | "UPDATE_UNIT_KIND_STRATEGY_ON_START" | "UPDATE_UNIT_KIND_STRATEGY_NEVER"

[src]

Optional. The config for updating the unit kind. By default, the unit kind will be updated on the rollout start.