patch method
Updates an instance, and begins allocating or releasing resources as requested.
The returned long-running operation can be used to track the progress of
updating the instance. If the named instance does not exist, returns
NOT_FOUND
. Immediately upon completion of this request: * For resource
types for which a decrease in the instance's allocation has been
requested, billing is based on the newly-requested level. Until completion
of the returned operation: * Cancelling the operation sets its metadata's
cancel_time, and begins restoring resources to their pre-request values.
The operation is guaranteed to succeed at undoing all resource changes,
after which point it terminates with a CANCELLED
status. * All other
attempts to modify the instance are rejected. * Reading the instance via
the API continues to give the pre-request resource levels. Upon completion
of the returned operation: * Billing begins for all successfully-allocated
resources (some types may have lower than the requested levels). * All
newly-reserved resources are available for serving the instance's tables.
- The instance's new resource levels are readable via the API. The
returned long-running operation will have a name of the format
/operations/
and can be used to track the instance modification. The metadata field type is UpdateInstanceMetadata. The response field type is Instance, if successful. Authorization requiresspanner.instances.update
permission on the resource name.
request
- The metadata request object.
Request parameters:
name
- Required. A unique identifier for the instance, which cannot be
changed after the instance is created. Values are of the form
projects//instances/a-z*[a-z0-9]
. The final segment of the name must be
between 2 and 64 characters in length.
Value must have pattern ^projects/\[^/\]+/instances/\[^/\]+$
.
$fields
- Selector specifying which fields to include in a partial
response.
Completes with a Operation.
Completes with a commons.ApiRequestError if the API endpoint returned an error.
If the used http.Client
completes with an error when making a REST call,
this method will complete with the same error.
Implementation
async.Future<Operation> patch(
UpdateInstanceRequest request,
core.String name, {
core.String? $fields,
}) async {
final body_ = convert.json.encode(request);
final queryParams_ = <core.String, core.List<core.String>>{
if ($fields != null) 'fields': [$fields],
};
final url_ = 'v1/' + core.Uri.encodeFull('$name');
final response_ = await _requester.request(
url_,
'PATCH',
body: body_,
queryParams: queryParams_,
);
return Operation.fromJson(response_ as core.Map<core.String, core.dynamic>);
}