DeployPolicy

import type { DeployPolicy } from "https://googleapis.deno.dev/v1/clouddeploy:v1.ts";

A DeployPolicy resource in the Cloud Deploy API. A DeployPolicy inhibits manual or automation-driven actions within a Delivery Pipeline or Target.

interface DeployPolicy {

annotations?: {

[key: string]: string;

};

readonly createTime?: Date;

description?: string;

etag?: string;

labels?: {

[key: string]: string;

};

readonly name?: string;

rules?: PolicyRule[];

selectors?: DeployPolicyResourceSelector[];

suspended?: boolean;

readonly uid?: string;

readonly updateTime?: Date;

}

§Properties

annotations?: {

[key: string]: string;

}

[src]

Optional. User annotations. These attributes can only be set and used by the user, and not by Cloud Deploy. Annotations must meet the following constraints: * Annotations are key/value pairs. * Valid annotation keys have two segments: an optional prefix and name, separated by a slash (/).

The name segment is required and must be 63 characters or less, beginning and ending with an alphanumeric character ([a-z0-9A-Z]) with dashes (-), underscores (_), dots (.), and alphanumerics between. * The prefix is optional. If specified, the prefix must be a DNS subdomain: a series of DNS labels separated by dots(.), not longer than 253 characters in total, followed by a slash (/). See https://kubernetes.io/docs/concepts/overview/working-with-objects/annotations/#syntax-and-character-set for more details.

readonly createTime?: Date

[src]

Output only. Time at which the deploy policy was created.

description?: string

[src]

Optional. Description of the DeployPolicy. Max length is 255 characters.

etag?: string

[src]

The weak etag of the DeployPolicy resource. This checksum is computed by the server based on the value of other fields, and may be sent on update and delete requests to ensure the client has an up-to-date value before proceeding.

labels?: {

[key: string]: string;

}

[src]

Labels are attributes that can be set and used by both the user and by Cloud Deploy. Labels must meet the following constraints: * Keys and values can contain only lowercase letters, numeric characters, underscores, and dashes. * All characters must use UTF-8 encoding, and international characters are allowed. * Keys must start with a lowercase letter or international character. * Each resource is limited to a maximum of 64 labels. Both keys and values are additionally constrained to be <= 128 bytes.

readonly name?: string

[src]

Output only. Name of the DeployPolicy. Format is projects/{project}/locations/{location}/deployPolicies/{deployPolicy}. The deployPolicy component must match [a-z]([a-z0-9-]{0,61}[a-z0-9])?

rules?: PolicyRule[]

[src]

Required. Rules to apply. At least one rule must be present.

selectors?: DeployPolicyResourceSelector[]

[src]

Required. Selected resources to which the policy will be applied. At least one selector is required. If one selector matches the resource the policy applies. For example, if there are two selectors and the action being attempted matches one of them, the policy will apply to that action.

suspended?: boolean

[src]

Optional. When suspended, the policy will not prevent actions from occurring, even if the action violates the policy.

readonly uid?: string

[src]

Output only. Unique identifier of the DeployPolicy.

readonly updateTime?: Date

[src]

Output only. Most recent time at which the deploy policy was updated.