Cloud Run Admin v2 API - Class Job (2.11.0) 

public sealed class Job : IMessage<Job>, IEquatable<Job>, IDeepCloneable<Job>, IBufferMessage, IMessage

Reference documentation and code samples for the Cloud Run Admin v2 API class Job.

Job represents the configuration of a single job, which references a container image that is run to completion.

Inheritance

object > Job

Namespace

Google.Cloud.Run.V2

Assembly

Google.Cloud.Run.V2.dll

Constructors

Job()

public Job()

Job(Job)

public Job(Job other)
Parameter
Name Description
other Job

Properties

Annotations

public MapField<string, string> Annotations { get; }

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.

Property Value
Type Description
MapFieldstringstring

BinaryAuthorization

public BinaryAuthorization BinaryAuthorization { get; set; }

Settings for the Binary Authorization feature.

Property Value
Type Description
BinaryAuthorization

Client

public string Client { get; set; }

Arbitrary identifier for the API client.

Property Value
Type Description
string

ClientVersion

public string ClientVersion { get; set; }

Arbitrary version identifier for the API client.

Property Value
Type Description
string

Conditions

public RepeatedField<Condition> Conditions { get; }

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.

Property Value
Type Description
RepeatedFieldCondition

CreateExecutionCase

public Job.CreateExecutionOneofCase CreateExecutionCase { get; }
Property Value
Type Description
JobCreateExecutionOneofCase

CreateTime

public Timestamp CreateTime { get; set; }

Output only. The creation time.

Property Value
Type Description
Timestamp

Creator

public string Creator { get; set; }

Output only. Email address of the authenticated creator.

Property Value
Type Description
string

DeleteTime

public Timestamp DeleteTime { get; set; }

Output only. The deletion time. It is only populated as a response to a Delete request.

Property Value
Type Description
Timestamp

Etag

public string Etag { get; set; }

Output only. A system-generated fingerprint for this version of the resource. May be used to detect modification conflict during updates.

Property Value
Type Description
string

ExecutionCount

public int ExecutionCount { get; set; }

Output only. Number of executions created for this job.

Property Value
Type Description
int

ExpireTime

public Timestamp ExpireTime { get; set; }

Output only. For a deleted resource, the time after which it will be permamently deleted.

Property Value
Type Description
Timestamp

Generation

public long Generation { get; set; }

Output only. A number that monotonically increases every time the user modifies the desired state.

Property Value
Type Description
long

HasRunExecutionToken

public bool HasRunExecutionToken { get; }

Gets whether the "run_execution_token" field is set

Property Value
Type Description
bool

HasStartExecutionToken

public bool HasStartExecutionToken { get; }

Gets whether the "start_execution_token" field is set

Property Value
Type Description
bool

JobName

public JobName JobName { get; set; }

JobName-typed view over the Name resource name property.

Property Value
Type Description
JobName

Labels

public MapField<string, string> Labels { get; }

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.

Property Value
Type Description
MapFieldstringstring

LastModifier

public string LastModifier { get; set; }

Output only. Email address of the last authenticated modifier.

Property Value
Type Description
string

LatestCreatedExecution

public ExecutionReference LatestCreatedExecution { get; set; }

Output only. Name of the last created execution.

Property Value
Type Description
ExecutionReference

LaunchStage

public LaunchStage LaunchStage { get; set; }

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.

Property Value
Type Description
LaunchStage

Name

public string Name { get; set; }

The fully qualified name of this Job.

Format: projects/{project}/locations/{location}/jobs/{job}

Property Value
Type Description
string

ObservedGeneration

public long ObservedGeneration { get; set; }

Output only. The generation of this Job. See comments in reconciling for additional information on reconciliation process in Cloud Run.

Property Value
Type Description
long

Reconciling

public bool Reconciling { get; set; }

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.

Property Value
Type Description
bool

RunExecutionToken

public string RunExecutionToken { get; set; }

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.

Property Value
Type Description
string

SatisfiesPzs

public bool SatisfiesPzs { get; set; }

Output only. Reserved for future use.

Property Value
Type Description
bool

StartExecutionToken

public string StartExecutionToken { get; set; }

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.

Property Value
Type Description
string

Template

public ExecutionTemplate Template { get; set; }

Required. The template used to create executions for this Job.

Property Value
Type Description
ExecutionTemplate

TerminalCondition

public Condition TerminalCondition { get; set; }

Output only. The Condition of this Job, containing its readiness status, and detailed error information in case it did not reach the desired state.

Property Value
Type Description
Condition

Uid

public string Uid { get; set; }

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.

Property Value
Type Description
string

UpdateTime

public Timestamp UpdateTime { get; set; }

Output only. The last-modified time.

Property Value
Type Description
Timestamp