Method: projects.jobs.patch

Updates a specific job resource.

Currently the only supported fields to update are labels.

HTTP request

PATCH https://ml.googleapis.com/v1/{name=projects/*/jobs/*}

The URL uses Google API HTTP annotation syntax.

Path parameters

Parameters
name

string

Required. The job name.

Authorization requires the following Google IAM permission on the specified resource name:

  • ml.jobs.update

Query parameters

Parameters
updateMask

string (FieldMask format)

Required. Specifies the path, relative to Job, of the field to update. To adopt etag mechanism, include etag field in the mask, and include the etag value in your job resource.

For example, to change the labels of a job, the updateMask parameter would be specified as labels, etag, and the PATCH request body would specify the new value, as follows: { "labels": { "owner": "Google", "color": "Blue" } "etag": "33a64df551425fcc55e4d42a148795d9f25f89d4" } If etag matches the one on the server, the labels of the job will be replaced with the given ones, and the server end etag will be recalculated.

Currently the only supported update masks are labels and etag.

A comma-separated list of fully qualified names of fields. Example: "user.displayName,photo".

Request body

The request body contains an instance of Job.

Response body

If successful, the response body contains an instance of Job.

Authorization Scopes

Requires the following OAuth scope:

  • https://www.googleapis.com/auth/cloud-platform

For more information, see the Authentication Overview.

Was this page helpful? Let us know how we did:

Send feedback about...

Cloud Machine Learning Engine (Cloud ML Engine)