Google Cloud Deploy v1 API - Class DeployPolicy (3.1.0)

public sealed class DeployPolicy : IMessage<DeployPolicy>, IEquatable<DeployPolicy>, IDeepCloneable<DeployPolicy>, IBufferMessage, IMessage

Reference documentation and code samples for the Google Cloud Deploy v1 API class DeployPolicy.

A DeployPolicy resource in the Cloud Deploy API.

A DeployPolicy inhibits manual or automation-driven actions within a Delivery Pipeline or Target.

Inheritance

object > DeployPolicy

Namespace

Google.Cloud.Deploy.V1

Assembly

Google.Cloud.Deploy.V1.dll

Constructors

DeployPolicy()

public DeployPolicy()

DeployPolicy(DeployPolicy)

public DeployPolicy(DeployPolicy other)
Parameter
Name Description
other DeployPolicy

Properties

Annotations

public MapField<string, string> Annotations { get; }

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.

Property Value
Type Description
MapFieldstringstring

CreateTime

public Timestamp CreateTime { get; set; }

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

Property Value
Type Description
Timestamp

DeployPolicyName

public DeployPolicyName DeployPolicyName { get; set; }

DeployPolicyName-typed view over the Name resource name property.

Property Value
Type Description
DeployPolicyName

Description

public string Description { get; set; }

Description of the DeployPolicy. Max length is 255 characters.

Property Value
Type Description
string

Etag

public string Etag { get; set; }

The weak etag of the Automation 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.

Property Value
Type Description
string

Labels

public MapField<string, string> Labels { get; }

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.

Property Value
Type Description
MapFieldstringstring

Name

public string Name { get; set; }

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])?

Property Value
Type Description
string

Rules

public RepeatedField<PolicyRule> Rules { get; }

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

Property Value
Type Description
RepeatedFieldPolicyRule

Selectors

public RepeatedField<DeployPolicyResourceSelector> Selectors { get; }

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.

Property Value
Type Description
RepeatedFieldDeployPolicyResourceSelector

Suspended

public bool Suspended { get; set; }

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

Property Value
Type Description
bool

Uid

public string Uid { get; set; }

Output only. Unique identifier of the DeployPolicy.

Property Value
Type Description
string

UpdateTime

public Timestamp UpdateTime { get; set; }

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

Property Value
Type Description
Timestamp