Reference documentation and code samples for the Google Cloud Deploy V1 API class Google::Cloud::Deploy::V1::Automation.
An Automation
resource in the Cloud Deploy API.
An Automation
enables the automation of manually driven actions for
a Delivery Pipeline, which includes Release promotion among Targets,
Rollout repair and Rollout deployment strategy advancement. The intention
of Automation is to reduce manual intervention in the continuous delivery
process.
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}) — 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.
#annotations=
def annotations=(value) -> ::Google::Protobuf::Map{::String => ::String}
-
value (::Google::Protobuf::Map{::String => ::String}) — 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.
-
(::Google::Protobuf::Map{::String => ::String}) — 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.
#create_time
def create_time() -> ::Google::Protobuf::Timestamp
- (::Google::Protobuf::Timestamp) — Output only. Time at which the automation was created.
#description
def description() -> ::String
-
(::String) — Optional. Description of the
Automation
. Max length is 255 characters.
#description=
def description=(value) -> ::String
-
value (::String) — Optional. Description of the
Automation
. Max length is 255 characters.
-
(::String) — Optional. Description of the
Automation
. Max length is 255 characters.
#etag
def etag() -> ::String
-
(::String) — Optional. 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) — Optional. 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) — Optional. 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}) — Optional. 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 <= 63 characters.
#labels=
def labels=(value) -> ::Google::Protobuf::Map{::String => ::String}
-
value (::Google::Protobuf::Map{::String => ::String}) — Optional. 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 <= 63 characters.
-
(::Google::Protobuf::Map{::String => ::String}) — Optional. 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 <= 63 characters.
#name
def name() -> ::String
-
(::String) — Output only. Name of the
Automation
. Format isprojects/{project}/locations/{location}/deliveryPipelines/{delivery_pipeline}/automations/{automation}
.
#rules
def rules() -> ::Array<::Google::Cloud::Deploy::V1::AutomationRule>
- (::Array<::Google::Cloud::Deploy::V1::AutomationRule>) — Required. List of Automation rules associated with the Automation resource. Must have at least one rule and limited to 250 rules per Delivery Pipeline. Note: the order of the rules here is not the same as the order of execution.
#rules=
def rules=(value) -> ::Array<::Google::Cloud::Deploy::V1::AutomationRule>
- value (::Array<::Google::Cloud::Deploy::V1::AutomationRule>) — Required. List of Automation rules associated with the Automation resource. Must have at least one rule and limited to 250 rules per Delivery Pipeline. Note: the order of the rules here is not the same as the order of execution.
- (::Array<::Google::Cloud::Deploy::V1::AutomationRule>) — Required. List of Automation rules associated with the Automation resource. Must have at least one rule and limited to 250 rules per Delivery Pipeline. Note: the order of the rules here is not the same as the order of execution.
#selector
def selector() -> ::Google::Cloud::Deploy::V1::AutomationResourceSelector
- (::Google::Cloud::Deploy::V1::AutomationResourceSelector) — Required. Selected resources to which the automation will be applied.
#selector=
def selector=(value) -> ::Google::Cloud::Deploy::V1::AutomationResourceSelector
- value (::Google::Cloud::Deploy::V1::AutomationResourceSelector) — Required. Selected resources to which the automation will be applied.
- (::Google::Cloud::Deploy::V1::AutomationResourceSelector) — Required. Selected resources to which the automation will be applied.
#service_account
def service_account() -> ::String
- (::String) — Required. Email address of the user-managed IAM service account that creates Cloud Deploy release and rollout resources.
#service_account=
def service_account=(value) -> ::String
- value (::String) — Required. Email address of the user-managed IAM service account that creates Cloud Deploy release and rollout resources.
- (::String) — Required. Email address of the user-managed IAM service account that creates Cloud Deploy release and rollout resources.
#suspended
def suspended() -> ::Boolean
- (::Boolean) — Optional. When Suspended, automation is deactivated from execution.
#suspended=
def suspended=(value) -> ::Boolean
- value (::Boolean) — Optional. When Suspended, automation is deactivated from execution.
- (::Boolean) — Optional. When Suspended, automation is deactivated from execution.
#uid
def uid() -> ::String
-
(::String) — Output only. Unique identifier of the
Automation
.
#update_time
def update_time() -> ::Google::Protobuf::Timestamp
- (::Google::Protobuf::Timestamp) — Output only. Time at which the automation was updated.