[−][src]Struct google_spanner1::ProjectInstanceCreateCall
Creates an instance and begins preparing it to begin serving. The
returned long-running operation
can be used to track the progress of preparing the new
instance. The instance name is assigned by the caller. If the
named instance already exists, CreateInstance
returns
ALREADY_EXISTS
.
Immediately upon completion of this request:
- The instance is readable via the API, with all requested attributes
but no allocated resources. Its state is
CREATING
.
Until completion of the returned operation:
- Cancelling the operation renders the instance immediately unreadable via the API.
- The instance can be deleted.
- All other attempts to modify the instance are rejected.
Upon completion of the returned operation:
- Billing for all successfully-allocated resources begins (some types may have lower than the requested levels).
- Databases can be created in the instance.
- The instance's allocated resource levels are readable via the API.
- The instance's state becomes
READY
.
The returned long-running operation will
have a name of the format <instance_name>/operations/<operation_id>
and
can be used to track creation of the instance. The
metadata field type is
CreateInstanceMetadata.
The response field type is
Instance, if successful.
A builder for the instances.create method supported by a project resource.
It is not used directly, but through a ProjectMethods
instance.
Example
Instantiate a resource method builder
use spanner1::CreateInstanceRequest; // 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 = CreateInstanceRequest::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_create(req, "parent") .doit();
Methods
impl<'a, C, A> ProjectInstanceCreateCall<'a, C, A> where
C: BorrowMut<Client>,
A: GetToken,
[src]
C: BorrowMut<Client>,
A: GetToken,
pub fn doit(self) -> Result<(Response, Operation)>
[src]
Perform the operation you have build so far.
pub fn request(
self,
new_value: CreateInstanceRequest
) -> ProjectInstanceCreateCall<'a, C, A>
[src]
self,
new_value: CreateInstanceRequest
) -> ProjectInstanceCreateCall<'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.
pub fn parent(self, new_value: &str) -> ProjectInstanceCreateCall<'a, C, A>
[src]
Required. The name of the project in which to create the instance. Values
are of the form projects/<project>
.
Sets the parent 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
) -> ProjectInstanceCreateCall<'a, C, A>
[src]
self,
new_value: &'a mut dyn Delegate
) -> ProjectInstanceCreateCall<'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.
pub fn param<T>(self, name: T, value: T) -> ProjectInstanceCreateCall<'a, C, A> where
T: AsRef<str>,
[src]
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
- 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.
pub fn add_scope<T, S>(self, scope: T) -> ProjectInstanceCreateCall<'a, C, A> where
T: Into<Option<S>>,
S: AsRef<str>,
[src]
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.
Trait Implementations
impl<'a, C, A> CallBuilder for ProjectInstanceCreateCall<'a, C, A>
[src]
Auto Trait Implementations
impl<'a, C, A> !Send for ProjectInstanceCreateCall<'a, C, A>
impl<'a, C, A> !Sync for ProjectInstanceCreateCall<'a, C, A>
impl<'a, C, A> Unpin for ProjectInstanceCreateCall<'a, C, A>
impl<'a, C, A> !UnwindSafe for ProjectInstanceCreateCall<'a, C, A>
impl<'a, C, A> !RefUnwindSafe for ProjectInstanceCreateCall<'a, C, A>
Blanket Implementations
impl<T> From<T> for T
[src]
impl<T, U> Into<U> for T where
U: From<T>,
[src]
U: From<T>,
impl<T, U> TryFrom<U> for T where
U: Into<T>,
[src]
U: Into<T>,
type Error = !
The type returned in the event of a conversion error.
fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>
[src]
impl<T, U> TryInto<U> for T where
U: TryFrom<T>,
[src]
U: TryFrom<T>,
type Error = <U as TryFrom<T>>::Error
The type returned in the event of a conversion error.
fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>
[src]
impl<T> Borrow<T> for T where
T: ?Sized,
[src]
T: ?Sized,
impl<T> BorrowMut<T> for T where
T: ?Sized,
[src]
T: ?Sized,
fn borrow_mut(&mut self) -> &mut T
[src]
impl<T> Any for T where
T: 'static + ?Sized,
[src]
T: 'static + ?Sized,
impl<T> Typeable for T where
T: Any,
T: Any,