Google Cloud Deploy V1 API - Class Google::Cloud::Deploy::V1::Automation (v1.0.0)

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}
Returns
  • (::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}
Parameter
  • 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.

Returns
  • (::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
Returns

#description

def description() -> ::String
Returns
  • (::String) — Optional. Description of the Automation. Max length is 255 characters.

#description=

def description=(value) -> ::String
Parameter
  • value (::String) — Optional. Description of the Automation. Max length is 255 characters.
Returns
  • (::String) — Optional. Description of the Automation. Max length is 255 characters.

#etag

def etag() -> ::String
Returns
  • (::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
Parameter
  • 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.
Returns
  • (::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}
Returns
  • (::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}
Parameter
  • 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.

Returns
  • (::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
Returns
  • (::String) — Output only. Name of the Automation. Format is projects/{project}/locations/{location}/deliveryPipelines/{delivery_pipeline}/automations/{automation}.

#rules

def rules() -> ::Array<::Google::Cloud::Deploy::V1::AutomationRule>
Returns
  • (::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>
Parameter
  • 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.
Returns
  • (::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
Returns

#selector=

def selector=(value) -> ::Google::Cloud::Deploy::V1::AutomationResourceSelector
Parameter
Returns

#service_account

def service_account() -> ::String
Returns
  • (::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
Parameter
  • value (::String) — Required. Email address of the user-managed IAM service account that creates Cloud Deploy release and rollout resources.
Returns
  • (::String) — Required. Email address of the user-managed IAM service account that creates Cloud Deploy release and rollout resources.

#suspended

def suspended() -> ::Boolean
Returns
  • (::Boolean) — Optional. When Suspended, automation is deactivated from execution.

#suspended=

def suspended=(value) -> ::Boolean
Parameter
  • value (::Boolean) — Optional. When Suspended, automation is deactivated from execution.
Returns
  • (::Boolean) — Optional. When Suspended, automation is deactivated from execution.

#uid

def uid() -> ::String
Returns
  • (::String) — Output only. Unique identifier of the Automation.

#update_time

def update_time() -> ::Google::Protobuf::Timestamp
Returns