Method: projects.locations.jobs.patch

Updates the parameters of a single job.

HTTP request

PATCH https://managedflink.googleapis.com/v1alpha/{job.name=projects/*/locations/*/jobs/*}

The URL uses gRPC Transcoding syntax.

Path parameters

Parameters
job.name

string

Identifier. The name of the job.

Query parameters

Parameters
updateMask

string (FieldMask format)

Required. The field mask is used to specify the fields to be overwritten in the job resource by the update. The fields specified in updateMask are relative to the resource, not to the full request. A field is overwritten if it's in the mask. If you don't provide a mask, then all fields are overwritten.

This is a comma-separated list of fully qualified names of fields. Example: "user.displayName,photo".
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 knows to ignore the request if it has already been completed. The server guarantees this behavior for at least 60 minutes after 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 the original operation with the same request ID was received. If the request was received, the server ignores the second request. This behavior 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).

Request body

The request body contains an instance of Job.

Response body

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

Authorization scopes

Requires the following OAuth scope:

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

For more information, see the Authentication Overview.

IAM Permissions

Requires the following IAM permission on the name resource:

  • managedflink.jobs.update

For more information, see the IAM documentation.