com.google.cloud.deploy.v1.AutomationOrBuilder Maven / Gradle / Ivy
Go to download
Show more of this group Show more artifacts with this name
Show all versions of proto-google-cloud-deploy-v1 Show documentation
Show all versions of proto-google-cloud-deploy-v1 Show documentation
Proto library for google-cloud-deploy
The newest version!
/*
* Copyright 2024 Google LLC
*
* Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License.
* You may obtain a copy of the License at
*
* https://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS,
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
* See the License for the specific language governing permissions and
* limitations under the License.
*/
// Generated by the protocol buffer compiler. DO NOT EDIT!
// source: google/cloud/deploy/v1/cloud_deploy.proto
// Protobuf Java Version: 3.25.4
package com.google.cloud.deploy.v1;
public interface AutomationOrBuilder
extends
// @@protoc_insertion_point(interface_extends:google.cloud.deploy.v1.Automation)
com.google.protobuf.MessageOrBuilder {
/**
*
*
*
* 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];
*
* @return The name.
*/
java.lang.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];
*
* @return The bytes for name.
*/
com.google.protobuf.ByteString getNameBytes();
/**
*
*
*
* Output only. Unique identifier of the `Automation`.
*
*
* string uid = 2 [(.google.api.field_behavior) = OUTPUT_ONLY];
*
* @return The uid.
*/
java.lang.String getUid();
/**
*
*
*
* Output only. Unique identifier of the `Automation`.
*
*
* string uid = 2 [(.google.api.field_behavior) = OUTPUT_ONLY];
*
* @return The bytes for uid.
*/
com.google.protobuf.ByteString getUidBytes();
/**
*
*
*
* Optional. Description of the `Automation`. Max length is 255 characters.
*
*
* string description = 3 [(.google.api.field_behavior) = OPTIONAL];
*
* @return The description.
*/
java.lang.String getDescription();
/**
*
*
*
* Optional. Description of the `Automation`. Max length is 255 characters.
*
*
* string description = 3 [(.google.api.field_behavior) = OPTIONAL];
*
* @return The bytes for description.
*/
com.google.protobuf.ByteString getDescriptionBytes();
/**
*
*
*
* Output only. Time at which the automation was created.
*
*
* .google.protobuf.Timestamp create_time = 4 [(.google.api.field_behavior) = OUTPUT_ONLY];
*
*
* @return Whether the createTime field is set.
*/
boolean hasCreateTime();
/**
*
*
*
* Output only. Time at which the automation was created.
*
*
* .google.protobuf.Timestamp create_time = 4 [(.google.api.field_behavior) = OUTPUT_ONLY];
*
*
* @return The createTime.
*/
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];
*
*/
com.google.protobuf.TimestampOrBuilder getCreateTimeOrBuilder();
/**
*
*
*
* Output only. Time at which the automation was updated.
*
*
* .google.protobuf.Timestamp update_time = 5 [(.google.api.field_behavior) = OUTPUT_ONLY];
*
*
* @return Whether the updateTime field is set.
*/
boolean hasUpdateTime();
/**
*
*
*
* Output only. Time at which the automation was updated.
*
*
* .google.protobuf.Timestamp update_time = 5 [(.google.api.field_behavior) = OUTPUT_ONLY];
*
*
* @return The updateTime.
*/
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];
*
*/
com.google.protobuf.TimestampOrBuilder getUpdateTimeOrBuilder();
/**
*
*
*
* 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];
*
*/
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];
*
*/
boolean containsAnnotations(java.lang.String key);
/** Use {@link #getAnnotationsMap()} instead. */
@java.lang.Deprecated
java.util.Map getAnnotations();
/**
*
*
*
* 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];
*
*/
java.util.Map 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];
*
*/
/* nullable */
java.lang.String getAnnotationsOrDefault(
java.lang.String key,
/* nullable */
java.lang.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];
*
*/
java.lang.String getAnnotationsOrThrow(java.lang.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];
*/
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];
*/
boolean containsLabels(java.lang.String key);
/** Use {@link #getLabelsMap()} instead. */
@java.lang.Deprecated
java.util.Map getLabels();
/**
*
*
*
* 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];
*/
java.util.Map 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];
*/
/* nullable */
java.lang.String getLabelsOrDefault(
java.lang.String key,
/* nullable */
java.lang.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];
*/
java.lang.String getLabelsOrThrow(java.lang.String key);
/**
*
*
*
* 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];
*
* @return The etag.
*/
java.lang.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];
*
* @return The bytes for etag.
*/
com.google.protobuf.ByteString getEtagBytes();
/**
*
*
*
* Optional. When Suspended, automation is deactivated from execution.
*
*
* bool suspended = 9 [(.google.api.field_behavior) = OPTIONAL];
*
* @return The suspended.
*/
boolean getSuspended();
/**
*
*
*
* 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];
*
* @return The serviceAccount.
*/
java.lang.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];
*
* @return The bytes for serviceAccount.
*/
com.google.protobuf.ByteString getServiceAccountBytes();
/**
*
*
*
* Required. Selected resources to which the automation will be applied.
*
*
*
* .google.cloud.deploy.v1.AutomationResourceSelector selector = 11 [(.google.api.field_behavior) = REQUIRED];
*
*
* @return Whether the selector field is set.
*/
boolean hasSelector();
/**
*
*
*
* Required. Selected resources to which the automation will be applied.
*
*
*
* .google.cloud.deploy.v1.AutomationResourceSelector selector = 11 [(.google.api.field_behavior) = REQUIRED];
*
*
* @return The selector.
*/
com.google.cloud.deploy.v1.AutomationResourceSelector getSelector();
/**
*
*
*
* Required. Selected resources to which the automation will be applied.
*
*
*
* .google.cloud.deploy.v1.AutomationResourceSelector selector = 11 [(.google.api.field_behavior) = REQUIRED];
*
*/
com.google.cloud.deploy.v1.AutomationResourceSelectorOrBuilder getSelectorOrBuilder();
/**
*
*
*
* 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];
*
*/
java.util.List 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];
*
*/
com.google.cloud.deploy.v1.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];
*
*/
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];
*
*/
java.util.List
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];
*
*/
com.google.cloud.deploy.v1.AutomationRuleOrBuilder getRulesOrBuilder(int index);
}