- 0.55.0 (latest)
- 0.54.0
- 0.53.0
- 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 final class Job extends GeneratedMessageV3 implements JobOrBuilder
Job 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<MessageType,BuilderType> > AbstractMessage > GeneratedMessageV3 > JobImplements
JobOrBuilderStatic Fields
ANNOTATIONS_FIELD_NUMBER
public static final int ANNOTATIONS_FIELD_NUMBER
Field Value | |
---|---|
Type | Description |
int |
BINARY_AUTHORIZATION_FIELD_NUMBER
public static final int BINARY_AUTHORIZATION_FIELD_NUMBER
Field Value | |
---|---|
Type | Description |
int |
CLIENT_FIELD_NUMBER
public static final int CLIENT_FIELD_NUMBER
Field Value | |
---|---|
Type | Description |
int |
CLIENT_VERSION_FIELD_NUMBER
public static final int CLIENT_VERSION_FIELD_NUMBER
Field Value | |
---|---|
Type | Description |
int |
CONDITIONS_FIELD_NUMBER
public static final int CONDITIONS_FIELD_NUMBER
Field Value | |
---|---|
Type | Description |
int |
CREATE_TIME_FIELD_NUMBER
public static final int CREATE_TIME_FIELD_NUMBER
Field Value | |
---|---|
Type | Description |
int |
CREATOR_FIELD_NUMBER
public static final int CREATOR_FIELD_NUMBER
Field Value | |
---|---|
Type | Description |
int |
DELETE_TIME_FIELD_NUMBER
public static final int DELETE_TIME_FIELD_NUMBER
Field Value | |
---|---|
Type | Description |
int |
ETAG_FIELD_NUMBER
public static final int ETAG_FIELD_NUMBER
Field Value | |
---|---|
Type | Description |
int |
EXECUTION_COUNT_FIELD_NUMBER
public static final int EXECUTION_COUNT_FIELD_NUMBER
Field Value | |
---|---|
Type | Description |
int |
EXPIRE_TIME_FIELD_NUMBER
public static final int EXPIRE_TIME_FIELD_NUMBER
Field Value | |
---|---|
Type | Description |
int |
GENERATION_FIELD_NUMBER
public static final int GENERATION_FIELD_NUMBER
Field Value | |
---|---|
Type | Description |
int |
LABELS_FIELD_NUMBER
public static final int LABELS_FIELD_NUMBER
Field Value | |
---|---|
Type | Description |
int |
LAST_MODIFIER_FIELD_NUMBER
public static final int LAST_MODIFIER_FIELD_NUMBER
Field Value | |
---|---|
Type | Description |
int |
LATEST_CREATED_EXECUTION_FIELD_NUMBER
public static final int LATEST_CREATED_EXECUTION_FIELD_NUMBER
Field Value | |
---|---|
Type | Description |
int |
LAUNCH_STAGE_FIELD_NUMBER
public static final int LAUNCH_STAGE_FIELD_NUMBER
Field Value | |
---|---|
Type | Description |
int |
NAME_FIELD_NUMBER
public static final int NAME_FIELD_NUMBER
Field Value | |
---|---|
Type | Description |
int |
OBSERVED_GENERATION_FIELD_NUMBER
public static final int OBSERVED_GENERATION_FIELD_NUMBER
Field Value | |
---|---|
Type | Description |
int |
RECONCILING_FIELD_NUMBER
public static final int RECONCILING_FIELD_NUMBER
Field Value | |
---|---|
Type | Description |
int |
RUN_EXECUTION_TOKEN_FIELD_NUMBER
public static final int RUN_EXECUTION_TOKEN_FIELD_NUMBER
Field Value | |
---|---|
Type | Description |
int |
SATISFIES_PZS_FIELD_NUMBER
public static final int SATISFIES_PZS_FIELD_NUMBER
Field Value | |
---|---|
Type | Description |
int |
START_EXECUTION_TOKEN_FIELD_NUMBER
public static final int START_EXECUTION_TOKEN_FIELD_NUMBER
Field Value | |
---|---|
Type | Description |
int |
TEMPLATE_FIELD_NUMBER
public static final int TEMPLATE_FIELD_NUMBER
Field Value | |
---|---|
Type | Description |
int |
TERMINAL_CONDITION_FIELD_NUMBER
public static final int TERMINAL_CONDITION_FIELD_NUMBER
Field Value | |
---|---|
Type | Description |
int |
UID_FIELD_NUMBER
public static final int UID_FIELD_NUMBER
Field Value | |
---|---|
Type | Description |
int |
UPDATE_TIME_FIELD_NUMBER
public static final int UPDATE_TIME_FIELD_NUMBER
Field Value | |
---|---|
Type | Description |
int |
Static Methods
getDefaultInstance()
public static Job getDefaultInstance()
Returns | |
---|---|
Type | Description |
Job |
getDescriptor()
public static final Descriptors.Descriptor getDescriptor()
Returns | |
---|---|
Type | Description |
Descriptor |
newBuilder()
public static Job.Builder newBuilder()
Returns | |
---|---|
Type | Description |
Job.Builder |
newBuilder(Job prototype)
public static Job.Builder newBuilder(Job prototype)
Parameter | |
---|---|
Name | Description |
prototype |
Job |
Returns | |
---|---|
Type | Description |
Job.Builder |
parseDelimitedFrom(InputStream input)
public static Job parseDelimitedFrom(InputStream input)
Parameter | |
---|---|
Name | Description |
input |
InputStream |
Returns | |
---|---|
Type | Description |
Job |
Exceptions | |
---|---|
Type | Description |
IOException |
parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
public static Job parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
Parameters | |
---|---|
Name | Description |
input |
InputStream |
extensionRegistry |
ExtensionRegistryLite |
Returns | |
---|---|
Type | Description |
Job |
Exceptions | |
---|---|
Type | Description |
IOException |
parseFrom(byte[] data)
public static Job parseFrom(byte[] data)
Parameter | |
---|---|
Name | Description |
data |
byte[] |
Returns | |
---|---|
Type | Description |
Job |
Exceptions | |
---|---|
Type | Description |
InvalidProtocolBufferException |
parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)
public static Job parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)
Parameters | |
---|---|
Name | Description |
data |
byte[] |
extensionRegistry |
ExtensionRegistryLite |
Returns | |
---|---|
Type | Description |
Job |
Exceptions | |
---|---|
Type | Description |
InvalidProtocolBufferException |
parseFrom(ByteString data)
public static Job parseFrom(ByteString data)
Parameter | |
---|---|
Name | Description |
data |
ByteString |
Returns | |
---|---|
Type | Description |
Job |
Exceptions | |
---|---|
Type | Description |
InvalidProtocolBufferException |
parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)
public static Job parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)
Parameters | |
---|---|
Name | Description |
data |
ByteString |
extensionRegistry |
ExtensionRegistryLite |
Returns | |
---|---|
Type | Description |
Job |
Exceptions | |
---|---|
Type | Description |
InvalidProtocolBufferException |
parseFrom(CodedInputStream input)
public static Job parseFrom(CodedInputStream input)
Parameter | |
---|---|
Name | Description |
input |
CodedInputStream |
Returns | |
---|---|
Type | Description |
Job |
Exceptions | |
---|---|
Type | Description |
IOException |
parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
public static Job parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
Parameters | |
---|---|
Name | Description |
input |
CodedInputStream |
extensionRegistry |
ExtensionRegistryLite |
Returns | |
---|---|
Type | Description |
Job |
Exceptions | |
---|---|
Type | Description |
IOException |
parseFrom(InputStream input)
public static Job parseFrom(InputStream input)
Parameter | |
---|---|
Name | Description |
input |
InputStream |
Returns | |
---|---|
Type | Description |
Job |
Exceptions | |
---|---|
Type | Description |
IOException |
parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
public static Job parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
Parameters | |
---|---|
Name | Description |
input |
InputStream |
extensionRegistry |
ExtensionRegistryLite |
Returns | |
---|---|
Type | Description |
Job |
Exceptions | |
---|---|
Type | Description |
IOException |
parseFrom(ByteBuffer data)
public static Job parseFrom(ByteBuffer data)
Parameter | |
---|---|
Name | Description |
data |
ByteBuffer |
Returns | |
---|---|
Type | Description |
Job |
Exceptions | |
---|---|
Type | Description |
InvalidProtocolBufferException |
parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)
public static Job parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)
Parameters | |
---|---|
Name | Description |
data |
ByteBuffer |
extensionRegistry |
ExtensionRegistryLite |
Returns | |
---|---|
Type | Description |
Job |
Exceptions | |
---|---|
Type | Description |
InvalidProtocolBufferException |
parser()
public static Parser<Job> parser()
Returns | |
---|---|
Type | Description |
Parser<Job> |
Methods
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 |
equals(Object obj)
public boolean equals(Object obj)
Parameter | |
---|---|
Name | Description |
obj |
Object |
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 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. |
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 |
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> |
getCreateExecutionCase()
public Job.CreateExecutionCase getCreateExecutionCase()
Returns | |
---|---|
Type | Description |
Job.CreateExecutionCase |
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. |
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. It is only populated as a response to a Delete request.
.google.protobuf.Timestamp delete_time = 8 [(.google.api.field_behavior) = OUTPUT_ONLY];
Returns | |
---|---|
Type | Description |
Timestamp |
The deleteTime. |
getDeleteTimeOrBuilder()
public TimestampOrBuilder getDeleteTimeOrBuilder()
Output only. The deletion time. It is only populated as a response to a Delete request.
.google.protobuf.Timestamp delete_time = 8 [(.google.api.field_behavior) = OUTPUT_ONLY];
Returns | |
---|---|
Type | Description |
TimestampOrBuilder |
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. |
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() (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 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. |
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. |
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. |
getParserForType()
public Parser<Job> getParserForType()
Returns | |
---|---|
Type | Description |
Parser<Job> |
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. |
getRunExecutionToken()
public String getRunExecutionToken()
A unique string used as a suffix for creating a new execution. The Job will become ready when the execution is successfully completed. The sum of job name and token length must be fewer than 63 characters.
string run_execution_token = 27;
Returns | |
---|---|
Type | Description |
String |
The runExecutionToken. |
getRunExecutionTokenBytes()
public ByteString getRunExecutionTokenBytes()
A unique string used as a suffix for creating a new execution. The Job will become ready when the execution is successfully completed. The sum of job name and token length must be fewer than 63 characters.
string run_execution_token = 27;
Returns | |
---|---|
Type | Description |
ByteString |
The bytes for runExecutionToken. |
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. |
getSerializedSize()
public int getSerializedSize()
Returns | |
---|---|
Type | Description |
int |
getStartExecutionToken()
public String getStartExecutionToken()
A unique string used as a suffix creating a new execution. The Job will become ready when the execution is successfully started. The sum of job name and token length must be fewer than 63 characters.
string start_execution_token = 26;
Returns | |
---|---|
Type | Description |
String |
The startExecutionToken. |
getStartExecutionTokenBytes()
public ByteString getStartExecutionTokenBytes()
A unique string used as a suffix creating a new execution. The Job will become ready when the execution is successfully started. The sum of job name and token length must be fewer than 63 characters.
string start_execution_token = 26;
Returns | |
---|---|
Type | Description |
ByteString |
The bytes for startExecutionToken. |
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. |
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. |
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. |
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. It is only populated as a response to a Delete request.
.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. |
hasRunExecutionToken()
public boolean hasRunExecutionToken()
A unique string used as a suffix for creating a new execution. The Job will become ready when the execution is successfully completed. The sum of job name and token length must be fewer than 63 characters.
string run_execution_token = 27;
Returns | |
---|---|
Type | Description |
boolean |
Whether the runExecutionToken field is set. |
hasStartExecutionToken()
public boolean hasStartExecutionToken()
A unique string used as a suffix creating a new execution. The Job will become ready when the execution is successfully started. The sum of job name and token length must be fewer than 63 characters.
string start_execution_token = 26;
Returns | |
---|---|
Type | Description |
boolean |
Whether the startExecutionToken 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. |
hashCode()
public int hashCode()
Returns | |
---|---|
Type | Description |
int |
internalGetFieldAccessorTable()
protected GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
Returns | |
---|---|
Type | Description |
FieldAccessorTable |
internalGetMapFieldReflection(int number)
protected MapFieldReflectionAccessor internalGetMapFieldReflection(int number)
Parameter | |
---|---|
Name | Description |
number |
int |
Returns | |
---|---|
Type | Description |
com.google.protobuf.MapFieldReflectionAccessor |
isInitialized()
public final boolean isInitialized()
Returns | |
---|---|
Type | Description |
boolean |
newBuilderForType()
public Job.Builder newBuilderForType()
Returns | |
---|---|
Type | Description |
Job.Builder |
newBuilderForType(GeneratedMessageV3.BuilderParent parent)
protected Job.Builder newBuilderForType(GeneratedMessageV3.BuilderParent parent)
Parameter | |
---|---|
Name | Description |
parent |
BuilderParent |
Returns | |
---|---|
Type | Description |
Job.Builder |
newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)
protected Object newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)
Parameter | |
---|---|
Name | Description |
unused |
UnusedPrivateParameter |
Returns | |
---|---|
Type | Description |
Object |
toBuilder()
public Job.Builder toBuilder()
Returns | |
---|---|
Type | Description |
Job.Builder |
writeTo(CodedOutputStream output)
public void writeTo(CodedOutputStream output)
Parameter | |
---|---|
Name | Description |
output |
CodedOutputStream |
Exceptions | |
---|---|
Type | Description |
IOException |