Method: projects.locations.deployPolicies.patch

Updates the parameters of a single DeployPolicy.

HTTP request

PATCH https://clouddeploy.googleapis.com/v1/{deployPolicy.name=projects/*/locations/*/deployPolicies/*}

The URL uses gRPC Transcoding syntax.

Path parameters

Parameters
deployPolicy.name

string

Output only. Name of the DeployPolicy. Format is projects/{project}/locations/{location}/deployPolicies/{deployPolicy}. The deployPolicy component must match [a-z]([a-z0-9-]{0,61}[a-z0-9])?

Query parameters

Parameters
updateMask

string (FieldMask format)

Required. Field mask is used to specify the fields to be overwritten by the update in the DeployPolicy resource. The fields specified in the updateMask are relative to the resource, not the full request. A field will be overwritten if it's in the mask. If the user doesn'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. A 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 that 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 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).
allowMissing

boolean

Optional. If set to true, updating a DeployPolicy that does not exist will result in the creation of a new DeployPolicy.
validateOnly

boolean

Optional. If set to true, the request is validated and the user is provided with an expected result, but no actual change is made.

Request body

The request body contains an instance of DeployPolicy.

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:

  • clouddeploy.deployPolicies.update

For more information, see the IAM documentation.