Class ExecutionTemplate.Builder (0.53.0) 

public static final class ExecutionTemplate.Builder extends GeneratedMessageV3.Builder<ExecutionTemplate.Builder> implements ExecutionTemplateOrBuilder

ExecutionTemplate describes the data an execution should have when created from a template.

Protobuf type google.cloud.run.v2.ExecutionTemplate

Inheritance

Object > AbstractMessageLite.Builder<MessageType,BuilderType> > AbstractMessage.Builder<BuilderType> > GeneratedMessageV3.Builder > ExecutionTemplate.Builder

Static Methods

getDescriptor()

public static final Descriptors.Descriptor getDescriptor()
Returns
Type Description
Descriptor

Methods

addRepeatedField(Descriptors.FieldDescriptor field, Object value)

public ExecutionTemplate.Builder addRepeatedField(Descriptors.FieldDescriptor field, Object value)
Parameters
Name Description
field FieldDescriptor
value Object
Returns
Type Description
ExecutionTemplate.Builder
Overrides

build()

public ExecutionTemplate build()
Returns
Type Description
ExecutionTemplate

buildPartial()

public ExecutionTemplate buildPartial()
Returns
Type Description
ExecutionTemplate

clear()

public ExecutionTemplate.Builder clear()
Returns
Type Description
ExecutionTemplate.Builder
Overrides

clearAnnotations()

public ExecutionTemplate.Builder clearAnnotations()
Returns
Type Description
ExecutionTemplate.Builder

clearField(Descriptors.FieldDescriptor field)

public ExecutionTemplate.Builder clearField(Descriptors.FieldDescriptor field)
Parameter
Name Description
field FieldDescriptor
Returns
Type Description
ExecutionTemplate.Builder
Overrides

clearLabels()

public ExecutionTemplate.Builder clearLabels()
Returns
Type Description
ExecutionTemplate.Builder

clearOneof(Descriptors.OneofDescriptor oneof)

public ExecutionTemplate.Builder clearOneof(Descriptors.OneofDescriptor oneof)
Parameter
Name Description
oneof OneofDescriptor
Returns
Type Description
ExecutionTemplate.Builder
Overrides

clearParallelism()

public ExecutionTemplate.Builder clearParallelism()

Specifies the maximum desired number of tasks the execution should run at given time. Must be <= task_count. When the job is run, if this field is 0 or unset, the maximum possible value will be used for that execution. The actual number of tasks running in steady state will be less than this number when there are fewer tasks waiting to be completed remaining, i.e. when the work left to do is less than max parallelism.

int32 parallelism = 3;

Returns
Type Description
ExecutionTemplate.Builder

This builder for chaining.

clearTaskCount()

public ExecutionTemplate.Builder clearTaskCount()

Specifies the desired number of tasks the execution should run. Setting to 1 means that parallelism is limited to 1 and the success of that task signals the success of the execution. Defaults to 1.

int32 task_count = 4;

Returns
Type Description
ExecutionTemplate.Builder

This builder for chaining.

clearTemplate()

public ExecutionTemplate.Builder clearTemplate()

Required. Describes the task(s) that will be created when executing an execution.

.google.cloud.run.v2.TaskTemplate template = 5 [(.google.api.field_behavior) = REQUIRED];

Returns
Type Description
ExecutionTemplate.Builder

clone()

public ExecutionTemplate.Builder clone()
Returns
Type Description
ExecutionTemplate.Builder
Overrides

containsAnnotations(String key)

public boolean containsAnnotations(String key)

Unstructured key value map that may be set by external tools to store and arbitrary metadata. They are not queryable and should be preserved when modifying objects.

<p>Cloud Run API v2 does not support annotations with run.googleapis.com, cloud.googleapis.com, serving.knative.dev, or autoscaling.knative.dev namespaces, and they will be rejected. All system annotations in v1 now have a corresponding field in v2 ExecutionTemplate.

<p>This field follows Kubernetes annotations' namespacing, limits, and rules.

map<string, string> annotations = 2;

Parameter
Name Description
key String
Returns
Type Description
boolean

containsLabels(String key)

public boolean containsLabels(String key)

Unstructured key value map that can be used to organize and categorize objects. User-provided labels are shared with Google's billing system, so they can be used to filter, or break down billing charges by team, component, environment, state, etc. For more information, visit https://cloud.google.com/resource-manager/docs/creating-managing-labels or https://cloud.google.com/run/docs/configuring/labels.

<p>Cloud Run API v2 does not support labels with run.googleapis.com, cloud.googleapis.com, serving.knative.dev, or autoscaling.knative.dev namespaces, and they will be rejected. All system labels in v1 now have a corresponding field in v2 ExecutionTemplate.

map<string, string> labels = 1;

Parameter
Name Description
key String
Returns
Type Description
boolean

getAnnotations() (deprecated)

public Map<String,String> getAnnotations()

Use #getAnnotationsMap() instead.

Returns
Type Description
Map<String,String>

getAnnotationsCount()

public int getAnnotationsCount()

Unstructured key value map that may be set by external tools to store and arbitrary metadata. They are not queryable and should be preserved when modifying objects.

<p>Cloud Run API v2 does not support annotations with run.googleapis.com, cloud.googleapis.com, serving.knative.dev, or autoscaling.knative.dev namespaces, and they will be rejected. All system annotations in v1 now have a corresponding field in v2 ExecutionTemplate.

<p>This field follows Kubernetes annotations' namespacing, limits, and rules.

map<string, string> annotations = 2;

Returns
Type Description
int

getAnnotationsMap()

public Map<String,String> getAnnotationsMap()

Unstructured key value map that may be set by external tools to store and arbitrary metadata. They are not queryable and should be preserved when modifying objects.

<p>Cloud Run API v2 does not support annotations with run.googleapis.com, cloud.googleapis.com, serving.knative.dev, or autoscaling.knative.dev namespaces, and they will be rejected. All system annotations in v1 now have a corresponding field in v2 ExecutionTemplate.

<p>This field follows Kubernetes annotations' namespacing, limits, and rules.

map<string, string> annotations = 2;

Returns
Type Description
Map<String,String>

getAnnotationsOrDefault(String key, String defaultValue)

public String getAnnotationsOrDefault(String key, String defaultValue)

Unstructured key value map that may be set by external tools to store and arbitrary metadata. They are not queryable and should be preserved when modifying objects.

<p>Cloud Run API v2 does not support annotations with run.googleapis.com, cloud.googleapis.com, serving.knative.dev, or autoscaling.knative.dev namespaces, and they will be rejected. All system annotations in v1 now have a corresponding field in v2 ExecutionTemplate.

<p>This field follows Kubernetes annotations' namespacing, limits, and rules.

map<string, string> annotations = 2;

Parameters
Name Description
key String
defaultValue String
Returns
Type Description
String

getAnnotationsOrThrow(String key)

public String getAnnotationsOrThrow(String key)

Unstructured key value map that may be set by external tools to store and arbitrary metadata. They are not queryable and should be preserved when modifying objects.

<p>Cloud Run API v2 does not support annotations with run.googleapis.com, cloud.googleapis.com, serving.knative.dev, or autoscaling.knative.dev namespaces, and they will be rejected. All system annotations in v1 now have a corresponding field in v2 ExecutionTemplate.

<p>This field follows Kubernetes annotations' namespacing, limits, and rules.

map<string, string> annotations = 2;

Parameter
Name Description
key String
Returns
Type Description
String

getDefaultInstanceForType()

public ExecutionTemplate getDefaultInstanceForType()
Returns
Type Description
ExecutionTemplate

getDescriptorForType()

public Descriptors.Descriptor getDescriptorForType()
Returns
Type Description
Descriptor
Overrides

getLabels() (deprecated)

public Map<String,String> getLabels()

Use #getLabelsMap() instead.

Returns
Type Description
Map<String,String>

getLabelsCount()

public int getLabelsCount()

Unstructured key value map that can be used to organize and categorize objects. User-provided labels are shared with Google's billing system, so they can be used to filter, or break down billing charges by team, component, environment, state, etc. For more information, visit https://cloud.google.com/resource-manager/docs/creating-managing-labels or https://cloud.google.com/run/docs/configuring/labels.

<p>Cloud Run API v2 does not support labels with run.googleapis.com, cloud.googleapis.com, serving.knative.dev, or autoscaling.knative.dev namespaces, and they will be rejected. All system labels in v1 now have a corresponding field in v2 ExecutionTemplate.

map<string, string> labels = 1;

Returns
Type Description
int

getLabelsMap()

public Map<String,String> getLabelsMap()

Unstructured key value map that can be used to organize and categorize objects. User-provided labels are shared with Google's billing system, so they can be used to filter, or break down billing charges by team, component, environment, state, etc. For more information, visit https://cloud.google.com/resource-manager/docs/creating-managing-labels or https://cloud.google.com/run/docs/configuring/labels.

<p>Cloud Run API v2 does not support labels with run.googleapis.com, cloud.googleapis.com, serving.knative.dev, or autoscaling.knative.dev namespaces, and they will be rejected. All system labels in v1 now have a corresponding field in v2 ExecutionTemplate.

map<string, string> labels = 1;

Returns
Type Description
Map<String,String>

getLabelsOrDefault(String key, String defaultValue)

public String getLabelsOrDefault(String key, String defaultValue)

Unstructured key value map that can be used to organize and categorize objects. User-provided labels are shared with Google's billing system, so they can be used to filter, or break down billing charges by team, component, environment, state, etc. For more information, visit https://cloud.google.com/resource-manager/docs/creating-managing-labels or https://cloud.google.com/run/docs/configuring/labels.

<p>Cloud Run API v2 does not support labels with run.googleapis.com, cloud.googleapis.com, serving.knative.dev, or autoscaling.knative.dev namespaces, and they will be rejected. All system labels in v1 now have a corresponding field in v2 ExecutionTemplate.

map<string, string> labels = 1;

Parameters
Name Description
key String
defaultValue String
Returns
Type Description
String

getLabelsOrThrow(String key)

public String getLabelsOrThrow(String key)

Unstructured key value map that can be used to organize and categorize objects. User-provided labels are shared with Google's billing system, so they can be used to filter, or break down billing charges by team, component, environment, state, etc. For more information, visit https://cloud.google.com/resource-manager/docs/creating-managing-labels or https://cloud.google.com/run/docs/configuring/labels.

<p>Cloud Run API v2 does not support labels with run.googleapis.com, cloud.googleapis.com, serving.knative.dev, or autoscaling.knative.dev namespaces, and they will be rejected. All system labels in v1 now have a corresponding field in v2 ExecutionTemplate.

map<string, string> labels = 1;

Parameter
Name Description
key String
Returns
Type Description
String

getMutableAnnotations() (deprecated)

public Map<String,String> getMutableAnnotations()

Use alternate mutation accessors instead.

Returns
Type Description
Map<String,String>

getMutableLabels() (deprecated)

public Map<String,String> getMutableLabels()

Use alternate mutation accessors instead.

Returns
Type Description
Map<String,String>

getParallelism()

public int getParallelism()

Specifies the maximum desired number of tasks the execution should run at given time. Must be <= task_count. When the job is run, if this field is 0 or unset, the maximum possible value will be used for that execution. The actual number of tasks running in steady state will be less than this number when there are fewer tasks waiting to be completed remaining, i.e. when the work left to do is less than max parallelism.

int32 parallelism = 3;

Returns
Type Description
int

The parallelism.

getTaskCount()

public int getTaskCount()

Specifies the desired number of tasks the execution should run. Setting to 1 means that parallelism is limited to 1 and the success of that task signals the success of the execution. Defaults to 1.

int32 task_count = 4;

Returns
Type Description
int

The taskCount.

getTemplate()

public TaskTemplate getTemplate()

Required. Describes the task(s) that will be created when executing an execution.

.google.cloud.run.v2.TaskTemplate template = 5 [(.google.api.field_behavior) = REQUIRED];

Returns
Type Description
TaskTemplate

The template.

getTemplateBuilder()

public TaskTemplate.Builder getTemplateBuilder()

Required. Describes the task(s) that will be created when executing an execution.

.google.cloud.run.v2.TaskTemplate template = 5 [(.google.api.field_behavior) = REQUIRED];

Returns
Type Description
TaskTemplate.Builder

getTemplateOrBuilder()

public TaskTemplateOrBuilder getTemplateOrBuilder()

Required. Describes the task(s) that will be created when executing an execution.

.google.cloud.run.v2.TaskTemplate template = 5 [(.google.api.field_behavior) = REQUIRED];

Returns
Type Description
TaskTemplateOrBuilder

hasTemplate()

public boolean hasTemplate()

Required. Describes the task(s) that will be created when executing an execution.

.google.cloud.run.v2.TaskTemplate template = 5 [(.google.api.field_behavior) = REQUIRED];

Returns
Type Description
boolean

Whether the template field is set.

internalGetFieldAccessorTable()

protected GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
Returns
Type Description
FieldAccessorTable
Overrides

internalGetMapFieldReflection(int number)

protected MapFieldReflectionAccessor internalGetMapFieldReflection(int number)
Parameter
Name Description
number int
Returns
Type Description
com.google.protobuf.MapFieldReflectionAccessor
Overrides
com.google.protobuf.GeneratedMessageV3.Builder.internalGetMapFieldReflection(int)

internalGetMutableMapFieldReflection(int number)

protected MapFieldReflectionAccessor internalGetMutableMapFieldReflection(int number)
Parameter
Name Description
number int
Returns
Type Description
com.google.protobuf.MapFieldReflectionAccessor
Overrides
com.google.protobuf.GeneratedMessageV3.Builder.internalGetMutableMapFieldReflection(int)

isInitialized()

public final boolean isInitialized()
Returns
Type Description
boolean
Overrides

mergeFrom(ExecutionTemplate other)

public ExecutionTemplate.Builder mergeFrom(ExecutionTemplate other)
Parameter
Name Description
other ExecutionTemplate
Returns
Type Description
ExecutionTemplate.Builder

mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

public ExecutionTemplate.Builder mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
input CodedInputStream
extensionRegistry ExtensionRegistryLite
Returns
Type Description
ExecutionTemplate.Builder
Overrides
Exceptions
Type Description
IOException

mergeFrom(Message other)

public ExecutionTemplate.Builder mergeFrom(Message other)
Parameter
Name Description
other Message
Returns
Type Description
ExecutionTemplate.Builder
Overrides

mergeTemplate(TaskTemplate value)

public ExecutionTemplate.Builder mergeTemplate(TaskTemplate value)

Required. Describes the task(s) that will be created when executing an execution.

.google.cloud.run.v2.TaskTemplate template = 5 [(.google.api.field_behavior) = REQUIRED];

Parameter
Name Description
value TaskTemplate
Returns
Type Description
ExecutionTemplate.Builder

mergeUnknownFields(UnknownFieldSet unknownFields)

public final ExecutionTemplate.Builder mergeUnknownFields(UnknownFieldSet unknownFields)
Parameter
Name Description
unknownFields UnknownFieldSet
Returns
Type Description
ExecutionTemplate.Builder
Overrides

putAllAnnotations(Map<String,String> values)

public ExecutionTemplate.Builder putAllAnnotations(Map<String,String> values)

Unstructured key value map that may be set by external tools to store and arbitrary metadata. They are not queryable and should be preserved when modifying objects.

<p>Cloud Run API v2 does not support annotations with run.googleapis.com, cloud.googleapis.com, serving.knative.dev, or autoscaling.knative.dev namespaces, and they will be rejected. All system annotations in v1 now have a corresponding field in v2 ExecutionTemplate.

<p>This field follows Kubernetes annotations' namespacing, limits, and rules.

map<string, string> annotations = 2;

Parameter
Name Description
values Map<String,String>
Returns
Type Description
ExecutionTemplate.Builder

putAllLabels(Map<String,String> values)

public ExecutionTemplate.Builder putAllLabels(Map<String,String> values)

Unstructured key value map that can be used to organize and categorize objects. User-provided labels are shared with Google's billing system, so they can be used to filter, or break down billing charges by team, component, environment, state, etc. For more information, visit https://cloud.google.com/resource-manager/docs/creating-managing-labels or https://cloud.google.com/run/docs/configuring/labels.

<p>Cloud Run API v2 does not support labels with run.googleapis.com, cloud.googleapis.com, serving.knative.dev, or autoscaling.knative.dev namespaces, and they will be rejected. All system labels in v1 now have a corresponding field in v2 ExecutionTemplate.

map<string, string> labels = 1;

Parameter
Name Description
values Map<String,String>
Returns
Type Description
ExecutionTemplate.Builder

putAnnotations(String key, String value)

public ExecutionTemplate.Builder putAnnotations(String key, String value)

Unstructured key value map that may be set by external tools to store and arbitrary metadata. They are not queryable and should be preserved when modifying objects.

<p>Cloud Run API v2 does not support annotations with run.googleapis.com, cloud.googleapis.com, serving.knative.dev, or autoscaling.knative.dev namespaces, and they will be rejected. All system annotations in v1 now have a corresponding field in v2 ExecutionTemplate.

<p>This field follows Kubernetes annotations' namespacing, limits, and rules.

map<string, string> annotations = 2;

Parameters
Name Description
key String
value String
Returns
Type Description
ExecutionTemplate.Builder

putLabels(String key, String value)

public ExecutionTemplate.Builder putLabels(String key, String value)

Unstructured key value map that can be used to organize and categorize objects. User-provided labels are shared with Google's billing system, so they can be used to filter, or break down billing charges by team, component, environment, state, etc. For more information, visit https://cloud.google.com/resource-manager/docs/creating-managing-labels or https://cloud.google.com/run/docs/configuring/labels.

<p>Cloud Run API v2 does not support labels with run.googleapis.com, cloud.googleapis.com, serving.knative.dev, or autoscaling.knative.dev namespaces, and they will be rejected. All system labels in v1 now have a corresponding field in v2 ExecutionTemplate.

map<string, string> labels = 1;

Parameters
Name Description
key String
value String
Returns
Type Description
ExecutionTemplate.Builder

removeAnnotations(String key)

public ExecutionTemplate.Builder removeAnnotations(String key)

Unstructured key value map that may be set by external tools to store and arbitrary metadata. They are not queryable and should be preserved when modifying objects.

<p>Cloud Run API v2 does not support annotations with run.googleapis.com, cloud.googleapis.com, serving.knative.dev, or autoscaling.knative.dev namespaces, and they will be rejected. All system annotations in v1 now have a corresponding field in v2 ExecutionTemplate.

<p>This field follows Kubernetes annotations' namespacing, limits, and rules.

map<string, string> annotations = 2;

Parameter
Name Description
key String
Returns
Type Description
ExecutionTemplate.Builder

removeLabels(String key)

public ExecutionTemplate.Builder removeLabels(String key)

Unstructured key value map that can be used to organize and categorize objects. User-provided labels are shared with Google's billing system, so they can be used to filter, or break down billing charges by team, component, environment, state, etc. For more information, visit https://cloud.google.com/resource-manager/docs/creating-managing-labels or https://cloud.google.com/run/docs/configuring/labels.

<p>Cloud Run API v2 does not support labels with run.googleapis.com, cloud.googleapis.com, serving.knative.dev, or autoscaling.knative.dev namespaces, and they will be rejected. All system labels in v1 now have a corresponding field in v2 ExecutionTemplate.

map<string, string> labels = 1;

Parameter
Name Description
key String
Returns
Type Description
ExecutionTemplate.Builder

setField(Descriptors.FieldDescriptor field, Object value)

public ExecutionTemplate.Builder setField(Descriptors.FieldDescriptor field, Object value)
Parameters
Name Description
field FieldDescriptor
value Object
Returns
Type Description
ExecutionTemplate.Builder
Overrides

setParallelism(int value)

public ExecutionTemplate.Builder setParallelism(int value)

Specifies the maximum desired number of tasks the execution should run at given time. Must be <= task_count. When the job is run, if this field is 0 or unset, the maximum possible value will be used for that execution. The actual number of tasks running in steady state will be less than this number when there are fewer tasks waiting to be completed remaining, i.e. when the work left to do is less than max parallelism.

int32 parallelism = 3;

Parameter
Name Description
value int

The parallelism to set.
Returns
Type Description
ExecutionTemplate.Builder

This builder for chaining.

setRepeatedField(Descriptors.FieldDescriptor field, int index, Object value)

public ExecutionTemplate.Builder setRepeatedField(Descriptors.FieldDescriptor field, int index, Object value)
Parameters
Name Description
field FieldDescriptor
index int
value Object
Returns
Type Description
ExecutionTemplate.Builder
Overrides

setTaskCount(int value)

public ExecutionTemplate.Builder setTaskCount(int value)

Specifies the desired number of tasks the execution should run. Setting to 1 means that parallelism is limited to 1 and the success of that task signals the success of the execution. Defaults to 1.

int32 task_count = 4;

Parameter
Name Description
value int

The taskCount to set.
Returns
Type Description
ExecutionTemplate.Builder

This builder for chaining.

setTemplate(TaskTemplate value)

public ExecutionTemplate.Builder setTemplate(TaskTemplate value)

Required. Describes the task(s) that will be created when executing an execution.

.google.cloud.run.v2.TaskTemplate template = 5 [(.google.api.field_behavior) = REQUIRED];

Parameter
Name Description
value TaskTemplate
Returns
Type Description
ExecutionTemplate.Builder

setTemplate(TaskTemplate.Builder builderForValue)

public ExecutionTemplate.Builder setTemplate(TaskTemplate.Builder builderForValue)

Required. Describes the task(s) that will be created when executing an execution.

.google.cloud.run.v2.TaskTemplate template = 5 [(.google.api.field_behavior) = REQUIRED];

Parameter
Name Description
builderForValue TaskTemplate.Builder
Returns
Type Description
ExecutionTemplate.Builder

setUnknownFields(UnknownFieldSet unknownFields)

public final ExecutionTemplate.Builder setUnknownFields(UnknownFieldSet unknownFields)
Parameter
Name Description
unknownFields UnknownFieldSet
Returns
Type Description
ExecutionTemplate.Builder
Overrides