Struct ProjectInstanceConfigPatchCall

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

Updates an instance config. The returned long-running operation can be used to track the progress of updating the instance. If the named instance config does not exist, returns NOT_FOUND. Only user managed configurations can be updated. Immediately after the request returns: * The instance config’s reconciling field is set to true. While the operation is pending: * Cancelling the operation sets its metadata’s cancel_time. The operation is guaranteed to succeed at undoing all changes, after which point it terminates with a CANCELLED status. * All other attempts to modify the instance config are rejected. * Reading the instance config via the API continues to give the pre-request values. Upon completion of the returned operation: * Creating instances using the instance configuration uses the new values. * The instance config’s new values are readable via the API. * The instance config’s reconciling field becomes false. The returned long-running operation will have a name of the format /operations/ and can be used to track the instance config modification. The metadata field type is UpdateInstanceConfigMetadata. The response field type is InstanceConfig, if successful. Authorization requires spanner.instanceConfigs.update permission on the resource name.

A builder for the instanceConfigs.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::api::UpdateInstanceConfigRequest;


// 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 = UpdateInstanceConfigRequest::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().instance_configs_patch(req, "name")
             .doit().await;

Implementations

impl<'a, C> ProjectInstanceConfigPatchCall<'a, C>

where C: Connector,

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

Perform the operation you have build so far.

pub fn request( self, new_value: UpdateInstanceConfigRequest, ) -> ProjectInstanceConfigPatchCall<'a, C>

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.

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

A unique identifier for the instance configuration. Values are of the form projects//instanceConfigs/a-z*. User instance config must start with custom-.

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.

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

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.

pub fn param<T>( self, name: T, value: T, ) -> ProjectInstanceConfigPatchCall<'a, C>

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 parameters which have their own setter method. If done anyway, the request will fail.

Additional Parameters

• $.xgafv (query-string) - V1 error format.
• access_token (query-string) - OAuth access token.
• alt (query-string) - Data format for response.
• callback (query-string) - JSONP
• fields (query-string) - Selector specifying which fields to include in a partial response.
• 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.
• oauth_token (query-string) - OAuth 2.0 token for the current user.
• prettyPrint (query-boolean) - Returns response with indentations and line breaks.
• 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.
• uploadType (query-string) - Legacy upload protocol for media (e.g. “media”, “multipart”).
• upload_protocol (query-string) - Upload protocol for media (e.g. “raw”, “multipart”).

pub fn add_scope<St>(self, scope: St) -> ProjectInstanceConfigPatchCall<'a, C>

where St: AsRef<str>,

Identifies the authorization scope for the method you are building.

Use this method to actively specify which scope should be used, instead of 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.

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.

pub fn add_scopes<I, St>( self, scopes: I, ) -> ProjectInstanceConfigPatchCall<'a, C>

where I: IntoIterator<Item = St>, St: AsRef<str>,

Identifies the authorization scope(s) for the method you are building.

See Self::add_scope() for details.

pub fn clear_scopes(self) -> ProjectInstanceConfigPatchCall<'a, C>

Removes all scopes, and no default scope will be used either. In this case, you have to specify your API-key using the key parameter (see Self::param() for details).

Trait Implementations

impl<'a, C> CallBuilder for ProjectInstanceConfigPatchCall<'a, C>