Creates a Cloud Dataflow job. To create a job, we recommend using projects.locations.jobs.create
with a regional endpoint
.
Using projects.jobs.create
is not recommended, as your job will always
start in us-central1
.
This method waits—the workflow execution is paused—until the operation is
complete, fails, or times out. The default timeout value is 1800
seconds (30
minutes) and can be changed to a maximum value of 31536000
seconds (one year)
for long-running operations using the connector_params
field. See the Connectors reference
.
The connector uses polling to monitor the long-running operation, which might generate additional billable steps. For more information about retries and long-running operations, refer to Understand connectors .
The polling policy for the long-running operation can be configured. To set the
connector-specific parameters ( connector_params
), refer to Invoke a connector call
.
Arguments
projectId
string
Required. The ID of the Cloud Platform project that the job belongs to.
location
string
The regional endpoint that contains this job.
replaceJobId
string
Deprecated. This field is now in the Job message.
view
enum
The level of information requested in response.
JOB_VIEW_UNKNOWN
JOB_VIEW_SUMMARY
information, and may contain additional information.JOB_VIEW_SUMMARY
JOB_VIEW_ALL
JOB_VIEW_DESCRIPTION
body
object ( Job
)
Required.
Raised exceptions
ConnectionError
HttpError
TimeoutError
TypeError
ValueError
OperationError
ResponseTypeError
Response
If successful, the response contains an instance of Job
.
Subworkflow snippet
Some fields might be optional or required. To identify required fields, refer to the API documentation .
YAML
- create : call : googleapis.dataflow.v1b3.projects.jobs.create args : projectId : ... location : ... replaceJobId : ... view : ... body : clientRequestId : ... createTime : ... createdFromSnapshotId : ... currentState : ... currentStateTime : ... environment : clusterManagerApiService : ... dataset : ... debugOptions : enableHotKeyLogging : ... experiments : ... flexResourceSchedulingGoal : ... internalExperiments : ... sdkPipelineOptions : ... serviceAccountEmail : ... serviceKmsKeyName : ... serviceOptions : ... tempStoragePrefix : ... userAgent : ... version : ... workerPools : ... workerRegion : ... workerZone : ... executionInfo : stages : ... id : ... jobMetadata : bigTableDetails : ... bigqueryDetails : ... datastoreDetails : ... fileDetails : ... pubsubDetails : ... sdkVersion : sdkSupportStatus : ... version : ... versionDisplayName : ... spannerDetails : ... labels : ... location : ... name : ... pipelineDescription : displayData : ... executionPipelineStage : ... originalPipelineTransform : ... projectId : ... replaceJobId : ... replacedByJobId : ... requestedState : ... satisfiesPzs : ... stageStates : ... startTime : ... steps : ... stepsLocation : ... tempFiles : ... transformNameMapping : ... type : ... result : createResult
JSON
[ { "create" : { "call" : "googleapis.dataflow.v1b3.projects.jobs.create" , "args" : { "projectId" : "..." , "location" : "..." , "replaceJobId" : "..." , "view" : "..." , "body" : { "clientRequestId" : "..." , "createTime" : "..." , "createdFromSnapshotId" : "..." , "currentState" : "..." , "currentStateTime" : "..." , "environment" : { "clusterManagerApiService" : "..." , "dataset" : "..." , "debugOptions" : { "enableHotKeyLogging" : "..." }, "experiments" : "..." , "flexResourceSchedulingGoal" : "..." , "internalExperiments" : "..." , "sdkPipelineOptions" : "..." , "serviceAccountEmail" : "..." , "serviceKmsKeyName" : "..." , "serviceOptions" : "..." , "tempStoragePrefix" : "..." , "userAgent" : "..." , "version" : "..." , "workerPools" : "..." , "workerRegion" : "..." , "workerZone" : "..." }, "executionInfo" : { "stages" : "..." }, "id" : "..." , "jobMetadata" : { "bigTableDetails" : "..." , "bigqueryDetails" : "..." , "datastoreDetails" : "..." , "fileDetails" : "..." , "pubsubDetails" : "..." , "sdkVersion" : { "sdkSupportStatus" : "..." , "version" : "..." , "versionDisplayName" : "..." }, "spannerDetails" : "..." }, "labels" : "..." , "location" : "..." , "name" : "..." , "pipelineDescription" : { "displayData" : "..." , "executionPipelineStage" : "..." , "originalPipelineTransform" : "..." }, "projectId" : "..." , "replaceJobId" : "..." , "replacedByJobId" : "..." , "requestedState" : "..." , "satisfiesPzs" : "..." , "stageStates" : "..." , "startTime" : "..." , "steps" : "..." , "stepsLocation" : "..." , "tempFiles" : "..." , "transformNameMapping" : "..." , "type" : "..." } }, "result" : "createResult" } } ]
