Create a Job.
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
parent
string
Required. The parent resource name where the Job will be created. Pattern: "projects/{project}/locations/{location}"
jobId
string
ID used to uniquely identify the Job within its parent scope. This field should contain at most 63 characters and must start with lowercase characters. Only lowercase characters, numbers and '-' are accepted. The '-' character cannot be the first or the last one. A system generated ID will be used if the field is not set. The job.name field in the request will be ignored and the created resource name of the Job will be "{parent}/jobs/{job_id}".
requestId
string
Optional. An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. The server will guarantee that for at least 60 minutes since the first request. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000).
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.batch.v1.projects.locations.jobs.create args : parent : ... jobId : ... requestId : ... body : allocationPolicy : instances : ... labels : ... location : allowedLocations : ... network : networkInterfaces : ... placement : collocation : ... maxDistance : ... serviceAccount : email : ... scopes : ... labels : ... logsPolicy : destination : ... logsPath : ... notifications : ... priority : ... taskGroups : ... result : createResult
JSON
[ { "create" : { "call" : "googleapis.batch.v1.projects.locations.jobs.create" , "args" : { "parent" : "..." , "jobId" : "..." , "requestId" : "..." , "body" : { "allocationPolicy" : { "instances" : "..." , "labels" : "..." , "location" : { "allowedLocations" : "..." }, "network" : { "networkInterfaces" : "..." }, "placement" : { "collocation" : "..." , "maxDistance" : "..." }, "serviceAccount" : { "email" : "..." , "scopes" : "..." } }, "labels" : "..." , "logsPolicy" : { "destination" : "..." , "logsPath" : "..." }, "notifications" : "..." , "priority" : "..." , "taskGroups" : "..." } }, "result" : "createResult" } } ]
