- 0.53.0 (latest)
- 0.52.0
- 0.51.0
- 0.49.0
- 0.48.0
- 0.47.0
- 0.46.0
- 0.45.0
- 0.44.0
- 0.43.0
- 0.42.0
- 0.41.0
- 0.40.0
- 0.39.0
- 0.37.0
- 0.36.0
- 0.35.0
- 0.34.0
- 0.33.0
- 0.32.0
- 0.31.0
- 0.30.0
- 0.29.0
- 0.28.0
- 0.27.0
- 0.24.0
- 0.23.0
- 0.22.0
- 0.21.0
- 0.20.0
- 0.19.0
- 0.18.0
- 0.17.0
- 0.16.0
- 0.15.0
- 0.14.0
- 0.13.0
- 0.12.0
- 0.11.0
- 0.9.0
- 0.8.0
- 0.7.0
- 0.6.0
- 0.5.0
- 0.4.0
- 0.3.5
- 0.2.1
- 0.1.2
public static final class Job.Builder extends GeneratedMessageV3.Builder<Job.Builder> implements JobOrBuilderJob represents the configuration of a single job, which references a container image that is run to completion.
Protobuf type google.cloud.run.v2.Job
Inheritance
Object > AbstractMessageLite.Builder<MessageType,BuilderType> > AbstractMessage.Builder<BuilderType> > GeneratedMessageV3.Builder > Job.BuilderImplements
JobOrBuilderStatic Methods
getDescriptor()
public static final Descriptors.Descriptor getDescriptor()| Returns | |
|---|---|
| Type | Description |
Descriptor | |
Methods
addAllConditions(Iterable<? extends Condition> values)
public Job.Builder addAllConditions(Iterable<? extends Condition> values) Output only. The Conditions of all other associated sub-resources. They
contain additional diagnostics information in case the Job does not reach
its desired state. See comments in reconciling for additional information
on reconciliation process in Cloud Run.
repeated .google.cloud.run.v2.Condition conditions = 19 [(.google.api.field_behavior) = OUTPUT_ONLY];
| Parameter | |
|---|---|
| Name | Description |
values | Iterable<? extends com.google.cloud.run.v2.Condition> |
| Returns | |
|---|---|
| Type | Description |
Job.Builder | |
addConditions(Condition value)
public Job.Builder addConditions(Condition value) Output only. The Conditions of all other associated sub-resources. They
contain additional diagnostics information in case the Job does not reach
its desired state. See comments in reconciling for additional information
on reconciliation process in Cloud Run.
repeated .google.cloud.run.v2.Condition conditions = 19 [(.google.api.field_behavior) = OUTPUT_ONLY];
| Parameter | |
|---|---|
| Name | Description |
value | Condition |
| Returns | |
|---|---|
| Type | Description |
Job.Builder | |
addConditions(Condition.Builder builderForValue)
public Job.Builder addConditions(Condition.Builder builderForValue) Output only. The Conditions of all other associated sub-resources. They
contain additional diagnostics information in case the Job does not reach
its desired state. See comments in reconciling for additional information
on reconciliation process in Cloud Run.
repeated .google.cloud.run.v2.Condition conditions = 19 [(.google.api.field_behavior) = OUTPUT_ONLY];
| Parameter | |
|---|---|
| Name | Description |
builderForValue | Condition.Builder |
| Returns | |
|---|---|
| Type | Description |
Job.Builder | |
addConditions(int index, Condition value)
public Job.Builder addConditions(int index, Condition value) Output only. The Conditions of all other associated sub-resources. They
contain additional diagnostics information in case the Job does not reach
its desired state. See comments in reconciling for additional information
on reconciliation process in Cloud Run.
repeated .google.cloud.run.v2.Condition conditions = 19 [(.google.api.field_behavior) = OUTPUT_ONLY];
| Parameters | |
|---|---|
| Name | Description |
index | int |
value | Condition |
| Returns | |
|---|---|
| Type | Description |
Job.Builder | |
addConditions(int index, Condition.Builder builderForValue)
public Job.Builder addConditions(int index, Condition.Builder builderForValue) Output only. The Conditions of all other associated sub-resources. They
contain additional diagnostics information in case the Job does not reach
its desired state. See comments in reconciling for additional information
on reconciliation process in Cloud Run.
repeated .google.cloud.run.v2.Condition conditions = 19 [(.google.api.field_behavior) = OUTPUT_ONLY];
| Parameters | |
|---|---|
| Name | Description |
index | int |
builderForValue | Condition.Builder |
| Returns | |
|---|---|
| Type | Description |
Job.Builder | |
addConditionsBuilder()
public Condition.Builder addConditionsBuilder() Output only. The Conditions of all other associated sub-resources. They
contain additional diagnostics information in case the Job does not reach
its desired state. See comments in reconciling for additional information
on reconciliation process in Cloud Run.
repeated .google.cloud.run.v2.Condition conditions = 19 [(.google.api.field_behavior) = OUTPUT_ONLY];
| Returns | |
|---|---|
| Type | Description |
Condition.Builder | |
addConditionsBuilder(int index)
public Condition.Builder addConditionsBuilder(int index) Output only. The Conditions of all other associated sub-resources. They
contain additional diagnostics information in case the Job does not reach
its desired state. See comments in reconciling for additional information
on reconciliation process in Cloud Run.
repeated .google.cloud.run.v2.Condition conditions = 19 [(.google.api.field_behavior) = OUTPUT_ONLY];
| Parameter | |
|---|---|
| Name | Description |
index | int |
| Returns | |
|---|---|
| Type | Description |
Condition.Builder | |
addRepeatedField(Descriptors.FieldDescriptor field, Object value)
public Job.Builder addRepeatedField(Descriptors.FieldDescriptor field, Object value)| Parameters | |
|---|---|
| Name | Description |
field | FieldDescriptor |
value | Object |
| Returns | |
|---|---|
| Type | Description |
Job.Builder | |
build()
public Job build()| Returns | |
|---|---|
| Type | Description |
Job | |
buildPartial()
public Job buildPartial()| Returns | |
|---|---|
| Type | Description |
Job | |
clear()
public Job.Builder clear()| Returns | |
|---|---|
| Type | Description |
Job.Builder | |
clearAnnotations()
public Job.Builder clearAnnotations()| Returns | |
|---|---|
| Type | Description |
Job.Builder | |
clearBinaryAuthorization()
public Job.Builder clearBinaryAuthorization()Settings for the Binary Authorization feature.
.google.cloud.run.v2.BinaryAuthorization binary_authorization = 15;
| Returns | |
|---|---|
| Type | Description |
Job.Builder | |
clearClient()
public Job.Builder clearClient()Arbitrary identifier for the API client.
string client = 12;
| Returns | |
|---|---|
| Type | Description |
Job.Builder | This builder for chaining. |
clearClientVersion()
public Job.Builder clearClientVersion()Arbitrary version identifier for the API client.
string client_version = 13;
| Returns | |
|---|---|
| Type | Description |
Job.Builder | This builder for chaining. |
clearConditions()
public Job.Builder clearConditions() Output only. The Conditions of all other associated sub-resources. They
contain additional diagnostics information in case the Job does not reach
its desired state. See comments in reconciling for additional information
on reconciliation process in Cloud Run.
repeated .google.cloud.run.v2.Condition conditions = 19 [(.google.api.field_behavior) = OUTPUT_ONLY];
| Returns | |
|---|---|
| Type | Description |
Job.Builder | |
clearCreateTime()
public Job.Builder clearCreateTime()Output only. The creation time.
.google.protobuf.Timestamp create_time = 6 [(.google.api.field_behavior) = OUTPUT_ONLY];
| Returns | |
|---|---|
| Type | Description |
Job.Builder | |
clearCreator()
public Job.Builder clearCreator()Output only. Email address of the authenticated creator.
string creator = 10 [(.google.api.field_behavior) = OUTPUT_ONLY];
| Returns | |
|---|---|
| Type | Description |
Job.Builder | This builder for chaining. |
clearDeleteTime()
public Job.Builder clearDeleteTime()Output only. The deletion time.
.google.protobuf.Timestamp delete_time = 8 [(.google.api.field_behavior) = OUTPUT_ONLY];
| Returns | |
|---|---|
| Type | Description |
Job.Builder | |
clearEtag()
public Job.Builder clearEtag()Output only. A system-generated fingerprint for this version of the resource. May be used to detect modification conflict during updates.
string etag = 99 [(.google.api.field_behavior) = OUTPUT_ONLY];
| Returns | |
|---|---|
| Type | Description |
Job.Builder | This builder for chaining. |
clearExecutionCount()
public Job.Builder clearExecutionCount()Output only. Number of executions created for this job.
int32 execution_count = 20 [(.google.api.field_behavior) = OUTPUT_ONLY];
| Returns | |
|---|---|
| Type | Description |
Job.Builder | This builder for chaining. |
clearExpireTime()
public Job.Builder clearExpireTime()Output only. For a deleted resource, the time after which it will be permamently deleted.
.google.protobuf.Timestamp expire_time = 9 [(.google.api.field_behavior) = OUTPUT_ONLY];
| Returns | |
|---|---|
| Type | Description |
Job.Builder | |
clearField(Descriptors.FieldDescriptor field)
public Job.Builder clearField(Descriptors.FieldDescriptor field)| Parameter | |
|---|---|
| Name | Description |
field | FieldDescriptor |
| Returns | |
|---|---|
| Type | Description |
Job.Builder | |
clearGeneration()
public Job.Builder clearGeneration()Output only. A number that monotonically increases every time the user modifies the desired state.
int64 generation = 3 [(.google.api.field_behavior) = OUTPUT_ONLY];
| Returns | |
|---|---|
| Type | Description |
Job.Builder | This builder for chaining. |
clearLabels()
public Job.Builder clearLabels()| Returns | |
|---|---|
| Type | Description |
Job.Builder | |
clearLastModifier()
public Job.Builder clearLastModifier()Output only. Email address of the last authenticated modifier.
string last_modifier = 11 [(.google.api.field_behavior) = OUTPUT_ONLY];
| Returns | |
|---|---|
| Type | Description |
Job.Builder | This builder for chaining. |
clearLatestCreatedExecution()
public Job.Builder clearLatestCreatedExecution()Output only. Name of the last created execution.
.google.cloud.run.v2.ExecutionReference latest_created_execution = 22 [(.google.api.field_behavior) = OUTPUT_ONLY];
| Returns | |
|---|---|
| Type | Description |
Job.Builder | |
clearLaunchStage()
public Job.Builder clearLaunchStage() The launch stage as defined by Google Cloud Platform
Launch Stages.
Cloud Run supports ALPHA, BETA, and GA. If no value is specified, GA
is assumed.
Set the launch stage to a preview stage on input to allow use of preview
features in that stage. On read (or output), describes whether the resource
uses preview features.
<p>
For example, if ALPHA is provided as input, but only BETA and GA-level
features are used, this field will be BETA on output.
.google.api.LaunchStage launch_stage = 14;
| Returns | |
|---|---|
| Type | Description |
Job.Builder | This builder for chaining. |
clearName()
public Job.Builder clearName()The fully qualified name of this Job. Format: projects/{project}/locations/{location}/jobs/{job}
string name = 1;
| Returns | |
|---|---|
| Type | Description |
Job.Builder | This builder for chaining. |
clearObservedGeneration()
public Job.Builder clearObservedGeneration() Output only. The generation of this Job. See comments in reconciling for
additional information on reconciliation process in Cloud Run.
int64 observed_generation = 17 [(.google.api.field_behavior) = OUTPUT_ONLY];
| Returns | |
|---|---|
| Type | Description |
Job.Builder | This builder for chaining. |
clearOneof(Descriptors.OneofDescriptor oneof)
public Job.Builder clearOneof(Descriptors.OneofDescriptor oneof)| Parameter | |
|---|---|
| Name | Description |
oneof | OneofDescriptor |
| Returns | |
|---|---|
| Type | Description |
Job.Builder | |
clearReconciling()
public Job.Builder clearReconciling() Output only. Returns true if the Job is currently being acted upon by the
system to bring it into the desired state.
When a new Job is created, or an existing one is updated, Cloud Run
will asynchronously perform all necessary steps to bring the Job to the
desired state. This process is called reconciliation.
While reconciliation is in process, observed_generation and
latest_succeeded_execution, will have transient values that might
mismatch the intended state: Once reconciliation is over (and this field is
false), there are two possible outcomes: reconciliation succeeded and the
state matches the Job, or there was an error, and reconciliation failed.
This state can be found in terminal_condition.state.
If reconciliation succeeded, the following fields will match:
observed_generation and generation, latest_succeeded_execution and
latest_created_execution.
If reconciliation failed, observed_generation and
latest_succeeded_execution will have the state of the last succeeded
execution or empty for newly created Job. Additional information on the
failure can be found in terminal_condition and conditions.
bool reconciling = 23 [(.google.api.field_behavior) = OUTPUT_ONLY];
| Returns | |
|---|---|
| Type | Description |
Job.Builder | This builder for chaining. |
clearSatisfiesPzs()
public Job.Builder clearSatisfiesPzs()Output only. Reserved for future use.
bool satisfies_pzs = 25 [(.google.api.field_behavior) = OUTPUT_ONLY];
| Returns | |
|---|---|
| Type | Description |
Job.Builder | This builder for chaining. |
clearTemplate()
public Job.Builder clearTemplate()Required. The template used to create executions for this Job.
.google.cloud.run.v2.ExecutionTemplate template = 16 [(.google.api.field_behavior) = REQUIRED];
| Returns | |
|---|---|
| Type | Description |
Job.Builder | |
clearTerminalCondition()
public Job.Builder clearTerminalCondition()Output only. The Condition of this Job, containing its readiness status, and detailed error information in case it did not reach the desired state.
.google.cloud.run.v2.Condition terminal_condition = 18 [(.google.api.field_behavior) = OUTPUT_ONLY];
| Returns | |
|---|---|
| Type | Description |
Job.Builder | |
clearUid()
public Job.Builder clearUid()Output only. Server assigned unique identifier for the Execution. The value is a UUID4 string and guaranteed to remain unchanged until the resource is deleted.
string uid = 2 [(.google.api.field_behavior) = OUTPUT_ONLY];
| Returns | |
|---|---|
| Type | Description |
Job.Builder | This builder for chaining. |
clearUpdateTime()
public Job.Builder clearUpdateTime()Output only. The last-modified time.
.google.protobuf.Timestamp update_time = 7 [(.google.api.field_behavior) = OUTPUT_ONLY];
| Returns | |
|---|---|
| Type | Description |
Job.Builder | |
clone()
public Job.Builder clone()| Returns | |
|---|---|
| Type | Description |
Job.Builder | |
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 on new resources. All system
annotations in v1 now have a corresponding field in v2 Job.
<p>This field follows Kubernetes annotations' namespacing, limits, and
rules.
map<string, string> annotations = 5;
| 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 Job.
map<string, string> labels = 4;
| Parameter | |
|---|---|
| Name | Description |
key | String |
| Returns | |
|---|---|
| Type | Description |
boolean | |
getAnnotations()
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 on new resources. All system
annotations in v1 now have a corresponding field in v2 Job.
<p>This field follows Kubernetes annotations' namespacing, limits, and
rules.
map<string, string> annotations = 5;
| 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 on new resources. All system
annotations in v1 now have a corresponding field in v2 Job.
<p>This field follows Kubernetes annotations' namespacing, limits, and
rules.
map<string, string> annotations = 5;
| 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 on new resources. All system
annotations in v1 now have a corresponding field in v2 Job.
<p>This field follows Kubernetes annotations' namespacing, limits, and
rules.
map<string, string> annotations = 5;
| 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 on new resources. All system
annotations in v1 now have a corresponding field in v2 Job.
<p>This field follows Kubernetes annotations' namespacing, limits, and
rules.
map<string, string> annotations = 5;
| Parameter | |
|---|---|
| Name | Description |
key | String |
| Returns | |
|---|---|
| Type | Description |
String | |
getBinaryAuthorization()
public BinaryAuthorization getBinaryAuthorization()Settings for the Binary Authorization feature.
.google.cloud.run.v2.BinaryAuthorization binary_authorization = 15;
| Returns | |
|---|---|
| Type | Description |
BinaryAuthorization | The binaryAuthorization. |
getBinaryAuthorizationBuilder()
public BinaryAuthorization.Builder getBinaryAuthorizationBuilder()Settings for the Binary Authorization feature.
.google.cloud.run.v2.BinaryAuthorization binary_authorization = 15;
| Returns | |
|---|---|
| Type | Description |
BinaryAuthorization.Builder | |
getBinaryAuthorizationOrBuilder()
public BinaryAuthorizationOrBuilder getBinaryAuthorizationOrBuilder()Settings for the Binary Authorization feature.
.google.cloud.run.v2.BinaryAuthorization binary_authorization = 15;
| Returns | |
|---|---|
| Type | Description |
BinaryAuthorizationOrBuilder | |
getClient()
public String getClient()Arbitrary identifier for the API client.
string client = 12;
| Returns | |
|---|---|
| Type | Description |
String | The client. |
getClientBytes()
public ByteString getClientBytes()Arbitrary identifier for the API client.
string client = 12;
| Returns | |
|---|---|
| Type | Description |
ByteString | The bytes for client. |
getClientVersion()
public String getClientVersion()Arbitrary version identifier for the API client.
string client_version = 13;
| Returns | |
|---|---|
| Type | Description |
String | The clientVersion. |
getClientVersionBytes()
public ByteString getClientVersionBytes()Arbitrary version identifier for the API client.
string client_version = 13;
| Returns | |
|---|---|
| Type | Description |
ByteString | The bytes for clientVersion. |
getConditions(int index)
public Condition getConditions(int index) Output only. The Conditions of all other associated sub-resources. They
contain additional diagnostics information in case the Job does not reach
its desired state. See comments in reconciling for additional information
on reconciliation process in Cloud Run.
repeated .google.cloud.run.v2.Condition conditions = 19 [(.google.api.field_behavior) = OUTPUT_ONLY];
| Parameter | |
|---|---|
| Name | Description |
index | int |
| Returns | |
|---|---|
| Type | Description |
Condition | |
getConditionsBuilder(int index)
public Condition.Builder getConditionsBuilder(int index) Output only. The Conditions of all other associated sub-resources. They
contain additional diagnostics information in case the Job does not reach
its desired state. See comments in reconciling for additional information
on reconciliation process in Cloud Run.
repeated .google.cloud.run.v2.Condition conditions = 19 [(.google.api.field_behavior) = OUTPUT_ONLY];
| Parameter | |
|---|---|
| Name | Description |
index | int |
| Returns | |
|---|---|
| Type | Description |
Condition.Builder | |
getConditionsBuilderList()
public List<Condition.Builder> getConditionsBuilderList() Output only. The Conditions of all other associated sub-resources. They
contain additional diagnostics information in case the Job does not reach
its desired state. See comments in reconciling for additional information
on reconciliation process in Cloud Run.
repeated .google.cloud.run.v2.Condition conditions = 19 [(.google.api.field_behavior) = OUTPUT_ONLY];
| Returns | |
|---|---|
| Type | Description |
List<Builder> | |
getConditionsCount()
public int getConditionsCount() Output only. The Conditions of all other associated sub-resources. They
contain additional diagnostics information in case the Job does not reach
its desired state. See comments in reconciling for additional information
on reconciliation process in Cloud Run.
repeated .google.cloud.run.v2.Condition conditions = 19 [(.google.api.field_behavior) = OUTPUT_ONLY];
| Returns | |
|---|---|
| Type | Description |
int | |
getConditionsList()
public List<Condition> getConditionsList() Output only. The Conditions of all other associated sub-resources. They
contain additional diagnostics information in case the Job does not reach
its desired state. See comments in reconciling for additional information
on reconciliation process in Cloud Run.
repeated .google.cloud.run.v2.Condition conditions = 19 [(.google.api.field_behavior) = OUTPUT_ONLY];
| Returns | |
|---|---|
| Type | Description |
List<Condition> | |
getConditionsOrBuilder(int index)
public ConditionOrBuilder getConditionsOrBuilder(int index) Output only. The Conditions of all other associated sub-resources. They
contain additional diagnostics information in case the Job does not reach
its desired state. See comments in reconciling for additional information
on reconciliation process in Cloud Run.
repeated .google.cloud.run.v2.Condition conditions = 19 [(.google.api.field_behavior) = OUTPUT_ONLY];
| Parameter | |
|---|---|
| Name | Description |
index | int |
| Returns | |
|---|---|
| Type | Description |
ConditionOrBuilder | |
getConditionsOrBuilderList()
public List<? extends ConditionOrBuilder> getConditionsOrBuilderList() Output only. The Conditions of all other associated sub-resources. They
contain additional diagnostics information in case the Job does not reach
its desired state. See comments in reconciling for additional information
on reconciliation process in Cloud Run.
repeated .google.cloud.run.v2.Condition conditions = 19 [(.google.api.field_behavior) = OUTPUT_ONLY];
| Returns | |
|---|---|
| Type | Description |
List<? extends com.google.cloud.run.v2.ConditionOrBuilder> | |
getCreateTime()
public Timestamp getCreateTime()Output only. The creation time.
.google.protobuf.Timestamp create_time = 6 [(.google.api.field_behavior) = OUTPUT_ONLY];
| Returns | |
|---|---|
| Type | Description |
Timestamp | The createTime. |
getCreateTimeBuilder()
public Timestamp.Builder getCreateTimeBuilder()Output only. The creation time.
.google.protobuf.Timestamp create_time = 6 [(.google.api.field_behavior) = OUTPUT_ONLY];
| Returns | |
|---|---|
| Type | Description |
Builder | |
getCreateTimeOrBuilder()
public TimestampOrBuilder getCreateTimeOrBuilder()Output only. The creation time.
.google.protobuf.Timestamp create_time = 6 [(.google.api.field_behavior) = OUTPUT_ONLY];
| Returns | |
|---|---|
| Type | Description |
TimestampOrBuilder | |
getCreator()
public String getCreator()Output only. Email address of the authenticated creator.
string creator = 10 [(.google.api.field_behavior) = OUTPUT_ONLY];
| Returns | |
|---|---|
| Type | Description |
String | The creator. |
getCreatorBytes()
public ByteString getCreatorBytes()Output only. Email address of the authenticated creator.
string creator = 10 [(.google.api.field_behavior) = OUTPUT_ONLY];
| Returns | |
|---|---|
| Type | Description |
ByteString | The bytes for creator. |
getDefaultInstanceForType()
public Job getDefaultInstanceForType()| Returns | |
|---|---|
| Type | Description |
Job | |
getDeleteTime()
public Timestamp getDeleteTime()Output only. The deletion time.
.google.protobuf.Timestamp delete_time = 8 [(.google.api.field_behavior) = OUTPUT_ONLY];
| Returns | |
|---|---|
| Type | Description |
Timestamp | The deleteTime. |
getDeleteTimeBuilder()
public Timestamp.Builder getDeleteTimeBuilder()Output only. The deletion time.
.google.protobuf.Timestamp delete_time = 8 [(.google.api.field_behavior) = OUTPUT_ONLY];
| Returns | |
|---|---|
| Type | Description |
Builder | |
getDeleteTimeOrBuilder()
public TimestampOrBuilder getDeleteTimeOrBuilder()Output only. The deletion time.
.google.protobuf.Timestamp delete_time = 8 [(.google.api.field_behavior) = OUTPUT_ONLY];
| Returns | |
|---|---|
| Type | Description |
TimestampOrBuilder | |
getDescriptorForType()
public Descriptors.Descriptor getDescriptorForType()| Returns | |
|---|---|
| Type | Description |
Descriptor | |
getEtag()
public String getEtag()Output only. A system-generated fingerprint for this version of the resource. May be used to detect modification conflict during updates.
string etag = 99 [(.google.api.field_behavior) = OUTPUT_ONLY];
| Returns | |
|---|---|
| Type | Description |
String | The etag. |
getEtagBytes()
public ByteString getEtagBytes()Output only. A system-generated fingerprint for this version of the resource. May be used to detect modification conflict during updates.
string etag = 99 [(.google.api.field_behavior) = OUTPUT_ONLY];
| Returns | |
|---|---|
| Type | Description |
ByteString | The bytes for etag. |
getExecutionCount()
public int getExecutionCount()Output only. Number of executions created for this job.
int32 execution_count = 20 [(.google.api.field_behavior) = OUTPUT_ONLY];
| Returns | |
|---|---|
| Type | Description |
int | The executionCount. |
getExpireTime()
public Timestamp getExpireTime()Output only. For a deleted resource, the time after which it will be permamently deleted.
.google.protobuf.Timestamp expire_time = 9 [(.google.api.field_behavior) = OUTPUT_ONLY];
| Returns | |
|---|---|
| Type | Description |
Timestamp | The expireTime. |
getExpireTimeBuilder()
public Timestamp.Builder getExpireTimeBuilder()Output only. For a deleted resource, the time after which it will be permamently deleted.
.google.protobuf.Timestamp expire_time = 9 [(.google.api.field_behavior) = OUTPUT_ONLY];
| Returns | |
|---|---|
| Type | Description |
Builder | |
getExpireTimeOrBuilder()
public TimestampOrBuilder getExpireTimeOrBuilder()Output only. For a deleted resource, the time after which it will be permamently deleted.
.google.protobuf.Timestamp expire_time = 9 [(.google.api.field_behavior) = OUTPUT_ONLY];
| Returns | |
|---|---|
| Type | Description |
TimestampOrBuilder | |
getGeneration()
public long getGeneration()Output only. A number that monotonically increases every time the user modifies the desired state.
int64 generation = 3 [(.google.api.field_behavior) = OUTPUT_ONLY];
| Returns | |
|---|---|
| Type | Description |
long | The generation. |
getLabels()
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 Job.
map<string, string> labels = 4;
| 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 Job.
map<string, string> labels = 4;
| 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 Job.
map<string, string> labels = 4;
| 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 Job.
map<string, string> labels = 4;
| Parameter | |
|---|---|
| Name | Description |
key | String |
| Returns | |
|---|---|
| Type | Description |
String | |
getLastModifier()
public String getLastModifier()Output only. Email address of the last authenticated modifier.
string last_modifier = 11 [(.google.api.field_behavior) = OUTPUT_ONLY];
| Returns | |
|---|---|
| Type | Description |
String | The lastModifier. |
getLastModifierBytes()
public ByteString getLastModifierBytes()Output only. Email address of the last authenticated modifier.
string last_modifier = 11 [(.google.api.field_behavior) = OUTPUT_ONLY];
| Returns | |
|---|---|
| Type | Description |
ByteString | The bytes for lastModifier. |
getLatestCreatedExecution()
public ExecutionReference getLatestCreatedExecution()Output only. Name of the last created execution.
.google.cloud.run.v2.ExecutionReference latest_created_execution = 22 [(.google.api.field_behavior) = OUTPUT_ONLY];
| Returns | |
|---|---|
| Type | Description |
ExecutionReference | The latestCreatedExecution. |
getLatestCreatedExecutionBuilder()
public ExecutionReference.Builder getLatestCreatedExecutionBuilder()Output only. Name of the last created execution.
.google.cloud.run.v2.ExecutionReference latest_created_execution = 22 [(.google.api.field_behavior) = OUTPUT_ONLY];
| Returns | |
|---|---|
| Type | Description |
ExecutionReference.Builder | |
getLatestCreatedExecutionOrBuilder()
public ExecutionReferenceOrBuilder getLatestCreatedExecutionOrBuilder()Output only. Name of the last created execution.
.google.cloud.run.v2.ExecutionReference latest_created_execution = 22 [(.google.api.field_behavior) = OUTPUT_ONLY];
| Returns | |
|---|---|
| Type | Description |
ExecutionReferenceOrBuilder | |
getLaunchStage()
public LaunchStage getLaunchStage() The launch stage as defined by Google Cloud Platform
Launch Stages.
Cloud Run supports ALPHA, BETA, and GA. If no value is specified, GA
is assumed.
Set the launch stage to a preview stage on input to allow use of preview
features in that stage. On read (or output), describes whether the resource
uses preview features.
<p>
For example, if ALPHA is provided as input, but only BETA and GA-level
features are used, this field will be BETA on output.
.google.api.LaunchStage launch_stage = 14;
| Returns | |
|---|---|
| Type | Description |
com.google.api.LaunchStage | The launchStage. |
getLaunchStageValue()
public int getLaunchStageValue() The launch stage as defined by Google Cloud Platform
Launch Stages.
Cloud Run supports ALPHA, BETA, and GA. If no value is specified, GA
is assumed.
Set the launch stage to a preview stage on input to allow use of preview
features in that stage. On read (or output), describes whether the resource
uses preview features.
<p>
For example, if ALPHA is provided as input, but only BETA and GA-level
features are used, this field will be BETA on output.
.google.api.LaunchStage launch_stage = 14;
| Returns | |
|---|---|
| Type | Description |
int | The enum numeric value on the wire for launchStage. |
getMutableAnnotations()
public Map<String,String> getMutableAnnotations()Use alternate mutation accessors instead.
| Returns | |
|---|---|
| Type | Description |
Map<String,String> | |
getMutableLabels()
public Map<String,String> getMutableLabels()Use alternate mutation accessors instead.
| Returns | |
|---|---|
| Type | Description |
Map<String,String> | |
getName()
public String getName()The fully qualified name of this Job. Format: projects/{project}/locations/{location}/jobs/{job}
string name = 1;
| Returns | |
|---|---|
| Type | Description |
String | The name. |
getNameBytes()
public ByteString getNameBytes()The fully qualified name of this Job. Format: projects/{project}/locations/{location}/jobs/{job}
string name = 1;
| Returns | |
|---|---|
| Type | Description |
ByteString | The bytes for name. |
getObservedGeneration()
public long getObservedGeneration() Output only. The generation of this Job. See comments in reconciling for
additional information on reconciliation process in Cloud Run.
int64 observed_generation = 17 [(.google.api.field_behavior) = OUTPUT_ONLY];
| Returns | |
|---|---|
| Type | Description |
long | The observedGeneration. |
getReconciling()
public boolean getReconciling() Output only. Returns true if the Job is currently being acted upon by the
system to bring it into the desired state.
When a new Job is created, or an existing one is updated, Cloud Run
will asynchronously perform all necessary steps to bring the Job to the
desired state. This process is called reconciliation.
While reconciliation is in process, observed_generation and
latest_succeeded_execution, will have transient values that might
mismatch the intended state: Once reconciliation is over (and this field is
false), there are two possible outcomes: reconciliation succeeded and the
state matches the Job, or there was an error, and reconciliation failed.
This state can be found in terminal_condition.state.
If reconciliation succeeded, the following fields will match:
observed_generation and generation, latest_succeeded_execution and
latest_created_execution.
If reconciliation failed, observed_generation and
latest_succeeded_execution will have the state of the last succeeded
execution or empty for newly created Job. Additional information on the
failure can be found in terminal_condition and conditions.
bool reconciling = 23 [(.google.api.field_behavior) = OUTPUT_ONLY];
| Returns | |
|---|---|
| Type | Description |
boolean | The reconciling. |
getSatisfiesPzs()
public boolean getSatisfiesPzs()Output only. Reserved for future use.
bool satisfies_pzs = 25 [(.google.api.field_behavior) = OUTPUT_ONLY];
| Returns | |
|---|---|
| Type | Description |
boolean | The satisfiesPzs. |
getTemplate()
public ExecutionTemplate getTemplate()Required. The template used to create executions for this Job.
.google.cloud.run.v2.ExecutionTemplate template = 16 [(.google.api.field_behavior) = REQUIRED];
| Returns | |
|---|---|
| Type | Description |
ExecutionTemplate | The template. |
getTemplateBuilder()
public ExecutionTemplate.Builder getTemplateBuilder()Required. The template used to create executions for this Job.
.google.cloud.run.v2.ExecutionTemplate template = 16 [(.google.api.field_behavior) = REQUIRED];
| Returns | |
|---|---|
| Type | Description |
ExecutionTemplate.Builder | |
getTemplateOrBuilder()
public ExecutionTemplateOrBuilder getTemplateOrBuilder()Required. The template used to create executions for this Job.
.google.cloud.run.v2.ExecutionTemplate template = 16 [(.google.api.field_behavior) = REQUIRED];
| Returns | |
|---|---|
| Type | Description |
ExecutionTemplateOrBuilder | |
getTerminalCondition()
public Condition getTerminalCondition()Output only. The Condition of this Job, containing its readiness status, and detailed error information in case it did not reach the desired state.
.google.cloud.run.v2.Condition terminal_condition = 18 [(.google.api.field_behavior) = OUTPUT_ONLY];
| Returns | |
|---|---|
| Type | Description |
Condition | The terminalCondition. |
getTerminalConditionBuilder()
public Condition.Builder getTerminalConditionBuilder()Output only. The Condition of this Job, containing its readiness status, and detailed error information in case it did not reach the desired state.
.google.cloud.run.v2.Condition terminal_condition = 18 [(.google.api.field_behavior) = OUTPUT_ONLY];
| Returns | |
|---|---|
| Type | Description |
Condition.Builder | |
getTerminalConditionOrBuilder()
public ConditionOrBuilder getTerminalConditionOrBuilder()Output only. The Condition of this Job, containing its readiness status, and detailed error information in case it did not reach the desired state.
.google.cloud.run.v2.Condition terminal_condition = 18 [(.google.api.field_behavior) = OUTPUT_ONLY];
| Returns | |
|---|---|
| Type | Description |
ConditionOrBuilder | |
getUid()
public String getUid()Output only. Server assigned unique identifier for the Execution. The value is a UUID4 string and guaranteed to remain unchanged until the resource is deleted.
string uid = 2 [(.google.api.field_behavior) = OUTPUT_ONLY];
| Returns | |
|---|---|
| Type | Description |
String | The uid. |
getUidBytes()
public ByteString getUidBytes()Output only. Server assigned unique identifier for the Execution. The value is a UUID4 string and guaranteed to remain unchanged until the resource is deleted.
string uid = 2 [(.google.api.field_behavior) = OUTPUT_ONLY];
| Returns | |
|---|---|
| Type | Description |
ByteString | The bytes for uid. |
getUpdateTime()
public Timestamp getUpdateTime()Output only. The last-modified time.
.google.protobuf.Timestamp update_time = 7 [(.google.api.field_behavior) = OUTPUT_ONLY];
| Returns | |
|---|---|
| Type | Description |
Timestamp | The updateTime. |
getUpdateTimeBuilder()
public Timestamp.Builder getUpdateTimeBuilder()Output only. The last-modified time.
.google.protobuf.Timestamp update_time = 7 [(.google.api.field_behavior) = OUTPUT_ONLY];
| Returns | |
|---|---|
| Type | Description |
Builder | |
getUpdateTimeOrBuilder()
public TimestampOrBuilder getUpdateTimeOrBuilder()Output only. The last-modified time.
.google.protobuf.Timestamp update_time = 7 [(.google.api.field_behavior) = OUTPUT_ONLY];
| Returns | |
|---|---|
| Type | Description |
TimestampOrBuilder | |
hasBinaryAuthorization()
public boolean hasBinaryAuthorization()Settings for the Binary Authorization feature.
.google.cloud.run.v2.BinaryAuthorization binary_authorization = 15;
| Returns | |
|---|---|
| Type | Description |
boolean | Whether the binaryAuthorization field is set. |
hasCreateTime()
public boolean hasCreateTime()Output only. The creation time.
.google.protobuf.Timestamp create_time = 6 [(.google.api.field_behavior) = OUTPUT_ONLY];
| Returns | |
|---|---|
| Type | Description |
boolean | Whether the createTime field is set. |
hasDeleteTime()
public boolean hasDeleteTime()Output only. The deletion time.
.google.protobuf.Timestamp delete_time = 8 [(.google.api.field_behavior) = OUTPUT_ONLY];
| Returns | |
|---|---|
| Type | Description |
boolean | Whether the deleteTime field is set. |
hasExpireTime()
public boolean hasExpireTime()Output only. For a deleted resource, the time after which it will be permamently deleted.
.google.protobuf.Timestamp expire_time = 9 [(.google.api.field_behavior) = OUTPUT_ONLY];
| Returns | |
|---|---|
| Type | Description |
boolean | Whether the expireTime field is set. |
hasLatestCreatedExecution()
public boolean hasLatestCreatedExecution()Output only. Name of the last created execution.
.google.cloud.run.v2.ExecutionReference latest_created_execution = 22 [(.google.api.field_behavior) = OUTPUT_ONLY];
| Returns | |
|---|---|
| Type | Description |
boolean | Whether the latestCreatedExecution field is set. |
hasTemplate()
public boolean hasTemplate()Required. The template used to create executions for this Job.
.google.cloud.run.v2.ExecutionTemplate template = 16 [(.google.api.field_behavior) = REQUIRED];
| Returns | |
|---|---|
| Type | Description |
boolean | Whether the template field is set. |
hasTerminalCondition()
public boolean hasTerminalCondition()Output only. The Condition of this Job, containing its readiness status, and detailed error information in case it did not reach the desired state.
.google.cloud.run.v2.Condition terminal_condition = 18 [(.google.api.field_behavior) = OUTPUT_ONLY];
| Returns | |
|---|---|
| Type | Description |
boolean | Whether the terminalCondition field is set. |
hasUpdateTime()
public boolean hasUpdateTime()Output only. The last-modified time.
.google.protobuf.Timestamp update_time = 7 [(.google.api.field_behavior) = OUTPUT_ONLY];
| Returns | |
|---|---|
| Type | Description |
boolean | Whether the updateTime field is set. |
internalGetFieldAccessorTable()
protected GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()| Returns | |
|---|---|
| Type | Description |
FieldAccessorTable | |
internalGetMapField(int number)
protected MapField internalGetMapField(int number)| Parameter | |
|---|---|
| Name | Description |
number | int |
| Returns | |
|---|---|
| Type | Description |
MapField | |
internalGetMutableMapField(int number)
protected MapField internalGetMutableMapField(int number)| Parameter | |
|---|---|
| Name | Description |
number | int |
| Returns | |
|---|---|
| Type | Description |
MapField | |
isInitialized()
public final boolean isInitialized()| Returns | |
|---|---|
| Type | Description |
boolean | |
mergeBinaryAuthorization(BinaryAuthorization value)
public Job.Builder mergeBinaryAuthorization(BinaryAuthorization value)Settings for the Binary Authorization feature.
.google.cloud.run.v2.BinaryAuthorization binary_authorization = 15;
| Parameter | |
|---|---|
| Name | Description |
value | BinaryAuthorization |
| Returns | |
|---|---|
| Type | Description |
Job.Builder | |
mergeCreateTime(Timestamp value)
public Job.Builder mergeCreateTime(Timestamp value)Output only. The creation time.
.google.protobuf.Timestamp create_time = 6 [(.google.api.field_behavior) = OUTPUT_ONLY];
| Parameter | |
|---|---|
| Name | Description |
value | Timestamp |
| Returns | |
|---|---|
| Type | Description |
Job.Builder | |
mergeDeleteTime(Timestamp value)
public Job.Builder mergeDeleteTime(Timestamp value)Output only. The deletion time.
.google.protobuf.Timestamp delete_time = 8 [(.google.api.field_behavior) = OUTPUT_ONLY];
| Parameter | |
|---|---|
| Name | Description |
value | Timestamp |
| Returns | |
|---|---|
| Type | Description |
Job.Builder | |
mergeExpireTime(Timestamp value)
public Job.Builder mergeExpireTime(Timestamp value)Output only. For a deleted resource, the time after which it will be permamently deleted.
.google.protobuf.Timestamp expire_time = 9 [(.google.api.field_behavior) = OUTPUT_ONLY];
| Parameter | |
|---|---|
| Name | Description |
value | Timestamp |
| Returns | |
|---|---|
| Type | Description |
Job.Builder | |
mergeFrom(Job other)
public Job.Builder mergeFrom(Job other)| Parameter | |
|---|---|
| Name | Description |
other | Job |
| Returns | |
|---|---|
| Type | Description |
Job.Builder | |
mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
public Job.Builder mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)| Parameters | |
|---|---|
| Name | Description |
input | CodedInputStream |
extensionRegistry | ExtensionRegistryLite |
| Returns | |
|---|---|
| Type | Description |
Job.Builder | |
| Exceptions | |
|---|---|
| Type | Description |
IOException | |
mergeFrom(Message other)
public Job.Builder mergeFrom(Message other)| Parameter | |
|---|---|
| Name | Description |
other | Message |
| Returns | |
|---|---|
| Type | Description |
Job.Builder | |
mergeLatestCreatedExecution(ExecutionReference value)
public Job.Builder mergeLatestCreatedExecution(ExecutionReference value)Output only. Name of the last created execution.
.google.cloud.run.v2.ExecutionReference latest_created_execution = 22 [(.google.api.field_behavior) = OUTPUT_ONLY];
| Parameter | |
|---|---|
| Name | Description |
value | ExecutionReference |
| Returns | |
|---|---|
| Type | Description |
Job.Builder | |
mergeTemplate(ExecutionTemplate value)
public Job.Builder mergeTemplate(ExecutionTemplate value)Required. The template used to create executions for this Job.
.google.cloud.run.v2.ExecutionTemplate template = 16 [(.google.api.field_behavior) = REQUIRED];
| Parameter | |
|---|---|
| Name | Description |
value | ExecutionTemplate |
| Returns | |
|---|---|
| Type | Description |
Job.Builder | |
mergeTerminalCondition(Condition value)
public Job.Builder mergeTerminalCondition(Condition value)Output only. The Condition of this Job, containing its readiness status, and detailed error information in case it did not reach the desired state.
.google.cloud.run.v2.Condition terminal_condition = 18 [(.google.api.field_behavior) = OUTPUT_ONLY];
| Parameter | |
|---|---|
| Name | Description |
value | Condition |
| Returns | |
|---|---|
| Type | Description |
Job.Builder | |
mergeUnknownFields(UnknownFieldSet unknownFields)
public final Job.Builder mergeUnknownFields(UnknownFieldSet unknownFields)| Parameter | |
|---|---|
| Name | Description |
unknownFields | UnknownFieldSet |
| Returns | |
|---|---|
| Type | Description |
Job.Builder | |
mergeUpdateTime(Timestamp value)
public Job.Builder mergeUpdateTime(Timestamp value)Output only. The last-modified time.
.google.protobuf.Timestamp update_time = 7 [(.google.api.field_behavior) = OUTPUT_ONLY];
| Parameter | |
|---|---|
| Name | Description |
value | Timestamp |
| Returns | |
|---|---|
| Type | Description |
Job.Builder | |
putAllAnnotations(Map<String,String> values)
public Job.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 on new resources. All system
annotations in v1 now have a corresponding field in v2 Job.
<p>This field follows Kubernetes annotations' namespacing, limits, and
rules.
map<string, string> annotations = 5;
| Parameter | |
|---|---|
| Name | Description |
values | Map<String,String> |
| Returns | |
|---|---|
| Type | Description |
Job.Builder | |
putAllLabels(Map<String,String> values)
public Job.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 Job.
map<string, string> labels = 4;
| Parameter | |
|---|---|
| Name | Description |
values | Map<String,String> |
| Returns | |
|---|---|
| Type | Description |
Job.Builder | |
putAnnotations(String key, String value)
public Job.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 on new resources. All system
annotations in v1 now have a corresponding field in v2 Job.
<p>This field follows Kubernetes annotations' namespacing, limits, and
rules.
map<string, string> annotations = 5;
| Parameters | |
|---|---|
| Name | Description |
key | String |
value | String |
| Returns | |
|---|---|
| Type | Description |
Job.Builder | |
putLabels(String key, String value)
public Job.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 Job.
map<string, string> labels = 4;
| Parameters | |
|---|---|
| Name | Description |
key | String |
value | String |
| Returns | |
|---|---|
| Type | Description |
Job.Builder | |
removeAnnotations(String key)
public Job.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 on new resources. All system
annotations in v1 now have a corresponding field in v2 Job.
<p>This field follows Kubernetes annotations' namespacing, limits, and
rules.
map<string, string> annotations = 5;
| Parameter | |
|---|---|
| Name | Description |
key | String |
| Returns | |
|---|---|
| Type | Description |
Job.Builder | |
removeConditions(int index)
public Job.Builder removeConditions(int index) Output only. The Conditions of all other associated sub-resources. They
contain additional diagnostics information in case the Job does not reach
its desired state. See comments in reconciling for additional information
on reconciliation process in Cloud Run.
repeated .google.cloud.run.v2.Condition conditions = 19 [(.google.api.field_behavior) = OUTPUT_ONLY];
| Parameter | |
|---|---|
| Name | Description |
index | int |
| Returns | |
|---|---|
| Type | Description |
Job.Builder | |
removeLabels(String key)
public Job.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 Job.
map<string, string> labels = 4;
| Parameter | |
|---|---|
| Name | Description |
key | String |
| Returns | |
|---|---|
| Type | Description |
Job.Builder | |
setBinaryAuthorization(BinaryAuthorization value)
public Job.Builder setBinaryAuthorization(BinaryAuthorization value)Settings for the Binary Authorization feature.
.google.cloud.run.v2.BinaryAuthorization binary_authorization = 15;
| Parameter | |
|---|---|
| Name | Description |
value | BinaryAuthorization |
| Returns | |
|---|---|
| Type | Description |
Job.Builder | |
setBinaryAuthorization(BinaryAuthorization.Builder builderForValue)
public Job.Builder setBinaryAuthorization(BinaryAuthorization.Builder builderForValue)Settings for the Binary Authorization feature.
.google.cloud.run.v2.BinaryAuthorization binary_authorization = 15;
| Parameter | |
|---|---|
| Name | Description |
builderForValue | BinaryAuthorization.Builder |
| Returns | |
|---|---|
| Type | Description |
Job.Builder | |
setClient(String value)
public Job.Builder setClient(String value)Arbitrary identifier for the API client.
string client = 12;
| Parameter | |
|---|---|
| Name | Description |
value | StringThe client to set. |
| Returns | |
|---|---|
| Type | Description |
Job.Builder | This builder for chaining. |
setClientBytes(ByteString value)
public Job.Builder setClientBytes(ByteString value)Arbitrary identifier for the API client.
string client = 12;
| Parameter | |
|---|---|
| Name | Description |
value | ByteStringThe bytes for client to set. |
| Returns | |
|---|---|
| Type | Description |
Job.Builder | This builder for chaining. |
setClientVersion(String value)
public Job.Builder setClientVersion(String value)Arbitrary version identifier for the API client.
string client_version = 13;
| Parameter | |
|---|---|
| Name | Description |
value | StringThe clientVersion to set. |
| Returns | |
|---|---|
| Type | Description |
Job.Builder | This builder for chaining. |
setClientVersionBytes(ByteString value)
public Job.Builder setClientVersionBytes(ByteString value)Arbitrary version identifier for the API client.
string client_version = 13;
| Parameter | |
|---|---|
| Name | Description |
value | ByteStringThe bytes for clientVersion to set. |
| Returns | |
|---|---|
| Type | Description |
Job.Builder | This builder for chaining. |
setConditions(int index, Condition value)
public Job.Builder setConditions(int index, Condition value) Output only. The Conditions of all other associated sub-resources. They
contain additional diagnostics information in case the Job does not reach
its desired state. See comments in reconciling for additional information
on reconciliation process in Cloud Run.
repeated .google.cloud.run.v2.Condition conditions = 19 [(.google.api.field_behavior) = OUTPUT_ONLY];
| Parameters | |
|---|---|
| Name | Description |
index | int |
value | Condition |
| Returns | |
|---|---|
| Type | Description |
Job.Builder | |
setConditions(int index, Condition.Builder builderForValue)
public Job.Builder setConditions(int index, Condition.Builder builderForValue) Output only. The Conditions of all other associated sub-resources. They
contain additional diagnostics information in case the Job does not reach
its desired state. See comments in reconciling for additional information
on reconciliation process in Cloud Run.
repeated .google.cloud.run.v2.Condition conditions = 19 [(.google.api.field_behavior) = OUTPUT_ONLY];
| Parameters | |
|---|---|
| Name | Description |
index | int |
builderForValue | Condition.Builder |
| Returns | |
|---|---|
| Type | Description |
Job.Builder | |
setCreateTime(Timestamp value)
public Job.Builder setCreateTime(Timestamp value)Output only. The creation time.
.google.protobuf.Timestamp create_time = 6 [(.google.api.field_behavior) = OUTPUT_ONLY];
| Parameter | |
|---|---|
| Name | Description |
value | Timestamp |
| Returns | |
|---|---|
| Type | Description |
Job.Builder | |
setCreateTime(Timestamp.Builder builderForValue)
public Job.Builder setCreateTime(Timestamp.Builder builderForValue)Output only. The creation time.
.google.protobuf.Timestamp create_time = 6 [(.google.api.field_behavior) = OUTPUT_ONLY];
| Parameter | |
|---|---|
| Name | Description |
builderForValue | Builder |
| Returns | |
|---|---|
| Type | Description |
Job.Builder | |
setCreator(String value)
public Job.Builder setCreator(String value)Output only. Email address of the authenticated creator.
string creator = 10 [(.google.api.field_behavior) = OUTPUT_ONLY];
| Parameter | |
|---|---|
| Name | Description |
value | StringThe creator to set. |
| Returns | |
|---|---|
| Type | Description |
Job.Builder | This builder for chaining. |
setCreatorBytes(ByteString value)
public Job.Builder setCreatorBytes(ByteString value)Output only. Email address of the authenticated creator.
string creator = 10 [(.google.api.field_behavior) = OUTPUT_ONLY];
| Parameter | |
|---|---|
| Name | Description |
value | ByteStringThe bytes for creator to set. |
| Returns | |
|---|---|
| Type | Description |
Job.Builder | This builder for chaining. |
setDeleteTime(Timestamp value)
public Job.Builder setDeleteTime(Timestamp value)Output only. The deletion time.
.google.protobuf.Timestamp delete_time = 8 [(.google.api.field_behavior) = OUTPUT_ONLY];
| Parameter | |
|---|---|
| Name | Description |
value | Timestamp |
| Returns | |
|---|---|
| Type | Description |
Job.Builder | |
setDeleteTime(Timestamp.Builder builderForValue)
public Job.Builder setDeleteTime(Timestamp.Builder builderForValue)Output only. The deletion time.
.google.protobuf.Timestamp delete_time = 8 [(.google.api.field_behavior) = OUTPUT_ONLY];
| Parameter | |
|---|---|
| Name | Description |
builderForValue | Builder |
| Returns | |
|---|---|
| Type | Description |
Job.Builder | |
setEtag(String value)
public Job.Builder setEtag(String value)Output only. A system-generated fingerprint for this version of the resource. May be used to detect modification conflict during updates.
string etag = 99 [(.google.api.field_behavior) = OUTPUT_ONLY];
| Parameter | |
|---|---|
| Name | Description |
value | StringThe etag to set. |
| Returns | |
|---|---|
| Type | Description |
Job.Builder | This builder for chaining. |
setEtagBytes(ByteString value)
public Job.Builder setEtagBytes(ByteString value)Output only. A system-generated fingerprint for this version of the resource. May be used to detect modification conflict during updates.
string etag = 99 [(.google.api.field_behavior) = OUTPUT_ONLY];
| Parameter | |
|---|---|
| Name | Description |
value | ByteStringThe bytes for etag to set. |
| Returns | |
|---|---|
| Type | Description |
Job.Builder | This builder for chaining. |
setExecutionCount(int value)
public Job.Builder setExecutionCount(int value)Output only. Number of executions created for this job.
int32 execution_count = 20 [(.google.api.field_behavior) = OUTPUT_ONLY];
| Parameter | |
|---|---|
| Name | Description |
value | intThe executionCount to set. |
| Returns | |
|---|---|
| Type | Description |
Job.Builder | This builder for chaining. |
setExpireTime(Timestamp value)
public Job.Builder setExpireTime(Timestamp value)Output only. For a deleted resource, the time after which it will be permamently deleted.
.google.protobuf.Timestamp expire_time = 9 [(.google.api.field_behavior) = OUTPUT_ONLY];
| Parameter | |
|---|---|
| Name | Description |
value | Timestamp |
| Returns | |
|---|---|
| Type | Description |
Job.Builder | |
setExpireTime(Timestamp.Builder builderForValue)
public Job.Builder setExpireTime(Timestamp.Builder builderForValue)Output only. For a deleted resource, the time after which it will be permamently deleted.
.google.protobuf.Timestamp expire_time = 9 [(.google.api.field_behavior) = OUTPUT_ONLY];
| Parameter | |
|---|---|
| Name | Description |
builderForValue | Builder |
| Returns | |
|---|---|
| Type | Description |
Job.Builder | |
setField(Descriptors.FieldDescriptor field, Object value)
public Job.Builder setField(Descriptors.FieldDescriptor field, Object value)| Parameters | |
|---|---|
| Name | Description |
field | FieldDescriptor |
value | Object |
| Returns | |
|---|---|
| Type | Description |
Job.Builder | |
setGeneration(long value)
public Job.Builder setGeneration(long value)Output only. A number that monotonically increases every time the user modifies the desired state.
int64 generation = 3 [(.google.api.field_behavior) = OUTPUT_ONLY];
| Parameter | |
|---|---|
| Name | Description |
value | longThe generation to set. |
| Returns | |
|---|---|
| Type | Description |
Job.Builder | This builder for chaining. |
setLastModifier(String value)
public Job.Builder setLastModifier(String value)Output only. Email address of the last authenticated modifier.
string last_modifier = 11 [(.google.api.field_behavior) = OUTPUT_ONLY];
| Parameter | |
|---|---|
| Name | Description |
value | StringThe lastModifier to set. |
| Returns | |
|---|---|
| Type | Description |
Job.Builder | This builder for chaining. |
setLastModifierBytes(ByteString value)
public Job.Builder setLastModifierBytes(ByteString value)Output only. Email address of the last authenticated modifier.
string last_modifier = 11 [(.google.api.field_behavior) = OUTPUT_ONLY];
| Parameter | |
|---|---|
| Name | Description |
value | ByteStringThe bytes for lastModifier to set. |
| Returns | |
|---|---|
| Type | Description |
Job.Builder | This builder for chaining. |
setLatestCreatedExecution(ExecutionReference value)
public Job.Builder setLatestCreatedExecution(ExecutionReference value)Output only. Name of the last created execution.
.google.cloud.run.v2.ExecutionReference latest_created_execution = 22 [(.google.api.field_behavior) = OUTPUT_ONLY];
| Parameter | |
|---|---|
| Name | Description |
value | ExecutionReference |
| Returns | |
|---|---|
| Type | Description |
Job.Builder | |
setLatestCreatedExecution(ExecutionReference.Builder builderForValue)
public Job.Builder setLatestCreatedExecution(ExecutionReference.Builder builderForValue)Output only. Name of the last created execution.
.google.cloud.run.v2.ExecutionReference latest_created_execution = 22 [(.google.api.field_behavior) = OUTPUT_ONLY];
| Parameter | |
|---|---|
| Name | Description |
builderForValue | ExecutionReference.Builder |
| Returns | |
|---|---|
| Type | Description |
Job.Builder | |
setLaunchStage(LaunchStage value)
public Job.Builder setLaunchStage(LaunchStage value) The launch stage as defined by Google Cloud Platform
Launch Stages.
Cloud Run supports ALPHA, BETA, and GA. If no value is specified, GA
is assumed.
Set the launch stage to a preview stage on input to allow use of preview
features in that stage. On read (or output), describes whether the resource
uses preview features.
<p>
For example, if ALPHA is provided as input, but only BETA and GA-level
features are used, this field will be BETA on output.
.google.api.LaunchStage launch_stage = 14;
| Parameter | |
|---|---|
| Name | Description |
value | com.google.api.LaunchStageThe launchStage to set. |
| Returns | |
|---|---|
| Type | Description |
Job.Builder | This builder for chaining. |
setLaunchStageValue(int value)
public Job.Builder setLaunchStageValue(int value) The launch stage as defined by Google Cloud Platform
Launch Stages.
Cloud Run supports ALPHA, BETA, and GA. If no value is specified, GA
is assumed.
Set the launch stage to a preview stage on input to allow use of preview
features in that stage. On read (or output), describes whether the resource
uses preview features.
<p>
For example, if ALPHA is provided as input, but only BETA and GA-level
features are used, this field will be BETA on output.
.google.api.LaunchStage launch_stage = 14;
| Parameter | |
|---|---|
| Name | Description |
value | intThe enum numeric value on the wire for launchStage to set. |
| Returns | |
|---|---|
| Type | Description |
Job.Builder | This builder for chaining. |
setName(String value)
public Job.Builder setName(String value)The fully qualified name of this Job. Format: projects/{project}/locations/{location}/jobs/{job}
string name = 1;
| Parameter | |
|---|---|
| Name | Description |
value | StringThe name to set. |
| Returns | |
|---|---|
| Type | Description |
Job.Builder | This builder for chaining. |
setNameBytes(ByteString value)
public Job.Builder setNameBytes(ByteString value)The fully qualified name of this Job. Format: projects/{project}/locations/{location}/jobs/{job}
string name = 1;
| Parameter | |
|---|---|
| Name | Description |
value | ByteStringThe bytes for name to set. |
| Returns | |
|---|---|
| Type | Description |
Job.Builder | This builder for chaining. |
setObservedGeneration(long value)
public Job.Builder setObservedGeneration(long value) Output only. The generation of this Job. See comments in reconciling for
additional information on reconciliation process in Cloud Run.
int64 observed_generation = 17 [(.google.api.field_behavior) = OUTPUT_ONLY];
| Parameter | |
|---|---|
| Name | Description |
value | longThe observedGeneration to set. |
| Returns | |
|---|---|
| Type | Description |
Job.Builder | This builder for chaining. |
setReconciling(boolean value)
public Job.Builder setReconciling(boolean value) Output only. Returns true if the Job is currently being acted upon by the
system to bring it into the desired state.
When a new Job is created, or an existing one is updated, Cloud Run
will asynchronously perform all necessary steps to bring the Job to the
desired state. This process is called reconciliation.
While reconciliation is in process, observed_generation and
latest_succeeded_execution, will have transient values that might
mismatch the intended state: Once reconciliation is over (and this field is
false), there are two possible outcomes: reconciliation succeeded and the
state matches the Job, or there was an error, and reconciliation failed.
This state can be found in terminal_condition.state.
If reconciliation succeeded, the following fields will match:
observed_generation and generation, latest_succeeded_execution and
latest_created_execution.
If reconciliation failed, observed_generation and
latest_succeeded_execution will have the state of the last succeeded
execution or empty for newly created Job. Additional information on the
failure can be found in terminal_condition and conditions.
bool reconciling = 23 [(.google.api.field_behavior) = OUTPUT_ONLY];
| Parameter | |
|---|---|
| Name | Description |
value | booleanThe reconciling to set. |
| Returns | |
|---|---|
| Type | Description |
Job.Builder | This builder for chaining. |
setRepeatedField(Descriptors.FieldDescriptor field, int index, Object value)
public Job.Builder setRepeatedField(Descriptors.FieldDescriptor field, int index, Object value)| Parameters | |
|---|---|
| Name | Description |
field | FieldDescriptor |
index | int |
value | Object |
| Returns | |
|---|---|
| Type | Description |
Job.Builder | |
setSatisfiesPzs(boolean value)
public Job.Builder setSatisfiesPzs(boolean value)Output only. Reserved for future use.
bool satisfies_pzs = 25 [(.google.api.field_behavior) = OUTPUT_ONLY];
| Parameter | |
|---|---|
| Name | Description |
value | booleanThe satisfiesPzs to set. |
| Returns | |
|---|---|
| Type | Description |
Job.Builder | This builder for chaining. |
setTemplate(ExecutionTemplate value)
public Job.Builder setTemplate(ExecutionTemplate value)Required. The template used to create executions for this Job.
.google.cloud.run.v2.ExecutionTemplate template = 16 [(.google.api.field_behavior) = REQUIRED];
| Parameter | |
|---|---|
| Name | Description |
value | ExecutionTemplate |
| Returns | |
|---|---|
| Type | Description |
Job.Builder | |
setTemplate(ExecutionTemplate.Builder builderForValue)
public Job.Builder setTemplate(ExecutionTemplate.Builder builderForValue)Required. The template used to create executions for this Job.
.google.cloud.run.v2.ExecutionTemplate template = 16 [(.google.api.field_behavior) = REQUIRED];
| Parameter | |
|---|---|
| Name | Description |
builderForValue | ExecutionTemplate.Builder |
| Returns | |
|---|---|
| Type | Description |
Job.Builder | |
setTerminalCondition(Condition value)
public Job.Builder setTerminalCondition(Condition value)Output only. The Condition of this Job, containing its readiness status, and detailed error information in case it did not reach the desired state.
.google.cloud.run.v2.Condition terminal_condition = 18 [(.google.api.field_behavior) = OUTPUT_ONLY];
| Parameter | |
|---|---|
| Name | Description |
value | Condition |
| Returns | |
|---|---|
| Type | Description |
Job.Builder | |
setTerminalCondition(Condition.Builder builderForValue)
public Job.Builder setTerminalCondition(Condition.Builder builderForValue)Output only. The Condition of this Job, containing its readiness status, and detailed error information in case it did not reach the desired state.
.google.cloud.run.v2.Condition terminal_condition = 18 [(.google.api.field_behavior) = OUTPUT_ONLY];
| Parameter | |
|---|---|
| Name | Description |
builderForValue | Condition.Builder |
| Returns | |
|---|---|
| Type | Description |
Job.Builder | |
setUid(String value)
public Job.Builder setUid(String value)Output only. Server assigned unique identifier for the Execution. The value is a UUID4 string and guaranteed to remain unchanged until the resource is deleted.
string uid = 2 [(.google.api.field_behavior) = OUTPUT_ONLY];
| Parameter | |
|---|---|
| Name | Description |
value | StringThe uid to set. |
| Returns | |
|---|---|
| Type | Description |
Job.Builder | This builder for chaining. |
setUidBytes(ByteString value)
public Job.Builder setUidBytes(ByteString value)Output only. Server assigned unique identifier for the Execution. The value is a UUID4 string and guaranteed to remain unchanged until the resource is deleted.
string uid = 2 [(.google.api.field_behavior) = OUTPUT_ONLY];
| Parameter | |
|---|---|
| Name | Description |
value | ByteStringThe bytes for uid to set. |
| Returns | |
|---|---|
| Type | Description |
Job.Builder | This builder for chaining. |
setUnknownFields(UnknownFieldSet unknownFields)
public final Job.Builder setUnknownFields(UnknownFieldSet unknownFields)| Parameter | |
|---|---|
| Name | Description |
unknownFields | UnknownFieldSet |
| Returns | |
|---|---|
| Type | Description |
Job.Builder | |
setUpdateTime(Timestamp value)
public Job.Builder setUpdateTime(Timestamp value)Output only. The last-modified time.
.google.protobuf.Timestamp update_time = 7 [(.google.api.field_behavior) = OUTPUT_ONLY];
| Parameter | |
|---|---|
| Name | Description |
value | Timestamp |
| Returns | |
|---|---|
| Type | Description |
Job.Builder | |
setUpdateTime(Timestamp.Builder builderForValue)
public Job.Builder setUpdateTime(Timestamp.Builder builderForValue)Output only. The last-modified time.
.google.protobuf.Timestamp update_time = 7 [(.google.api.field_behavior) = OUTPUT_ONLY];
| Parameter | |
|---|---|
| Name | Description |
builderForValue | Builder |
| Returns | |
|---|---|
| Type | Description |
Job.Builder | |