Method: projects.locations.spokes.patch

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

Updates the parameters of a Network Connectivity Center spoke.

HTTP request

PATCH https://networkconnectivity.googleapis.com/v1/{spoke.name=projects/*/locations/*/spokes/*}

The URL uses gRPC Transcoding syntax.

Path parameters

Parameters

Parameters
`spoke.name`	`string` Immutable. The name of the spoke. Spoke names must be unique. They use the following form: `projects/{projectNumber}/locations/{region}/spokes/{spokeId}`

spoke.name

string

Immutable. The name of the spoke. Spoke names must be unique. They use the following form: projects/{projectNumber}/locations/{region}/spokes/{spokeId}

Query parameters

Parameters

Parameters
`updateMask`	`string (FieldMask format)` Optional. In the case of an update to an existing spoke, 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.spokes.update`
`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 a request doesn't result in creation of duplicate commitments for at least 60 minutes. 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).

updateMask

string (FieldMask format)

Optional. In the case of an update to an existing spoke, 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.spokes.update

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 a request doesn't result in creation of duplicate commitments for at least 60 minutes.

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 Spoke.

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.