Google Cloud Dataflow V1beta3 Client - Class Job (0.6.5)

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.

Generated from protobuf message google.dataflow.v1beta3.Job

Namespace

Google \ Cloud \ Dataflow \ V1beta3

Methods

__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 Cloud Dataflow service when the Job is created, and is immutable for the life of the job.
↳ project_id string

The ID of the Cloud Platform project that the job belongs to.
↳ name string

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,1022}[a-z0-9])?
↳ type int

The type of Cloud Dataflow job.
↳ environment Environment

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 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.
↳ current_state_time Google\Protobuf\Timestamp

The timestamp associated with the current state.
↳ requested_state int

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.
↳ 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 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.
↳ transform_name_mapping array|Google\Protobuf\Internal\MapField

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 JOB_STATE_UPDATED), this field contains the ID of that job.
↳ 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

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.

getId

The unique ID of this job.

This field is set by the Cloud 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 Cloud 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 Cloud Platform project that the job belongs to.

Returns
Type Description
string

setProjectId

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

Parameter
Name Description
var string
Returns
Type Description
$this

getName

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,1022}[a-z0-9])?

Returns
Type Description
string

setName

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,1022}[a-z0-9])?

Parameter
Name Description
var string
Returns
Type Description
$this

getType

The type of Cloud Dataflow job.

Returns
Type Description
int

setType

The type of Cloud Dataflow job.

Parameter
Name Description
var int
Returns
Type Description
$this

getEnvironment

The environment for the job.

Returns
Type Description
Environment|null

hasEnvironment

clearEnvironment

setEnvironment

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 may be mutated by the Cloud 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 may be mutated by the Cloud 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.

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.

Returns
Type Description
int

setRequestedState

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.

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

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

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

The regional endpoint that contains this job.

Returns
Type Description
string

setLocation

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