Method: projects.locations.instances.patch

Updates the parameters of a single instance.

HTTP request

PATCH https://parallelstore.googleapis.com/v1/{instance.name=projects/*/locations/*/instances/*}

Path parameters

Parameters

Parameters
`instance.name`	`string` Identifier. The resource name of the instance, in the format `projects/{project}/locations/{location}/instances/{instanceId}`.

instance.name

string

Identifier. The resource name of the instance, in the format projects/{project}/locations/{location}/instances/{instanceId}.

Query parameters

Parameters

Parameters
`updateMask`	`string (FieldMask format)` Required. Mask of fields to update. Field mask is used to specify the fields to be overwritten in the Instance resource by the update. At least one path must be supplied in this field. The fields specified in the updateMask are relative to the resource, not the full request. 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 so that if you must retry your request, the server will know to ignore the request if it has already been completed. The server will guarantee that for at least 60 minutes since the first request. For example, consider a situation where you make an initial request and t he 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).

updateMask

string (FieldMask format)

Required. Mask of fields to update. Field mask is used to specify the fields to be overwritten in the Instance resource by the update. At least one path must be supplied in this field. The fields specified in the updateMask are relative to the resource, not the full request.

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 so that if you must retry your request, the server will know to ignore the request if it has already been completed. The server will guarantee that for at least 60 minutes since the first request.

For example, consider a situation where you make an initial request and t he 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).

Request body

The request body contains an instance of Instance.

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:

parallelstore.instances.update

For more information, see the IAM documentation.