Interface JobOrBuilder (0.24.0)

Version 0.24.0

• 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 interface JobOrBuilder extends MessageOrBuilder

Implements

MessageOrBuilder

Methods

containsAnnotations(String key)

public abstract 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 abstract 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 abstract Map<String,String> getAnnotations()

Use #getAnnotationsMap() instead.

Returns
Type	Description
Map<String,String>

getAnnotationsCount()

public abstract 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 abstract 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 abstract 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 abstract 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 abstract BinaryAuthorization getBinaryAuthorization()

Settings for the Binary Authorization feature.

.google.cloud.run.v2.BinaryAuthorization binary_authorization = 15;

Returns
Type	Description
BinaryAuthorization	The binaryAuthorization.

getBinaryAuthorizationOrBuilder()

public abstract BinaryAuthorizationOrBuilder getBinaryAuthorizationOrBuilder()

Settings for the Binary Authorization feature.

.google.cloud.run.v2.BinaryAuthorization binary_authorization = 15;

Returns
Type	Description
BinaryAuthorizationOrBuilder

getClient()

public abstract String getClient()

Arbitrary identifier for the API client.

string client = 12;

Returns
Type	Description
String	The client.

getClientBytes()

public abstract ByteString getClientBytes()

Arbitrary identifier for the API client.

string client = 12;

Returns
Type	Description
ByteString	The bytes for client.

getClientVersion()

public abstract String getClientVersion()

Arbitrary version identifier for the API client.

string client_version = 13;

Returns
Type	Description
String	The clientVersion.

getClientVersionBytes()

public abstract 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 abstract 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 abstract 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 abstract 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 abstract 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 abstract 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 abstract 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 abstract 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 abstract 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 abstract 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.

getDeleteTime()

public abstract 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.

getDeleteTimeOrBuilder()

public abstract TimestampOrBuilder getDeleteTimeOrBuilder()

Output only. The deletion time.

.google.protobuf.Timestamp delete_time = 8 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type	Description
TimestampOrBuilder

getEtag()

public abstract 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 abstract 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 abstract 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 abstract 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 abstract 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 abstract 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 abstract Map<String,String> getLabels()

Use #getLabelsMap() instead.

Returns
Type	Description
Map<String,String>

getLabelsCount()

public abstract 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 abstract 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 abstract 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 abstract 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 abstract 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 abstract 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 abstract 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 abstract 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 abstract 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 abstract 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 abstract 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 abstract 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 abstract 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 abstract 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 abstract 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 abstract 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 abstract 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 abstract 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 abstract 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 abstract 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 abstract 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 abstract 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 abstract 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 abstract 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 abstract 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 abstract 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 abstract 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 abstract 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 abstract 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 abstract 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 abstract 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.