Struct google_spanner1::ProjectInstancePatchCall

source ·

pub struct ProjectInstancePatchCall<'a, C, A>where
    C: 'a,
    A: 'a,{ /* private fields */ }

Expand description

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 <instance_name>/operations/<operation_id> and can be used to track the instance modification. The metadata field type is UpdateInstanceMetadata. The response field type is Instance, if successful.

Authorization requires spanner.instances.update permission on resource name.

A builder for the instances.patch method supported by a project resource. It is not used directly, but through a ProjectMethods instance.

Example

Instantiate a resource method builder

use spanner1::UpdateInstanceRequest;
 
// As the method needs a request, you would usually fill it with the desired information
// into the respective structure. Some of the parts shown here might not be applicable !
// Values shown here are possibly random and not representative !
let mut req = UpdateInstanceRequest::default();
 
// You can configure optional parameters by calling the respective setters at will, and
// execute the final call using `doit()`.
// Values shown here are possibly random and not representative !
let result = hub.projects().instances_patch(req, "name")
             .doit();

Implementations§

source §

impl<'a, C, A> ProjectInstancePatchCall<'a, C, A>where
C: BorrowMut<Client>,
A: GetToken,

source

pub fn doit(self) -> Result<(Response, Operation)>

Perform the operation you have build so far.

source

pub fn request(
self,
new_value: UpdateInstanceRequest
) -> ProjectInstancePatchCall<'a, C, A>

Sets the request property to the given value.

Even though the property as already been set when instantiating this call, we provide this method for API completeness.

source

pub fn name(self, new_value: &str) -> ProjectInstancePatchCall<'a, C, A>

Required. A unique identifier for the instance, which cannot be changed after the instance is created. Values are of the form projects/<project>/instances/a-z*[a-z0-9]. The final segment of the name must be between 6 and 30 characters in length.

Sets the name path property to the given value.

Even though the property as already been set when instantiating this call, we provide this method for API completeness.

source

pub fn delegate(
self,
new_value: &'a mut dyn Delegate
) -> ProjectInstancePatchCall<'a, C, A>

The delegate implementation is consulted whenever there is an intermediate result, or if something goes wrong while executing the actual API request.

It should be used to handle progress information, and to implement a certain level of resilience.

Sets the delegate property to the given value.

source

pub fn param<T>(self, name: T, value: T) -> ProjectInstancePatchCall<'a, C, A>where
T: AsRef<str>,

Set any additional parameter of the query string used in the request. It should be used to set parameters which are not yet available through their own setters.

Please note that this method must not be used to set any of the known paramters which have their own setter method. If done anyway, the request will fail.

Additional Parameters

upload_protocol (query-string) - Upload protocol for media (e.g. “raw”, “multipart”).
prettyPrint (query-boolean) - Returns response with indentations and line breaks.
access_token (query-string) - OAuth access token.
fields (query-string) - Selector specifying which fields to include in a partial response.
quotaUser (query-string) - Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.
callback (query-string) - JSONP
oauth_token (query-string) - OAuth 2.0 token for the current user.
key (query-string) - API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.
uploadType (query-string) - Legacy upload protocol for media (e.g. “media”, “multipart”).
alt (query-string) - Data format for response.
$.xgafv (query-string) - V1 error format.

source

pub fn add_scope<T, S>(self, scope: T) -> ProjectInstancePatchCall<'a, C, A>where
T: Into<Option<S>>,
S: AsRef<str>,

Identifies the authorization scope for the method you are building.

Use this method to actively specify which scope should be used, instead the default Scope variant Scope::CloudPlatform.

The scope will be added to a set of scopes. This is important as one can maintain access tokens for more than one scope. If None is specified, then all scopes will be removed and no default scope will be used either. In that case, you have to specify your API-key using the key parameter (see the param() function for details).

Usually there is more than one suitable scope to authorize an operation, some of which may encompass more rights than others. For example, for listing resources, a read-only scope will be sufficient, a read-write scope will do as well.