Method: projects.locations.clusters.patch

HTTP request
Path parameters
Query parameters
Request body
Response body
Authorization scopes
IAM Permissions
Try it!

Updates the properties of a single cluster.

HTTP request

PATCH https://managedkafka.googleapis.com/v1/{cluster.name=projects/*/locations/*/clusters/*}

The URL uses gRPC Transcoding syntax.

Path parameters

Parameters

Parameters
`cluster.name`	`string` Identifier. The name of the cluster. Structured like: projects/{projectNumber}/locations/{location}/clusters/{clusterId}

cluster.name

string

Identifier. The name of the cluster. Structured like: projects/{projectNumber}/locations/{location}/clusters/{clusterId}

Query parameters

Parameters

Parameters
`updateMask`	`string (FieldMask format)` Required. Field mask is used to specify the fields to be overwritten in the cluster resource by the update. The fields specified in the updateMask are relative to the resource, not the full request. A field will be overwritten if it is in the mask. The mask is required and a value of * will update all fields. 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 to avoid duplication of requests. If a request times out or fails, retrying with the same ID allows the server to recognize the previous attempt. For at least 60 minutes, the server ignores duplicate requests bearing the same ID. 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 within 60 minutes of the last request, the server checks if an original operation with the same request ID was received. If so, the server ignores the second request. The request ID must be a valid UUID. A zero UUID is not supported (00000000-0000-0000-0000-000000000000).

updateMask

string (FieldMask format)

Required. Field mask is used to specify the fields to be overwritten in the cluster resource by the update. The fields specified in the updateMask are relative to the resource, not the full request. A field will be overwritten if it is in the mask. The mask is required and a value of * will update all fields.

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 to avoid duplication of requests. If a request times out or fails, retrying with the same ID allows the server to recognize the previous attempt. For at least 60 minutes, the server ignores duplicate requests bearing the same ID.

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 within 60 minutes of the last request, the server checks if an original operation with the same request ID was received. If so, the server ignores the second request.

The request ID must be a valid UUID. A zero UUID is not supported (00000000-0000-0000-0000-000000000000).

Request body

The request body contains an instance of Cluster.

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:

managedkafka.clusters.update

For more information, see the IAM documentation.