Reference documentation and code samples for the Google Cloud Dataflow V1beta3 Client 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.
Generated from protobuf message google.dataflow.v1beta3.Job
Namespace
Google \ Cloud \ Dataflow \ V1beta3Methods
__construct
Constructor.
| Parameters | |
|---|---|
| Name | Description |
data |
array
Optional. Data for populating the Message object. |
↳ id |
string
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. |
↳ project_id |
string
The ID of the Google Cloud project that the job belongs to. |
↳ name |
string
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 |
↳ type |
int
Optional. The type of Dataflow job. |
↳ environment |
Environment
Optional. The environment for the job. |
↳ steps |
array<Step>
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. |
↳ steps_location |
string
The Cloud Storage ___location where the steps are stored. |
↳ current_state |
int
The current state of the job. Jobs are created in the |
↳ current_state_time |
Google\Protobuf\Timestamp
The timestamp associated with the current state. |
↳ requested_state |
int
The job's requested state. Applies to |
↳ execution_info |
JobExecutionInfo
Deprecated. |
↳ create_time |
Google\Protobuf\Timestamp
The timestamp when the job was initially created. Immutable and set by the Cloud Dataflow service. |
↳ replace_job_id |
string
If this job is an update of an existing job, this field is the job ID of the job it replaced. When sending a |
↳ transform_name_mapping |
array|Google\Protobuf\Internal\MapField
Optional. The map of transform name prefixes of the job to be replaced to the corresponding name prefixes of the new job. |
↳ client_request_id |
string
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. |
↳ replaced_by_job_id |
string
If another job is an update of this job (and thus, this job is in |
↳ temp_files |
array
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} |
↳ labels |
array|Google\Protobuf\Internal\MapField
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. |
↳ ___location |
string
Optional. The regional endpoint that contains this job. |
↳ pipeline_description |
PipelineDescription
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. |
↳ stage_states |
array<ExecutionStageState>
This field may be mutated by the Cloud Dataflow service; callers cannot mutate it. |
↳ job_metadata |
JobMetadata
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. |
↳ start_time |
Google\Protobuf\Timestamp
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. |
↳ created_from_snapshot_id |
string
If this is specified, the job's initial state is populated from the given snapshot. |
↳ satisfies_pzs |
bool
Reserved for future use. This field is set only in responses from the server; it is ignored if it is set in any requests. |
↳ runtime_updatable_params |
RuntimeUpdatableParams
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. |
↳ satisfies_pzi |
bool
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. |
↳ service_resources |
ServiceResources
Output only. Resources used by the Dataflow Service to run the job. |
getId
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.
| Returns | |
|---|---|
| Type | Description |
string |
|
setId
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.
| Parameter | |
|---|---|
| Name | Description |
var |
string
|
| Returns | |
|---|---|
| Type | Description |
$this |
|
getProjectId
The ID of the Google Cloud project that the job belongs to.
| Returns | |
|---|---|
| Type | Description |
string |
|
setProjectId
The ID of the Google Cloud project that the job belongs to.
| Parameter | |
|---|---|
| Name | Description |
var |
string
|
| Returns | |
|---|---|
| Type | Description |
$this |
|
getName
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])?
| Returns | |
|---|---|
| Type | Description |
string |
|
setName
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])?
| Parameter | |
|---|---|
| Name | Description |
var |
string
|
| Returns | |
|---|---|
| Type | Description |
$this |
|
getType
Optional. The type of Dataflow job.
| Returns | |
|---|---|
| Type | Description |
int |
|
setType
Optional. The type of Dataflow job.
| Parameter | |
|---|---|
| Name | Description |
var |
int
|
| Returns | |
|---|---|
| Type | Description |
$this |
|
getEnvironment
Optional. The environment for the job.
| Returns | |
|---|---|
| Type | Description |
Environment|null |
|
hasEnvironment
clearEnvironment
setEnvironment
Optional. The environment for the job.
| Parameter | |
|---|---|
| Name | Description |
var |
Environment
|
| Returns | |
|---|---|
| Type | Description |
$this |
|
getSteps
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.
| Returns | |
|---|---|
| Type | Description |
Google\Protobuf\Internal\RepeatedField |
|
setSteps
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.
| Parameter | |
|---|---|
| Name | Description |
var |
array<Step>
|
| Returns | |
|---|---|
| Type | Description |
$this |
|
getStepsLocation
The Cloud Storage ___location where the steps are stored.
| Returns | |
|---|---|
| Type | Description |
string |
|
setStepsLocation
The Cloud Storage ___location where the steps are stored.
| Parameter | |
|---|---|
| Name | Description |
var |
string
|
| Returns | |
|---|---|
| Type | Description |
$this |
|
getCurrentState
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.
| Returns | |
|---|---|
| Type | Description |
int |
|
setCurrentState
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.
| Parameter | |
|---|---|
| Name | Description |
var |
int
|
| Returns | |
|---|---|
| Type | Description |
$this |
|
getCurrentStateTime
The timestamp associated with the current state.
| Returns | |
|---|---|
| Type | Description |
Google\Protobuf\Timestamp|null |
|
hasCurrentStateTime
clearCurrentStateTime
setCurrentStateTime
The timestamp associated with the current state.
| Parameter | |
|---|---|
| Name | Description |
var |
Google\Protobuf\Timestamp
|
| Returns | |
|---|---|
| Type | Description |
$this |
|
getRequestedState
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.
| Returns | |
|---|---|
| Type | Description |
int |
|
setRequestedState
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.
| Parameter | |
|---|---|
| Name | Description |
var |
int
|
| Returns | |
|---|---|
| Type | Description |
$this |
|
getExecutionInfo
Deprecated.
| Returns | |
|---|---|
| Type | Description |
JobExecutionInfo|null |
|
hasExecutionInfo
clearExecutionInfo
setExecutionInfo
Deprecated.
| Parameter | |
|---|---|
| Name | Description |
var |
JobExecutionInfo
|
| Returns | |
|---|---|
| Type | Description |
$this |
|
getCreateTime
The timestamp when the job was initially created. Immutable and set by the Cloud Dataflow service.
| Returns | |
|---|---|
| Type | Description |
Google\Protobuf\Timestamp|null |
|
hasCreateTime
clearCreateTime
setCreateTime
The timestamp when the job was initially created. Immutable and set by the Cloud Dataflow service.
| Parameter | |
|---|---|
| Name | Description |
var |
Google\Protobuf\Timestamp
|
| Returns | |
|---|---|
| Type | Description |
$this |
|
getReplaceJobId
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.
| Returns | |
|---|---|
| Type | Description |
string |
|
setReplaceJobId
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.
| Parameter | |
|---|---|
| Name | Description |
var |
string
|
| Returns | |
|---|---|
| Type | Description |
$this |
|
getTransformNameMapping
Optional. The map of transform name prefixes of the job to be replaced to the corresponding name prefixes of the new job.
| Returns | |
|---|---|
| Type | Description |
Google\Protobuf\Internal\MapField |
|
setTransformNameMapping
Optional. The map of transform name prefixes of the job to be replaced to the corresponding name prefixes of the new job.
| Parameter | |
|---|---|
| Name | Description |
var |
array|Google\Protobuf\Internal\MapField
|
| Returns | |
|---|---|
| Type | Description |
$this |
|
getClientRequestId
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.
| Returns | |
|---|---|
| Type | Description |
string |
|
setClientRequestId
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.
| Parameter | |
|---|---|
| Name | Description |
var |
string
|
| Returns | |
|---|---|
| Type | Description |
$this |
|
getReplacedByJobId
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.
| Returns | |
|---|---|
| Type | Description |
string |
|
setReplacedByJobId
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.
| Parameter | |
|---|---|
| Name | Description |
var |
string
|
| Returns | |
|---|---|
| Type | Description |
$this |
|
getTempFiles
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}
| Returns | |
|---|---|
| Type | Description |
Google\Protobuf\Internal\RepeatedField |
|
setTempFiles
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}
| Parameter | |
|---|---|
| Name | Description |
var |
string[]
|
| Returns | |
|---|---|
| Type | Description |
$this |
|
getLabels
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.
| Returns | |
|---|---|
| Type | Description |
Google\Protobuf\Internal\MapField |
|
setLabels
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.
| Parameter | |
|---|---|
| Name | Description |
var |
array|Google\Protobuf\Internal\MapField
|
| Returns | |
|---|---|
| Type | Description |
$this |
|
getLocation
Optional. The regional endpoint that contains this job.
| Returns | |
|---|---|
| Type | Description |
string |
|
setLocation
Optional. The regional endpoint that contains this job.
| Parameter | |
|---|---|
| Name | Description |
var |
string
|
| Returns | |
|---|---|
| Type | Description |
$this |
|
getPipelineDescription
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.
| Returns | |
|---|---|
| Type | Description |
PipelineDescription|null |
|
hasPipelineDescription
clearPipelineDescription
setPipelineDescription
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.
| Parameter | |
|---|---|
| Name | Description |
var |
PipelineDescription
|
| Returns | |
|---|---|
| Type | Description |
$this |
|
getStageStates
This field may be mutated by the Cloud Dataflow service; callers cannot mutate it.
| Returns | |
|---|---|
| Type | Description |
Google\Protobuf\Internal\RepeatedField |
|
setStageStates
This field may be mutated by the Cloud Dataflow service; callers cannot mutate it.
| Parameter | |
|---|---|
| Name | Description |
var |
array<ExecutionStageState>
|
| Returns | |
|---|---|
| Type | Description |
$this |
|
getJobMetadata
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.
| Returns | |
|---|---|
| Type | Description |
JobMetadata|null |
|
hasJobMetadata
clearJobMetadata
setJobMetadata
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.
| Parameter | |
|---|---|
| Name | Description |
var |
JobMetadata
|
| Returns | |
|---|---|
| Type | Description |
$this |
|
getStartTime
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.
| Returns | |
|---|---|
| Type | Description |
Google\Protobuf\Timestamp|null |
|
hasStartTime
clearStartTime
setStartTime
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.
| Parameter | |
|---|---|
| Name | Description |
var |
Google\Protobuf\Timestamp
|
| Returns | |
|---|---|
| Type | Description |
$this |
|
getCreatedFromSnapshotId
If this is specified, the job's initial state is populated from the given snapshot.
| Returns | |
|---|---|
| Type | Description |
string |
|
setCreatedFromSnapshotId
If this is specified, the job's initial state is populated from the given snapshot.
| Parameter | |
|---|---|
| Name | Description |
var |
string
|
| Returns | |
|---|---|
| Type | Description |
$this |
|
getSatisfiesPzs
Reserved for future use. This field is set only in responses from the server; it is ignored if it is set in any requests.
| Returns | |
|---|---|
| Type | Description |
bool |
|
setSatisfiesPzs
Reserved for future use. This field is set only in responses from the server; it is ignored if it is set in any requests.
| Parameter | |
|---|---|
| Name | Description |
var |
bool
|
| Returns | |
|---|---|
| Type | Description |
$this |
|
getRuntimeUpdatableParams
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.
| Returns | |
|---|---|
| Type | Description |
RuntimeUpdatableParams|null |
|
hasRuntimeUpdatableParams
clearRuntimeUpdatableParams
setRuntimeUpdatableParams
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.
| Parameter | |
|---|---|
| Name | Description |
var |
RuntimeUpdatableParams
|
| Returns | |
|---|---|
| Type | Description |
$this |
|
getSatisfiesPzi
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.
| Returns | |
|---|---|
| Type | Description |
bool |
|
hasSatisfiesPzi
clearSatisfiesPzi
setSatisfiesPzi
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.
| Parameter | |
|---|---|
| Name | Description |
var |
bool
|
| Returns | |
|---|---|
| Type | Description |
$this |
|
getServiceResources
Output only. Resources used by the Dataflow Service to run the job.
| Returns | |
|---|---|
| Type | Description |
ServiceResources|null |
|
hasServiceResources
clearServiceResources
setServiceResources
Output only. Resources used by the Dataflow Service to run the job.
| Parameter | |
|---|---|
| Name | Description |
var |
ServiceResources
|
| Returns | |
|---|---|
| Type | Description |
$this |
|