Defines a job to be run by the Cloud Dataflow service. More...
Properties | |
| virtual 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. More... | |
| virtual object | CreateTime [get, set] |
| The timestamp when the job was initially created. Immutable and set by the Cloud Dataflow service. More... | |
| virtual string | CreatedFromSnapshotId [get, set] |
| If this is specified, the job's initial state is populated from the given snapshot. More... | |
| virtual string | CurrentState [get, set] |
| The current state of the job. More... | |
| virtual object | CurrentStateTime [get, set] |
| The timestamp associated with the current state. More... | |
| virtual Environment | Environment [get, set] |
| The environment for the job. More... | |
| virtual JobExecutionInfo | ExecutionInfo [get, set] |
| Deprecated. More... | |
| virtual string | Id [get, set] |
| The unique ID of this job. More... | |
| virtual 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. More... | |
| virtual System.Collections.Generic.IDictionary< string, string > | Labels [get, set] |
| User-defined labels for this job. More... | |
| virtual string | Location [get, set] |
| The regional endpoint that contains this job. More... | |
| virtual string | Name [get, set] |
| The user-specified Cloud Dataflow job name. More... | |
| virtual 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. More... | |
| virtual string | ProjectId [get, set] |
| The ID of the Cloud Platform project that the job belongs to. More... | |
| virtual 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. More... | |
| virtual 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. More... | |
| virtual string | RequestedState [get, set] |
| The job's requested state. More... | |
| virtual System.Collections.Generic.IList< ExecutionStageState > | StageStates [get, set] |
| This field may be mutated by the Cloud Dataflow service; callers cannot mutate it. More... | |
| virtual object | 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. More... | |
| virtual System.Collections.Generic.IList< Step > | Steps [get, set] |
| Exactly one of step or steps_location should be specified. More... | |
| virtual string | StepsLocation [get, set] |
| The GCS location where the steps are stored. More... | |
| virtual System.Collections.Generic.IList< string > | TempFiles [get, set] |
| 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. More... | |
| virtual System.Collections.Generic.IDictionary< string, string > | TransformNameMapping [get, set] |
| The map of transform name prefixes of the job to be replaced to the corresponding name prefixes of the new job. More... | |
| virtual string | Type [get, set] |
| The type of Cloud Dataflow job. More... | |
| virtual string | ETag [get, set] |
| The ETag of the item. More... | |
 Properties inherited from Google::Apis::Requests::IDirectResponseSchema | |
| string | ETag |
Detailed Description
Defines a job to be run by the Cloud Dataflow service.
Property Documentation
◆ ClientRequestId
|
getset |
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.
◆ CreatedFromSnapshotId
|
getset |
If this is specified, the job's initial state is populated from the given snapshot.
◆ CreateTime
|
getset |
The timestamp when the job was initially created. Immutable and set by the Cloud Dataflow service.
◆ CurrentState
|
getset |
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 may be mutated by the Cloud Dataflow service; callers cannot mutate it.
◆ CurrentStateTime
|
getset |
The timestamp associated with the current state.
◆ Environment
|
getset |
The environment for the job.
◆ ETag
|
getset |
The ETag of the item.
◆ ExecutionInfo
|
getset |
Deprecated.
◆ Id
|
getset |
◆ JobMetadata
|
getset |
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.
◆ Labels
|
getset |
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:
{Ll}{Lo}{0,62} * Values must conform to regexp: [{Ll}{Lo}{N}_-]{0,63} * Both keys and values are additionally constrained to be <= 128 bytes in size.
◆ Location
|
getset |
The regional endpoint that contains this job.
◆ Name
|
getset |
The user-specified Cloud Dataflow job name.
Only one Job with a given name may exist in a project at any given time. If a caller attempts to create a Job with the same name as an already-existing Job, the attempt returns the existing Job.
The name must match the regular expression [a-z]([-a-z0-9]{0,38}[a-z0-9])?
◆ PipelineDescription
|
getset |
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.
◆ ProjectId
|
getset |
The ID of the Cloud Platform project that the job belongs to.
◆ ReplacedByJobId
|
getset |
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.
◆ ReplaceJobId
|
getset |
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.
◆ RequestedState
|
getset |
The job's requested state.
UpdateJob may be used to switch between the JOB_STATE_STOPPED and JOB_STATE_RUNNING states, by setting requested_state. UpdateJob may also be used to directly set a job's requested state to JOB_STATE_CANCELLED or JOB_STATE_DONE, irrevocably terminating the job if it has not already reached a terminal state.
◆ StageStates
|
getset |
This field may be mutated by the Cloud Dataflow service; callers cannot mutate it.
◆ StartTime
|
getset |
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.
◆ Steps
|
getset |
Exactly one of step or steps_location should be specified.
The top-level steps that constitute the entire job.
◆ StepsLocation
|
getset |
The GCS location where the steps are stored.
◆ TempFiles
|
getset |
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}
◆ TransformNameMapping
|
getset |
The map of transform name prefixes of the job to be replaced to the corresponding name prefixes of the new job.
◆ Type
|
getset |
The type of Cloud Dataflow job.
The documentation for this class was generated from the following file:
- Google.Apis.Dataflow.v1b3.cs
