Method: projects.locations.repositories.workflowConfigs.patch

Updates a single WorkflowConfig.

Note: This method does not fully implement AIP/134. The wildcard entry (*) is treated as a bad request, and when the field_mask is omitted, the request is treated as a full update on all modifiable fields.

HTTP request

PATCH https://dataform.googleapis.com/v1/{workflowConfig.name=projects/*/locations/*/repositories/*/workflowConfigs/*}

The URL uses gRPC Transcoding syntax.

Path parameters

Parameters
workflowConfig.name

string

Identifier. The workflow config's name.

Query parameters

Parameters
updateMask

string (FieldMask format)

Optional. Specifies the fields to be updated in the workflow config. If left unset, all fields will be updated.

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

Request body

The request body contains an instance of WorkflowConfig.

Response body

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

Authorization scopes

Requires one of the following OAuth scopes:

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

For more information, see the Authentication Overview.

IAM Permissions

Requires the following IAM permission on the name resource:

  • dataform.workflowConfigs.update

For more information, see the IAM documentation.