Method: projects.locations.global.hubs.patch

Updates the description and/or labels of the specified hub.

HTTP request

PATCH https://networkconnectivity.googleapis.com/v1/{hub.name=projects/*/locations/global/hubs/*}

The URL uses gRPC Transcoding syntax.

Path parameters

Parameters
hub.name

string

Immutable. The name of the hub. Hub names must be unique. They use the following form: projects/{projectNumber}/locations/global/hubs/{hubId}

Query parameters

Parameters
updateMask

string (FieldMask format)

Optional. In the case of an update to an existing hub, field mask is used to specify the fields to be overwritten. The fields specified in the updateMask are relative to the resource, not the full request. A field is overwritten if it is in the mask. If the user does not provide a mask, then all fields are overwritten.

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

Authorization requires the following IAM permission on the specified resource updateMask:

  • networkconnectivity.hubs.update
requestId

string

Optional. A unique request ID (optional). If you specify this ID, you can use it in cases when you need to retry your request. When you need to retry, this ID lets the server know that it can 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 to see whether the original operation was received. If it was, the server ignores the second request. This behavior prevents clients from mistakenly 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 Hub.

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.