com.google.cloud.deploy.v1

Interface AutomationOrBuilder

All Superinterfaces:

com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder

All Known Implementing Classes:

Automation, Automation.Builder

public interface AutomationOrBuilder
extends com.google.protobuf.MessageOrBuilder

Method Summary

Modifier and Type	Method and Description
boolean	containsAnnotations(String key) Optional.
boolean	containsLabels(String key) Optional.
Map<String,String>	getAnnotations() Deprecated.
int	getAnnotationsCount() Optional.
Map<String,String>	getAnnotationsMap() Optional.
String	getAnnotationsOrDefault(String key, String defaultValue) Optional.
String	getAnnotationsOrThrow(String key) Optional.
com.google.protobuf.Timestamp	getCreateTime() Output only.
com.google.protobuf.TimestampOrBuilder	getCreateTimeOrBuilder() Output only.
String	getDescription() Optional.
com.google.protobuf.ByteString	getDescriptionBytes() Optional.
String	getEtag() Optional.
com.google.protobuf.ByteString	getEtagBytes() Optional.
Map<String,String>	getLabels() Deprecated.
int	getLabelsCount() Optional.
Map<String,String>	getLabelsMap() Optional.
String	getLabelsOrDefault(String key, String defaultValue) Optional.
String	getLabelsOrThrow(String key) Optional.
String	getName() Output only.
com.google.protobuf.ByteString	getNameBytes() Output only.
AutomationRule	getRules(int index) Required.
int	getRulesCount() Required.
List<AutomationRule>	getRulesList() Required.
AutomationRuleOrBuilder	getRulesOrBuilder(int index) Required.
List<? extends AutomationRuleOrBuilder>	getRulesOrBuilderList() Required.
AutomationResourceSelector	getSelector() Required.
AutomationResourceSelectorOrBuilder	getSelectorOrBuilder() Required.
String	getServiceAccount() Required.
com.google.protobuf.ByteString	getServiceAccountBytes() Required.
boolean	getSuspended() Optional.
String	getUid() Output only.
com.google.protobuf.ByteString	getUidBytes() Output only.
com.google.protobuf.Timestamp	getUpdateTime() Output only.
com.google.protobuf.TimestampOrBuilder	getUpdateTimeOrBuilder() Output only.
boolean	hasCreateTime() Output only.
boolean	hasSelector() Required.
boolean	hasUpdateTime() Output only.

Methods inherited from interface com.google.protobuf.MessageOrBuilder

findInitializationErrors, getAllFields, getDefaultInstanceForType, getDescriptorForType, getField, getInitializationErrorString, getOneofFieldDescriptor, getRepeatedField, getRepeatedFieldCount, getUnknownFields, hasField, hasOneof

Methods inherited from interface com.google.protobuf.MessageLiteOrBuilder

isInitialized

Method Detail

getName

String getName()

 Output only. Name of the `Automation`. Format is
 `projects/{project}/locations/{location}/deliveryPipelines/{delivery_pipeline}/automations/{automation}`.
 

string name = 1 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns:

The name.

getNameBytes

com.google.protobuf.ByteString getNameBytes()

 Output only. Name of the `Automation`. Format is
 `projects/{project}/locations/{location}/deliveryPipelines/{delivery_pipeline}/automations/{automation}`.
 

string name = 1 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns:

The bytes for name.

getUid

String getUid()

 Output only. Unique identifier of the `Automation`.
 

string uid = 2 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns:

The uid.

getUidBytes

com.google.protobuf.ByteString getUidBytes()

 Output only. Unique identifier of the `Automation`.
 

string uid = 2 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns:

The bytes for uid.

getDescription

String getDescription()

 Optional. Description of the `Automation`. Max length is 255 characters.
 

string description = 3 [(.google.api.field_behavior) = OPTIONAL];

Returns:

The description.

getDescriptionBytes

com.google.protobuf.ByteString getDescriptionBytes()

 Optional. Description of the `Automation`. Max length is 255 characters.
 

string description = 3 [(.google.api.field_behavior) = OPTIONAL];

Returns:

The bytes for description.

hasCreateTime

boolean hasCreateTime()

 Output only. Time at which the automation was created.
 

.google.protobuf.Timestamp create_time = 4 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns:

Whether the createTime field is set.

getCreateTime

com.google.protobuf.Timestamp getCreateTime()

 Output only. Time at which the automation was created.
 

.google.protobuf.Timestamp create_time = 4 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns:

The createTime.

getCreateTimeOrBuilder

com.google.protobuf.TimestampOrBuilder getCreateTimeOrBuilder()

 Output only. Time at which the automation was created.
 

.google.protobuf.Timestamp create_time = 4 [(.google.api.field_behavior) = OUTPUT_ONLY];

hasUpdateTime

boolean hasUpdateTime()

 Output only. Time at which the automation was updated.
 

.google.protobuf.Timestamp update_time = 5 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns:

Whether the updateTime field is set.

getUpdateTime

com.google.protobuf.Timestamp getUpdateTime()

 Output only. Time at which the automation was updated.
 

.google.protobuf.Timestamp update_time = 5 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns:

The updateTime.

getUpdateTimeOrBuilder

com.google.protobuf.TimestampOrBuilder getUpdateTimeOrBuilder()

 Output only. Time at which the automation was updated.
 

.google.protobuf.Timestamp update_time = 5 [(.google.api.field_behavior) = OUTPUT_ONLY];

getAnnotationsCount

int getAnnotationsCount()

 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.
 

map<string, string> annotations = 6 [(.google.api.field_behavior) = OPTIONAL];

containsAnnotations

boolean containsAnnotations(String key)

 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.
 

map<string, string> annotations = 6 [(.google.api.field_behavior) = OPTIONAL];

getAnnotations

@Deprecated
Map<String,String> getAnnotations()

Deprecated.

Use getAnnotationsMap() instead.

getAnnotationsMap

Map<String,String> getAnnotationsMap()

 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.
 

map<string, string> annotations = 6 [(.google.api.field_behavior) = OPTIONAL];

getAnnotationsOrDefault

String getAnnotationsOrDefault(String key,
                               String defaultValue)

 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.
 

map<string, string> annotations = 6 [(.google.api.field_behavior) = OPTIONAL];

getAnnotationsOrThrow

String getAnnotationsOrThrow(String key)

 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.
 

map<string, string> annotations = 6 [(.google.api.field_behavior) = OPTIONAL];

getLabelsCount

int getLabelsCount()

 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.
 

map<string, string> labels = 7 [(.google.api.field_behavior) = OPTIONAL];

containsLabels

boolean containsLabels(String key)

 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.
 

map<string, string> labels = 7 [(.google.api.field_behavior) = OPTIONAL];

getLabels

@Deprecated
Map<String,String> getLabels()

Deprecated.

Use getLabelsMap() instead.

getLabelsMap

Map<String,String> getLabelsMap()

 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.
 

map<string, string> labels = 7 [(.google.api.field_behavior) = OPTIONAL];

getLabelsOrDefault

String getLabelsOrDefault(String key,
                          String defaultValue)

 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.
 

map<string, string> labels = 7 [(.google.api.field_behavior) = OPTIONAL];

getLabelsOrThrow

String getLabelsOrThrow(String key)

 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.
 

map<string, string> labels = 7 [(.google.api.field_behavior) = OPTIONAL];

getEtag

String getEtag()

 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 etag = 8 [(.google.api.field_behavior) = OPTIONAL];

Returns:

The etag.

getEtagBytes

com.google.protobuf.ByteString getEtagBytes()

 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 etag = 8 [(.google.api.field_behavior) = OPTIONAL];

Returns:

The bytes for etag.

getSuspended

boolean getSuspended()

 Optional. When Suspended, automation is deactivated from execution.
 

bool suspended = 9 [(.google.api.field_behavior) = OPTIONAL];

Returns:

The suspended.

getServiceAccount

String getServiceAccount()

 Required. Email address of the user-managed IAM service account that
 creates Cloud Deploy release and rollout resources.
 

string service_account = 10 [(.google.api.field_behavior) = REQUIRED];

Returns:

The serviceAccount.

getServiceAccountBytes

com.google.protobuf.ByteString getServiceAccountBytes()

 Required. Email address of the user-managed IAM service account that
 creates Cloud Deploy release and rollout resources.
 

string service_account = 10 [(.google.api.field_behavior) = REQUIRED];

Returns:

The bytes for serviceAccount.

hasSelector

boolean hasSelector()

 Required. Selected resources to which the automation will be applied.
 

.google.cloud.deploy.v1.AutomationResourceSelector selector = 11 [(.google.api.field_behavior) = REQUIRED];

Returns:

Whether the selector field is set.

getSelector

AutomationResourceSelector getSelector()

 Required. Selected resources to which the automation will be applied.
 

.google.cloud.deploy.v1.AutomationResourceSelector selector = 11 [(.google.api.field_behavior) = REQUIRED];

Returns:

The selector.

getSelectorOrBuilder

AutomationResourceSelectorOrBuilder getSelectorOrBuilder()

 Required. Selected resources to which the automation will be applied.
 

.google.cloud.deploy.v1.AutomationResourceSelector selector = 11 [(.google.api.field_behavior) = REQUIRED];

getRulesList

List<AutomationRule> getRulesList()

 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.
 

repeated .google.cloud.deploy.v1.AutomationRule rules = 14 [(.google.api.field_behavior) = REQUIRED];

getRules

AutomationRule getRules(int index)

 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.
 

repeated .google.cloud.deploy.v1.AutomationRule rules = 14 [(.google.api.field_behavior) = REQUIRED];

getRulesCount

int getRulesCount()

 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.
 

repeated .google.cloud.deploy.v1.AutomationRule rules = 14 [(.google.api.field_behavior) = REQUIRED];

getRulesOrBuilderList

List<? extends AutomationRuleOrBuilder> getRulesOrBuilderList()

 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.
 

repeated .google.cloud.deploy.v1.AutomationRule rules = 14 [(.google.api.field_behavior) = REQUIRED];

getRulesOrBuilder

AutomationRuleOrBuilder getRulesOrBuilder(int index)

 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.
 

repeated .google.cloud.deploy.v1.AutomationRule rules = 14 [(.google.api.field_behavior) = REQUIRED];