dataflow
v1b3
|
#include <job.h>
Public Member Functions | |
Job (const Json::Value &storage) | |
Job (Json::Value *storage) | |
virtual | ~Job () |
const StringPiece | GetTypeName () const |
bool | has_client_request_id () const |
void | clear_client_request_id () |
const StringPiece | get_client_request_id () const |
void | set_client_request_id (const StringPiece &value) |
bool | has_create_time () const |
void | clear_create_time () |
const StringPiece | get_create_time () const |
void | set_create_time (const StringPiece &value) |
bool | has_created_from_snapshot_id () const |
void | clear_created_from_snapshot_id () |
const StringPiece | get_created_from_snapshot_id () const |
void | set_created_from_snapshot_id (const StringPiece &value) |
bool | has_current_state () const |
void | clear_current_state () |
const StringPiece | get_current_state () const |
void | set_current_state (const StringPiece &value) |
bool | has_current_state_time () const |
void | clear_current_state_time () |
const StringPiece | get_current_state_time () const |
void | set_current_state_time (const StringPiece &value) |
bool | has_environment () const |
void | clear_environment () |
const Environment | get_environment () const |
Environment | mutable_environment () |
bool | has_execution_info () const |
void | clear_execution_info () |
const JobExecutionInfo | get_execution_info () const |
JobExecutionInfo | mutable_executionInfo () |
bool | has_id () const |
void | clear_id () |
const StringPiece | get_id () const |
void | set_id (const StringPiece &value) |
bool | has_job_metadata () const |
void | clear_job_metadata () |
const JobMetadata | get_job_metadata () const |
JobMetadata | mutable_jobMetadata () |
bool | has_labels () const |
void | clear_labels () |
const client::JsonCppAssociativeArray< string > | get_labels () const |
client::JsonCppAssociativeArray< string > | mutable_labels () |
bool | has_location () const |
void | clear_location () |
const StringPiece | get_location () const |
void | set_location (const StringPiece &value) |
bool | has_name () const |
void | clear_name () |
const StringPiece | get_name () const |
void | set_name (const StringPiece &value) |
bool | has_pipeline_description () const |
void | clear_pipeline_description () |
const PipelineDescription | get_pipeline_description () const |
PipelineDescription | mutable_pipelineDescription () |
bool | has_project_id () const |
void | clear_project_id () |
const StringPiece | get_project_id () const |
void | set_project_id (const StringPiece &value) |
bool | has_replace_job_id () const |
void | clear_replace_job_id () |
const StringPiece | get_replace_job_id () const |
void | set_replace_job_id (const StringPiece &value) |
bool | has_replaced_by_job_id () const |
void | clear_replaced_by_job_id () |
const StringPiece | get_replaced_by_job_id () const |
void | set_replaced_by_job_id (const StringPiece &value) |
bool | has_requested_state () const |
void | clear_requested_state () |
const StringPiece | get_requested_state () const |
void | set_requested_state (const StringPiece &value) |
bool | has_stage_states () const |
void | clear_stage_states () |
const client::JsonCppArray< ExecutionStageState > | get_stage_states () const |
client::JsonCppArray< ExecutionStageState > | mutable_stageStates () |
bool | has_start_time () const |
void | clear_start_time () |
const StringPiece | get_start_time () const |
void | set_start_time (const StringPiece &value) |
bool | has_steps () const |
void | clear_steps () |
const client::JsonCppArray< Step > | get_steps () const |
client::JsonCppArray< Step > | mutable_steps () |
bool | has_steps_location () const |
void | clear_steps_location () |
const StringPiece | get_steps_location () const |
void | set_steps_location (const StringPiece &value) |
bool | has_temp_files () const |
void | clear_temp_files () |
const client::JsonCppArray< string > | get_temp_files () const |
client::JsonCppArray< string > | mutable_tempFiles () |
bool | has_transform_name_mapping () const |
void | clear_transform_name_mapping () |
const client::JsonCppAssociativeArray< string > | get_transform_name_mapping () const |
client::JsonCppAssociativeArray< string > | mutable_transformNameMapping () |
bool | has_type () const |
void | clear_type () |
const StringPiece | get_type () const |
void | set_type (const StringPiece &value) |
Static Public Member Functions | |
static Job * | New () |
Defines a job to be run by the Cloud Dataflow service.
|
explicit |
Standard constructor for an immutable data object instance.
[in] | storage | The underlying data storage for this instance. |
|
explicit |
Standard constructor for a mutable data object instance.
[in] | storage | The underlying data storage for this instance. |
|
virtual |
Standard destructor.
|
inline |
Clears the 'clientRequestId
' attribute.
|
inline |
Clears the 'createTime
' attribute.
|
inline |
Clears the 'createdFromSnapshotId
' attribute.
|
inline |
Clears the 'currentState
' attribute.
|
inline |
Clears the 'currentStateTime
' attribute.
|
inline |
Clears the 'environment
' attribute.
|
inline |
Clears the 'executionInfo
' attribute.
|
inline |
Clears the 'id
' attribute.
|
inline |
Clears the 'jobMetadata
' attribute.
|
inline |
Clears the 'labels
' attribute.
|
inline |
Clears the 'location
' attribute.
|
inline |
Clears the 'name
' attribute.
|
inline |
Clears the 'pipelineDescription
' attribute.
|
inline |
Clears the 'projectId
' attribute.
|
inline |
Clears the 'replaceJobId
' attribute.
|
inline |
Clears the 'replacedByJobId
' attribute.
|
inline |
Clears the 'requestedState
' attribute.
|
inline |
Clears the 'stageStates
' attribute.
|
inline |
Clears the 'startTime
' attribute.
|
inline |
Clears the 'steps
' attribute.
|
inline |
Clears the 'stepsLocation
' attribute.
|
inline |
Clears the 'tempFiles
' attribute.
|
inline |
Clears the 'transformNameMapping
' attribute.
|
inline |
Clears the 'type
' attribute.
|
inline |
Get the value of the 'clientRequestId
' attribute.
|
inline |
Get the value of the 'createTime
' attribute.
|
inline |
Get the value of the 'createdFromSnapshotId
' attribute.
|
inline |
Get the value of the 'currentState
' attribute.
|
inline |
Get the value of the 'currentStateTime
' attribute.
const Environment google_dataflow_api::Job::get_environment | ( | ) | const |
Get a reference to the value of the 'environment
' attribute.
const JobExecutionInfo google_dataflow_api::Job::get_execution_info | ( | ) | const |
Get a reference to the value of the 'executionInfo
' attribute.
|
inline |
Get the value of the 'id
' attribute.
const JobMetadata google_dataflow_api::Job::get_job_metadata | ( | ) | const |
Get a reference to the value of the 'jobMetadata
' attribute.
|
inline |
Get a reference to the value of the 'labels
' attribute.
|
inline |
Get the value of the 'location
' attribute.
|
inline |
Get the value of the 'name
' attribute.
const PipelineDescription google_dataflow_api::Job::get_pipeline_description | ( | ) | const |
Get a reference to the value of the 'pipelineDescription
' attribute.
|
inline |
Get the value of the 'projectId
' attribute.
|
inline |
Get the value of the 'replaceJobId
' attribute.
|
inline |
Get the value of the 'replacedByJobId
' attribute.
|
inline |
Get the value of the 'requestedState
' attribute.
const client::JsonCppArray<ExecutionStageState > google_dataflow_api::Job::get_stage_states | ( | ) | const |
Get a reference to the value of the 'stageStates
' attribute.
|
inline |
Get the value of the 'startTime
' attribute.
const client::JsonCppArray<Step > google_dataflow_api::Job::get_steps | ( | ) | const |
Get a reference to the value of the 'steps
' attribute.
|
inline |
Get the value of the 'stepsLocation
' attribute.
|
inline |
Get a reference to the value of the 'tempFiles
' attribute.
|
inline |
Get a reference to the value of the 'transformNameMapping
' attribute.
|
inline |
Get the value of the 'type
' attribute.
|
inline |
Returns a string denoting the type of this data object.
google_dataflow_api::Job
|
inline |
Determine if the 'clientRequestId
' attribute was set.
clientRequestId
' attribute was set.
|
inline |
Determine if the 'createTime
' attribute was set.
createTime
' attribute was set.
|
inline |
Determine if the 'createdFromSnapshotId
' attribute was set.
createdFromSnapshotId
' attribute was set.
|
inline |
Determine if the 'currentState
' attribute was set.
currentState
' attribute was set.
|
inline |
Determine if the 'currentStateTime
' attribute was set.
currentStateTime
' attribute was set.
|
inline |
Determine if the 'environment
' attribute was set.
environment
' attribute was set.
|
inline |
Determine if the 'executionInfo
' attribute was set.
executionInfo
' attribute was set.
|
inline |
Determine if the 'id
' attribute was set.
id
' attribute was set.
|
inline |
Determine if the 'jobMetadata
' attribute was set.
jobMetadata
' attribute was set.
|
inline |
Determine if the 'labels
' attribute was set.
labels
' attribute was set.
|
inline |
Determine if the 'location
' attribute was set.
location
' attribute was set.
|
inline |
Determine if the 'name
' attribute was set.
name
' attribute was set.
|
inline |
Determine if the 'pipelineDescription
' attribute was set.
pipelineDescription
' attribute was set.
|
inline |
Determine if the 'projectId
' attribute was set.
projectId
' attribute was set.
|
inline |
Determine if the 'replaceJobId
' attribute was set.
replaceJobId
' attribute was set.
|
inline |
Determine if the 'replacedByJobId
' attribute was set.
replacedByJobId
' attribute was set.
|
inline |
Determine if the 'requestedState
' attribute was set.
requestedState
' attribute was set.
|
inline |
Determine if the 'stageStates
' attribute was set.
stageStates
' attribute was set.
|
inline |
Determine if the 'startTime
' attribute was set.
startTime
' attribute was set.
|
inline |
Determine if the 'steps
' attribute was set.
steps
' attribute was set.
|
inline |
Determine if the 'stepsLocation
' attribute was set.
stepsLocation
' attribute was set.
|
inline |
Determine if the 'tempFiles
' attribute was set.
tempFiles
' attribute was set.
|
inline |
Determine if the 'transformNameMapping
' attribute was set.
transformNameMapping
' attribute was set.
|
inline |
Determine if the 'type
' attribute was set.
type
' attribute was set. Environment google_dataflow_api::Job::mutable_environment | ( | ) |
Gets a reference to a mutable value of the 'environment
' property.
The environment for the job.
JobExecutionInfo google_dataflow_api::Job::mutable_executionInfo | ( | ) |
Gets a reference to a mutable value of the 'executionInfo
' property.
Deprecated.
JobMetadata google_dataflow_api::Job::mutable_jobMetadata | ( | ) |
Gets a reference to a mutable value of the 'jobMetadata
' property.
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.
|
inline |
Gets a reference to a mutable value of the 'labels
' property.
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:
{Ll}
{Lo}{0,62}
{Ll}
{Lo}
{N}_-]{0,63}PipelineDescription google_dataflow_api::Job::mutable_pipelineDescription | ( | ) |
Gets a reference to a mutable value of the 'pipelineDescription
' property.
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.
client::JsonCppArray<ExecutionStageState > google_dataflow_api::Job::mutable_stageStates | ( | ) |
Gets a reference to a mutable value of the 'stageStates
' property.
This field may be mutated by the Cloud Dataflow service; callers cannot mutate it.
client::JsonCppArray<Step > google_dataflow_api::Job::mutable_steps | ( | ) |
Gets a reference to a mutable value of the 'steps
' property.
Exactly one of step or steps_location should be specified.
The top-level steps that constitute the entire job.
|
inline |
Gets a reference to a mutable value of the 'tempFiles
' property.
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}.
|
inline |
Gets a reference to a mutable value of the 'transformNameMapping
' property.
The map of transform name prefixes of the job to be replaced to the corresponding name prefixes of the new job.
|
static |
Creates a new default instance.
|
inline |
Change the 'clientRequestId
' attribute.
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.
[in] | value | The new value. |
|
inline |
Change the 'createTime
' attribute.
The timestamp when the job was initially created. Immutable and set by the Cloud Dataflow service.
[in] | value | The new value. |
|
inline |
Change the 'createdFromSnapshotId
' attribute.
If this is specified, the job's initial state is populated from the given snapshot.
[in] | value | The new value. |
|
inline |
Change the 'currentState
' attribute.
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.
[in] | value | The new value. |
|
inline |
Change the 'currentStateTime
' attribute.
The timestamp associated with the current state.
[in] | value | The new value. |
|
inline |
Change the 'id
' attribute.
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.
[in] | value | The new value. |
|
inline |
Change the 'location
' attribute.
The regional endpoint that contains this job.
[in] | value | The new value. |
|
inline |
Change the 'name
' attribute.
[a-z]([-a-z0-9]{0,38}[a-z0-9])?
.
[in] | value | The new value. |
|
inline |
Change the 'projectId
' attribute.
The ID of the Cloud Platform project that the job belongs to.
[in] | value | The new value. |
|
inline |
Change the 'replaceJobId
' attribute.
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.
[in] | value | The new value. |
|
inline |
Change the 'replacedByJobId
' attribute.
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.
[in] | value | The new value. |
|
inline |
Change the 'requestedState
' attribute.
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.
[in] | value | The new value. |
|
inline |
Change the 'startTime
' attribute.
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.
[in] | value | The new value. |
|
inline |
Change the 'stepsLocation
' attribute.
The GCS location where the steps are stored.
[in] | value | The new value. |
|
inline |
Change the 'type
' attribute.
The type of Cloud Dataflow job.
[in] | value | The new value. |