# Dataflow v1beta3 API - Class Job (2.0.0-beta10)

2.0.0-beta10 (latest) 2.0.0-beta09 1.0.0-beta03

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

Reference documentation and code samples for the Dataflow v1beta3 API class Job.

Defines a job to be run by the Cloud Dataflow service. Do not enter
confidential information when you supply string values using the API.

## Inheritance

[object](https://learn.microsoft.com/dotnet/api/system.object) \> Job

## Implements

[IMessage](https://cloud.google.com/dotnet/docs/reference/Google.Protobuf/latest/Google.Protobuf.IMessage-1.html)[Job](https://docs.cloud.google.com/dotnet/docs/reference/Google.Cloud.Dataflow.V1Beta3/latest/Google.Cloud.Dataflow.V1Beta3.Job), [IEquatable](https://learn.microsoft.com/dotnet/api/system.iequatable-1)[Job](https://docs.cloud.google.com/dotnet/docs/reference/Google.Cloud.Dataflow.V1Beta3/latest/Google.Cloud.Dataflow.V1Beta3.Job), [IDeepCloneable](https://cloud.google.com/dotnet/docs/reference/Google.Protobuf/latest/Google.Protobuf.IDeepCloneable-1.html)[Job](https://docs.cloud.google.com/dotnet/docs/reference/Google.Cloud.Dataflow.V1Beta3/latest/Google.Cloud.Dataflow.V1Beta3.Job), [IBufferMessage](https://cloud.google.com/dotnet/docs/reference/Google.Protobuf/latest/Google.Protobuf.IBufferMessage.html), [IMessage](https://cloud.google.com/dotnet/docs/reference/Google.Protobuf/latest/Google.Protobuf.IMessage.html)

## Inherited Members

[object.GetHashCode()](https://learn.microsoft.com/dotnet/api/system.object.gethashcode) [object.GetType()](https://learn.microsoft.com/dotnet/api/system.object.gettype) [object.ToString()](https://learn.microsoft.com/dotnet/api/system.object.tostring)

## Namespace

[Google.Cloud.Dataflow.V1Beta3](https://docs.cloud.google.com/dotnet/docs/reference/Google.Cloud.Dataflow.V1Beta3/latest/Google.Cloud.Dataflow.V1Beta3)

## Assembly

Google.Cloud.Dataflow.V1Beta3.dll

## Constructors

### Job()

    public Job()

### Job(Job)

    public Job(Job other)

| **Parameter** ||
|---|---|
| **Name** | **Description** |
| `other` | `https://docs.cloud.google.com/dotnet/docs/reference/Google.Cloud.Dataflow.V1Beta3/latest/Google.Cloud.Dataflow.V1Beta3.Job` |

## Properties

### ClientRequestId

    public string ClientRequestId { get; set; }

The client's unique identifier of the job, re-used across retried attempts.
If this field is set, the service will ensure its uniqueness.
The request to create a job will fail if the service has knowledge of a
previously submitted job with the same client's ID and job name.
The caller may use this field to ensure idempotence of job
creation across retried attempts to create a job.
By default, the field is empty and, in that case, the service ignores it.

| **Property Value** ||
|---|---|
| **Type** | **Description** |
| `https://learn.microsoft.com/dotnet/api/system.string` |   |

### CreateTime

    public Timestamp CreateTime { get; set; }

The timestamp when the job was initially created. Immutable and set by the
Cloud Dataflow service.

| **Property Value** ||
|---|---|
| **Type** | **Description** |
| `https://cloud.google.com/dotnet/docs/reference/Google.Protobuf/latest/Google.Protobuf.WellKnownTypes.Timestamp.html` |   |

### CreatedFromSnapshotId

    public string CreatedFromSnapshotId { get; set; }

If this is specified, the job's initial state is populated from the given
snapshot.

| **Property Value** ||
|---|---|
| **Type** | **Description** |
| `https://learn.microsoft.com/dotnet/api/system.string` |   |

### CurrentState

    public JobState CurrentState { get; set; }

The current state of the job.

Jobs are created in the `JOB_STATE_STOPPED` state unless otherwise
specified.

A job in the `JOB_STATE_RUNNING` state may asynchronously enter a
terminal state. After a job has reached a terminal state, no
further state updates may be made.

This field might be mutated by the Dataflow service;
callers cannot mutate it.

| **Property Value** ||
|---|---|
| **Type** | **Description** |
| `https://docs.cloud.google.com/dotnet/docs/reference/Google.Cloud.Dataflow.V1Beta3/latest/Google.Cloud.Dataflow.V1Beta3.JobState` |   |

### CurrentStateTime

    public Timestamp CurrentStateTime { get; set; }

The timestamp associated with the current state.

| **Property Value** ||
|---|---|
| **Type** | **Description** |
| `https://cloud.google.com/dotnet/docs/reference/Google.Protobuf/latest/Google.Protobuf.WellKnownTypes.Timestamp.html` |   |

### Environment

    public Environment Environment { get; set; }

Optional. The environment for the job.

| **Property Value** ||
|---|---|
| **Type** | **Description** |
| `https://docs.cloud.google.com/dotnet/docs/reference/Google.Cloud.Dataflow.V1Beta3/latest/Google.Cloud.Dataflow.V1Beta3.Environment` |   |

### ExecutionInfo

    public JobExecutionInfo ExecutionInfo { get; set; }

Deprecated.

| **Property Value** ||
|---|---|
| **Type** | **Description** |
| `https://docs.cloud.google.com/dotnet/docs/reference/Google.Cloud.Dataflow.V1Beta3/latest/Google.Cloud.Dataflow.V1Beta3.JobExecutionInfo` |   |

### HasSatisfiesPzi

    public bool HasSatisfiesPzi { get; }

Gets whether the "satisfies_pzi" field is set

| **Property Value** ||
|---|---|
| **Type** | **Description** |
| `https://learn.microsoft.com/dotnet/api/system.boolean` |   |

### Id

    public string Id { get; set; }

The unique ID of this job.

This field is set by the Dataflow service when the job is
created, and is immutable for the life of the job.

| **Property Value** ||
|---|---|
| **Type** | **Description** |
| `https://learn.microsoft.com/dotnet/api/system.string` |   |

### JobMetadata

    public JobMetadata JobMetadata { get; set; }

This field is populated by the Dataflow service to support filtering jobs
by the metadata values provided here. Populated for ListJobs and all GetJob
views SUMMARY and higher.

| **Property Value** ||
|---|---|
| **Type** | **Description** |
| `https://docs.cloud.google.com/dotnet/docs/reference/Google.Cloud.Dataflow.V1Beta3/latest/Google.Cloud.Dataflow.V1Beta3.JobMetadata` |   |

### Labels

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

User-defined labels for this job.

The labels map can contain no more than 64 entries. Entries of the labels
map are UTF8 strings that comply with the following restrictions:

- Keys must conform to regexp: \[\\p{Ll}\\p{Lo}\]\[\\p{Ll}\\p{Lo}\\p{N}_-\]{0,62}
- Values must conform to regexp: \[\\p{Ll}\\p{Lo}\\p{N}_-\]{0,63}
- Both keys and values are additionally constrained to be \<= 128 bytes in size.

| **Property Value** ||
|---|---|
| **Type** | **Description** |
| `https://cloud.google.com/dotnet/docs/reference/Google.Protobuf/latest/Google.Protobuf.Collections.MapField-2.htmlhttps://learn.microsoft.com/dotnet/api/system.stringhttps://learn.microsoft.com/dotnet/api/system.string` |   |

### Location

    public string Location { get; set; }

Optional. The [regional endpoint](https://cloud.google.com/dataflow/docs/concepts/regional-endpoints) that
contains this job.

| **Property Value** ||
|---|---|
| **Type** | **Description** |
| `https://learn.microsoft.com/dotnet/api/system.string` |   |

### Name

    public string Name { get; set; }

Optional. The user-specified Dataflow job name.

Only one active job with a given name can exist in a project within one
region at
any given time. Jobs in different regions can have the same name.
If a caller attempts to create a job with the same
name as an active job that already exists, the attempt returns the
existing job.

The name must match the regular expression
`[a-z]([-a-z0-9]{0,1022}[a-z0-9])?`

| **Property Value** ||
|---|---|
| **Type** | **Description** |
| `https://learn.microsoft.com/dotnet/api/system.string` |   |

### Pausable

    public bool Pausable { get; set; }

Output only. Indicates whether the job can be paused.

| **Property Value** ||
|---|---|
| **Type** | **Description** |
| `https://learn.microsoft.com/dotnet/api/system.boolean` |   |

### PipelineDescription

    public PipelineDescription PipelineDescription { get; set; }

Preliminary field: The format of this data may change at any time.
A description of the user pipeline and stages through which it is executed.
Created by Cloud Dataflow service. Only retrieved with
JOB_VIEW_DESCRIPTION or JOB_VIEW_ALL.

| **Property Value** ||
|---|---|
| **Type** | **Description** |
| `https://docs.cloud.google.com/dotnet/docs/reference/Google.Cloud.Dataflow.V1Beta3/latest/Google.Cloud.Dataflow.V1Beta3.PipelineDescription` |   |

### ProjectId

    public string ProjectId { get; set; }

The ID of the Google Cloud project that the job belongs to.

| **Property Value** ||
|---|---|
| **Type** | **Description** |
| `https://learn.microsoft.com/dotnet/api/system.string` |   |

### ReplaceJobId

    public string ReplaceJobId { get; set; }

If this job is an update of an existing job, this field is the job ID
of the job it replaced.

When sending a `CreateJobRequest`, you can update a job by specifying it
here. The job named here is stopped, and its intermediate state is
transferred to this job.

| **Property Value** ||
|---|---|
| **Type** | **Description** |
| `https://learn.microsoft.com/dotnet/api/system.string` |   |

### ReplacedByJobId

    public string ReplacedByJobId { get; set; }

If another job is an update of this job (and thus, this job is in
`JOB_STATE_UPDATED`), this field contains the ID of that job.

| **Property Value** ||
|---|---|
| **Type** | **Description** |
| `https://learn.microsoft.com/dotnet/api/system.string` |   |

### RequestedState

    public JobState RequestedState { get; set; }

The job's requested state. Applies to `UpdateJob` requests.

Set `requested_state` with `UpdateJob` requests to switch between the
states `JOB_STATE_STOPPED` and `JOB_STATE_RUNNING`. You can also use
`UpdateJob` requests to change a job's
state from `JOB_STATE_RUNNING` to `JOB_STATE_CANCELLED`,
`JOB_STATE_DONE`, or `JOB_STATE_DRAINED`. These states irrevocably
terminate the job if it hasn't already reached a terminal state.

This field has no effect on `CreateJob` requests.

| **Property Value** ||
|---|---|
| **Type** | **Description** |
| `https://docs.cloud.google.com/dotnet/docs/reference/Google.Cloud.Dataflow.V1Beta3/latest/Google.Cloud.Dataflow.V1Beta3.JobState` |   |

### RuntimeUpdatableParams

    public RuntimeUpdatableParams RuntimeUpdatableParams { get; set; }

This field may ONLY be modified at runtime using the projects.jobs.update
method to adjust job behavior. This field has no effect when specified at
job creation.

| **Property Value** ||
|---|---|
| **Type** | **Description** |
| `https://docs.cloud.google.com/dotnet/docs/reference/Google.Cloud.Dataflow.V1Beta3/latest/Google.Cloud.Dataflow.V1Beta3.RuntimeUpdatableParams` |   |

### SatisfiesPzi

    public bool SatisfiesPzi { get; set; }

Output only. Reserved for future use. This field is set only in responses
from the server; it is ignored if it is set in any requests.

| **Property Value** ||
|---|---|
| **Type** | **Description** |
| `https://learn.microsoft.com/dotnet/api/system.boolean` |   |

### SatisfiesPzs

    public bool SatisfiesPzs { get; set; }

Reserved for future use. This field is set only in responses from the
server; it is ignored if it is set in any requests.

| **Property Value** ||
|---|---|
| **Type** | **Description** |
| `https://learn.microsoft.com/dotnet/api/system.boolean` |   |

### ServiceResources

    public ServiceResources ServiceResources { get; set; }

Output only. Resources used by the Dataflow Service to run the job.

| **Property Value** ||
|---|---|
| **Type** | **Description** |
| `https://docs.cloud.google.com/dotnet/docs/reference/Google.Cloud.Dataflow.V1Beta3/latest/Google.Cloud.Dataflow.V1Beta3.ServiceResources` |   |

### StageStates

    public RepeatedField<ExecutionStageState> StageStates { get; }

This field may be mutated by the Cloud Dataflow service;
callers cannot mutate it.

| **Property Value** ||
|---|---|
| **Type** | **Description** |
| `https://cloud.google.com/dotnet/docs/reference/Google.Protobuf/latest/Google.Protobuf.Collections.RepeatedField-1.htmlhttps://docs.cloud.google.com/dotnet/docs/reference/Google.Cloud.Dataflow.V1Beta3/latest/Google.Cloud.Dataflow.V1Beta3.ExecutionStageState` |   |

### StartTime

    public Timestamp StartTime { get; set; }

The timestamp when the job was started (transitioned to JOB_STATE_PENDING).
Flexible resource scheduling jobs are started with some delay after job
creation, so start_time is unset before start and is updated when the
job is started by the Cloud Dataflow service. For other jobs, start_time
always equals to create_time and is immutable and set by the Cloud Dataflow
service.

| **Property Value** ||
|---|---|
| **Type** | **Description** |
| `https://cloud.google.com/dotnet/docs/reference/Google.Protobuf/latest/Google.Protobuf.WellKnownTypes.Timestamp.html` |   |

### Steps

    public RepeatedField<Step> Steps { get; }

Exactly one of step or steps_location should be specified.

The top-level steps that constitute the entire job. Only retrieved with
JOB_VIEW_ALL.

| **Property Value** ||
|---|---|
| **Type** | **Description** |
| `https://cloud.google.com/dotnet/docs/reference/Google.Protobuf/latest/Google.Protobuf.Collections.RepeatedField-1.htmlhttps://docs.cloud.google.com/dotnet/docs/reference/Google.Cloud.Dataflow.V1Beta3/latest/Google.Cloud.Dataflow.V1Beta3.Step` |   |

### StepsLocation

    public string StepsLocation { get; set; }

The Cloud Storage location where the steps are stored.

| **Property Value** ||
|---|---|
| **Type** | **Description** |
| `https://learn.microsoft.com/dotnet/api/system.string` |   |

### TempFiles

    public RepeatedField<string> TempFiles { get; }

A set of files the system should be aware of that are used
for temporary storage. These temporary files will be
removed on job completion.
No duplicates are allowed.
No file patterns are supported.

The supported files are:

Google Cloud Storage:

storage.googleapis.com/{bucket}/{object}
bucket.storage.googleapis.com/{object}

| **Property Value** ||
|---|---|
| **Type** | **Description** |
| `https://cloud.google.com/dotnet/docs/reference/Google.Protobuf/latest/Google.Protobuf.Collections.RepeatedField-1.htmlhttps://learn.microsoft.com/dotnet/api/system.string` |   |

### TransformNameMapping

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

Optional. The map of transform name prefixes of the job to be replaced to
the corresponding name prefixes of the new job.

| **Property Value** ||
|---|---|
| **Type** | **Description** |
| `https://cloud.google.com/dotnet/docs/reference/Google.Protobuf/latest/Google.Protobuf.Collections.MapField-2.htmlhttps://learn.microsoft.com/dotnet/api/system.stringhttps://learn.microsoft.com/dotnet/api/system.string` |   |

### Type

    public JobType Type { get; set; }

Optional. The type of Dataflow job.

| **Property Value** ||
|---|---|
| **Type** | **Description** |
| `https://docs.cloud.google.com/dotnet/docs/reference/Google.Cloud.Dataflow.V1Beta3/latest/Google.Cloud.Dataflow.V1Beta3.JobType` |   |