public final class Automation extends GeneratedMessageV3 implements AutomationOrBuilder
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 amongst Targets,
Rollout repair and Rollout deployment strategy advancement. The intention
of Automation is to reduce manual intervention in the continuous delivery
process.
Protobuf type google.cloud.deploy.v1.Automation
Inherited Members
com.google.protobuf.GeneratedMessageV3.<ListT>makeMutableCopy(ListT)
com.google.protobuf.GeneratedMessageV3.<ListT>makeMutableCopy(ListT,int)
com.google.protobuf.GeneratedMessageV3.<T>emptyList(java.lang.Class<T>)
Static Fields
ANNOTATIONS_FIELD_NUMBER
public static final int ANNOTATIONS_FIELD_NUMBER
| Field Value |
|---|
| Type | Description |
int | |
CREATE_TIME_FIELD_NUMBER
public static final int CREATE_TIME_FIELD_NUMBER
| Field Value |
|---|
| Type | Description |
int | |
DESCRIPTION_FIELD_NUMBER
public static final int DESCRIPTION_FIELD_NUMBER
| Field Value |
|---|
| Type | Description |
int | |
ETAG_FIELD_NUMBER
public static final int ETAG_FIELD_NUMBER
| Field Value |
|---|
| Type | Description |
int | |
LABELS_FIELD_NUMBER
public static final int LABELS_FIELD_NUMBER
| Field Value |
|---|
| Type | Description |
int | |
NAME_FIELD_NUMBER
public static final int NAME_FIELD_NUMBER
| Field Value |
|---|
| Type | Description |
int | |
RULES_FIELD_NUMBER
public static final int RULES_FIELD_NUMBER
| Field Value |
|---|
| Type | Description |
int | |
SELECTOR_FIELD_NUMBER
public static final int SELECTOR_FIELD_NUMBER
| Field Value |
|---|
| Type | Description |
int | |
SERVICE_ACCOUNT_FIELD_NUMBER
public static final int SERVICE_ACCOUNT_FIELD_NUMBER
| Field Value |
|---|
| Type | Description |
int | |
SUSPENDED_FIELD_NUMBER
public static final int SUSPENDED_FIELD_NUMBER
| Field Value |
|---|
| Type | Description |
int | |
UID_FIELD_NUMBER
public static final int UID_FIELD_NUMBER
| Field Value |
|---|
| Type | Description |
int | |
UPDATE_TIME_FIELD_NUMBER
public static final int UPDATE_TIME_FIELD_NUMBER
| Field Value |
|---|
| Type | Description |
int | |
Static Methods
getDefaultInstance()
public static Automation getDefaultInstance()
getDescriptor()
public static final Descriptors.Descriptor getDescriptor()
newBuilder()
public static Automation.Builder newBuilder()
newBuilder(Automation prototype)
public static Automation.Builder newBuilder(Automation prototype)
public static Automation parseDelimitedFrom(InputStream input)
public static Automation parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
parseFrom(byte[] data)
public static Automation parseFrom(byte[] data)
| Parameter |
|---|
| Name | Description |
data | byte[]
|
parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)
public static Automation parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)
parseFrom(ByteString data)
public static Automation parseFrom(ByteString data)
parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)
public static Automation parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)
public static Automation parseFrom(CodedInputStream input)
public static Automation parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
public static Automation parseFrom(InputStream input)
public static Automation parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
parseFrom(ByteBuffer data)
public static Automation parseFrom(ByteBuffer data)
parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)
public static Automation parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)
parser()
public static Parser<Automation> parser()
Methods
containsAnnotations(String key)
public 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];
| Parameter |
|---|
| Name | Description |
key | String
|
containsLabels(String key)
public 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:
map<string, string> labels = 7 [(.google.api.field_behavior) = OPTIONAL];
| Parameter |
|---|
| Name | Description |
key | String
|
equals(Object obj)
public boolean equals(Object obj)
| Parameter |
|---|
| Name | Description |
obj | Object
|
Overrides
getAnnotations()
public Map<String,String> getAnnotations()
getAnnotationsCount()
public 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];
| Returns |
|---|
| Type | Description |
int | |
getAnnotationsMap()
public 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 key, String defaultValue)
public 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 key)
public 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];
| Parameter |
|---|
| Name | Description |
key | String
|
getCreateTime()
public Timestamp getCreateTime()
Output only. Time at which the automation was created.
.google.protobuf.Timestamp create_time = 4 [(.google.api.field_behavior) = OUTPUT_ONLY];
| Returns |
|---|
| Type | Description |
Timestamp | The createTime.
|
getCreateTimeOrBuilder()
public TimestampOrBuilder getCreateTimeOrBuilder()
Output only. Time at which the automation was created.
.google.protobuf.Timestamp create_time = 4 [(.google.api.field_behavior) = OUTPUT_ONLY];
getDefaultInstanceForType()
public Automation getDefaultInstanceForType()
getDescription()
public String getDescription()
Optional. Description of the Automation. Max length is 255 characters.
string description = 3 [(.google.api.field_behavior) = OPTIONAL];
| Returns |
|---|
| Type | Description |
String | The description.
|
getDescriptionBytes()
public ByteString getDescriptionBytes()
Optional. Description of the Automation. Max length is 255 characters.
string description = 3 [(.google.api.field_behavior) = OPTIONAL];
| Returns |
|---|
| Type | Description |
ByteString | The bytes for description.
|
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 |
|---|
| Type | Description |
String | The etag.
|
getEtagBytes()
public 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 |
|---|
| Type | Description |
ByteString | The bytes for etag.
|
getLabels()
public Map<String,String> getLabels()
getLabelsCount()
public 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:
map<string, string> labels = 7 [(.google.api.field_behavior) = OPTIONAL];
| Returns |
|---|
| Type | Description |
int | |
getLabelsMap()
public 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:
map<string, string> labels = 7 [(.google.api.field_behavior) = OPTIONAL];
getLabelsOrDefault(String key, String defaultValue)
public 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:
map<string, string> labels = 7 [(.google.api.field_behavior) = OPTIONAL];
getLabelsOrThrow(String key)
public 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:
map<string, string> labels = 7 [(.google.api.field_behavior) = OPTIONAL];
| Parameter |
|---|
| Name | Description |
key | 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 |
|---|
| Type | Description |
String | The name.
|
getNameBytes()
public 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 |
|---|
| Type | Description |
ByteString | The bytes for name.
|
getParserForType()
public Parser<Automation> getParserForType()
Overrides
getRules(int index)
public 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];
| Parameter |
|---|
| Name | Description |
index | int
|
getRulesCount()
public 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];
| Returns |
|---|
| Type | Description |
int | |
getRulesList()
public 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];
getRulesOrBuilder(int index)
public 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];
| Parameter |
|---|
| Name | Description |
index | int
|
getRulesOrBuilderList()
public 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];
| Returns |
|---|
| Type | Description |
List<? extends com.google.cloud.deploy.v1.AutomationRuleOrBuilder> | |
getSelector()
public AutomationResourceSelector getSelector()
Required. Selected resources to which the automation will be applied.
.google.cloud.deploy.v1.AutomationResourceSelector selector = 11 [(.google.api.field_behavior) = REQUIRED];
getSelectorOrBuilder()
public AutomationResourceSelectorOrBuilder getSelectorOrBuilder()
Required. Selected resources to which the automation will be applied.
.google.cloud.deploy.v1.AutomationResourceSelector selector = 11 [(.google.api.field_behavior) = REQUIRED];
getSerializedSize()
public int getSerializedSize()
| Returns |
|---|
| Type | Description |
int | |
Overrides
getServiceAccount()
public 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 |
|---|
| Type | Description |
String | The serviceAccount.
|
getServiceAccountBytes()
public 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 |
|---|
| Type | Description |
ByteString | The bytes for serviceAccount.
|
getSuspended()
public boolean getSuspended()
Optional. When Suspended, automation is deactivated from execution.
bool suspended = 9 [(.google.api.field_behavior) = OPTIONAL];
| Returns |
|---|
| Type | Description |
boolean | The suspended.
|
getUid()
Output only. Unique identifier of the Automation.
string uid = 2 [(.google.api.field_behavior) = OUTPUT_ONLY];
| Returns |
|---|
| Type | Description |
String | The uid.
|
getUidBytes()
public ByteString getUidBytes()
Output only. Unique identifier of the Automation.
string uid = 2 [(.google.api.field_behavior) = OUTPUT_ONLY];
| Returns |
|---|
| Type | Description |
ByteString | The bytes for uid.
|
getUpdateTime()
public Timestamp getUpdateTime()
Output only. Time at which the automation was updated.
.google.protobuf.Timestamp update_time = 5 [(.google.api.field_behavior) = OUTPUT_ONLY];
| Returns |
|---|
| Type | Description |
Timestamp | The updateTime.
|
getUpdateTimeOrBuilder()
public TimestampOrBuilder getUpdateTimeOrBuilder()
Output only. Time at which the automation was updated.
.google.protobuf.Timestamp update_time = 5 [(.google.api.field_behavior) = OUTPUT_ONLY];
hasCreateTime()
public boolean hasCreateTime()
Output only. Time at which the automation was created.
.google.protobuf.Timestamp create_time = 4 [(.google.api.field_behavior) = OUTPUT_ONLY];
| Returns |
|---|
| Type | Description |
boolean | Whether the createTime field is set.
|
hasSelector()
public 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 |
|---|
| Type | Description |
boolean | Whether the selector field is set.
|
hasUpdateTime()
public boolean hasUpdateTime()
Output only. Time at which the automation was updated.
.google.protobuf.Timestamp update_time = 5 [(.google.api.field_behavior) = OUTPUT_ONLY];
| Returns |
|---|
| Type | Description |
boolean | Whether the updateTime field is set.
|
hashCode()
| Returns |
|---|
| Type | Description |
int | |
Overrides
internalGetFieldAccessorTable()
protected GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
Overrides
internalGetMapField(int number)
protected MapField internalGetMapField(int number)
| Parameter |
|---|
| Name | Description |
number | int
|
Overrides
isInitialized()
public final boolean isInitialized()
Overrides
newBuilderForType()
public Automation.Builder newBuilderForType()
newBuilderForType(GeneratedMessageV3.BuilderParent parent)
protected Automation.Builder newBuilderForType(GeneratedMessageV3.BuilderParent parent)
Overrides
newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)
protected Object newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)
Overrides
toBuilder()
public Automation.Builder toBuilder()
writeTo(CodedOutputStream output)
public void writeTo(CodedOutputStream output)
Overrides
