Reference documentation and code samples for the Google Cloud Deploy V1 API class Google::Cloud::Deploy::V1::DeployPolicy.
A DeployPolicy
resource in the Cloud Deploy API.
A DeployPolicy
inhibits manual or automation driven actions within a
Delivery Pipeline or Target.
Inherits
- Object
Extended By
- Google::Protobuf::MessageExts::ClassMethods
Includes
- Google::Protobuf::MessageExts
Methods
#annotations
def annotations() -> ::Google::Protobuf::Map{::String => ::String}
-
(::Google::Protobuf::Map{::String => ::String}) — 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.
#annotations=
def annotations=(value) -> ::Google::Protobuf::Map{::String => ::String}
-
value (::Google::Protobuf::Map{::String => ::String}) — 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.
-
(::Google::Protobuf::Map{::String => ::String}) — 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.
#create_time
def create_time() -> ::Google::Protobuf::Timestamp
- (::Google::Protobuf::Timestamp) — Output only. Time at which the deploy policy was created.
#description
def description() -> ::String
-
(::String) — Description of the
DeployPolicy
. Max length is 255 characters.
#description=
def description=(value) -> ::String
-
value (::String) — Description of the
DeployPolicy
. Max length is 255 characters.
-
(::String) — Description of the
DeployPolicy
. Max length is 255 characters.
#etag
def etag() -> ::String
-
(::String) — 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.
#etag=
def etag=(value) -> ::String
-
value (::String) — 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.
-
(::String) — 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.
#labels
def labels() -> ::Google::Protobuf::Map{::String => ::String}
-
(::Google::Protobuf::Map{::String => ::String}) — 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.
#labels=
def labels=(value) -> ::Google::Protobuf::Map{::String => ::String}
-
value (::Google::Protobuf::Map{::String => ::String}) — 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.
-
(::Google::Protobuf::Map{::String => ::String}) — 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.
#name
def name() -> ::String
-
(::String) — Output only. Name of the
DeployPolicy
. Format isprojects/{project}/locations/{location}/deployPolicies/{deployPolicy}
. ThedeployPolicy
component must match[a-z]([a-z0-9-]{0,61}[a-z0-9])?
#rules
def rules() -> ::Array<::Google::Cloud::Deploy::V1::PolicyRule>
- (::Array<::Google::Cloud::Deploy::V1::PolicyRule>) — Required. Rules to apply. At least one rule must be present.
#rules=
def rules=(value) -> ::Array<::Google::Cloud::Deploy::V1::PolicyRule>
- value (::Array<::Google::Cloud::Deploy::V1::PolicyRule>) — Required. Rules to apply. At least one rule must be present.
- (::Array<::Google::Cloud::Deploy::V1::PolicyRule>) — Required. Rules to apply. At least one rule must be present.
#selectors
def selectors() -> ::Array<::Google::Cloud::Deploy::V1::DeployPolicyResourceSelector>
- (::Array<::Google::Cloud::Deploy::V1::DeployPolicyResourceSelector>) — 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.
#selectors=
def selectors=(value) -> ::Array<::Google::Cloud::Deploy::V1::DeployPolicyResourceSelector>
- value (::Array<::Google::Cloud::Deploy::V1::DeployPolicyResourceSelector>) — 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.
- (::Array<::Google::Cloud::Deploy::V1::DeployPolicyResourceSelector>) — 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
def suspended() -> ::Boolean
- (::Boolean) — When suspended, the policy will not prevent actions from occurring, even if the action violates the policy.
#suspended=
def suspended=(value) -> ::Boolean
- value (::Boolean) — When suspended, the policy will not prevent actions from occurring, even if the action violates the policy.
- (::Boolean) — When suspended, the policy will not prevent actions from occurring, even if the action violates the policy.
#uid
def uid() -> ::String
-
(::String) — Output only. Unique identifier of the
DeployPolicy
.
#update_time
def update_time() -> ::Google::Protobuf::Timestamp
- (::Google::Protobuf::Timestamp) — Output only. Most recent time at which the deploy policy was updated.