#![allow(clippy::ptr_arg)] use std::collections::{BTreeSet, HashMap}; use tokio::time::sleep; // ############## // UTILITIES ### // ############ /// Identifies the an OAuth2 authorization scope. /// A scope is needed when requesting an /// [authorization token](https://developers.google.com/youtube/v3/guides/authentication). #[derive(PartialEq, Eq, Ord, PartialOrd, Hash, Debug, Clone, Copy)] pub enum Scope { /// See, edit, configure, and delete your Google Cloud data and see the email address for your Google Account. CloudPlatform, } impl AsRef for Scope { fn as_ref(&self) -> &str { match *self { Scope::CloudPlatform => "https://www.googleapis.com/auth/cloud-platform", } } } #[allow(clippy::derivable_impls)] impl Default for Scope { fn default() -> Scope { Scope::CloudPlatform } } // ######## // HUB ### // ###### /// Central instance to access all CloudShell related resource activities /// /// # Examples /// /// Instantiate a new hub /// /// ```test_harness,no_run /// extern crate hyper; /// extern crate hyper_rustls; /// extern crate google_cloudshell1 as cloudshell1; /// use cloudshell1::{Result, Error}; /// # async fn dox() { /// use cloudshell1::{CloudShell, FieldMask, hyper_rustls, hyper_util, yup_oauth2}; /// /// // Get an ApplicationSecret instance by some means. It contains the `client_id` and /// // `client_secret`, among other things. /// let secret: yup_oauth2::ApplicationSecret = Default::default(); /// // Instantiate the authenticator. It will choose a suitable authentication flow for you, /// // unless you replace `None` with the desired Flow. /// // Provide your own `AuthenticatorDelegate` to adjust the way it operates and get feedback about /// // what's going on. You probably want to bring in your own `TokenStorage` to persist tokens and /// // retrieve them from storage. /// let auth = yup_oauth2::InstalledFlowAuthenticator::builder( /// secret, /// yup_oauth2::InstalledFlowReturnMethod::HTTPRedirect, /// ).build().await.unwrap(); /// /// let client = hyper_util::client::legacy::Client::builder( /// hyper_util::rt::TokioExecutor::new() /// ) /// .build( /// hyper_rustls::HttpsConnectorBuilder::new() /// .with_native_roots() /// .unwrap() /// .https_or_http() /// .enable_http1() /// .build() /// ); /// let mut hub = CloudShell::new(client, auth); /// // 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.operations().list("name") /// .page_token("takimata") /// .page_size(-52) /// .filter("duo") /// .doit().await; /// /// match result { /// Err(e) => match e { /// // The Error enum provides details about what exactly happened. /// // You can also just use its `Debug`, `Display` or `Error` traits /// Error::HttpError(_) /// |Error::Io(_) /// |Error::MissingAPIKey /// |Error::MissingToken(_) /// |Error::Cancelled /// |Error::UploadSizeLimitExceeded(_, _) /// |Error::Failure(_) /// |Error::BadRequest(_) /// |Error::FieldClash(_) /// |Error::JsonDecodeError(_, _) => println!("{}", e), /// }, /// Ok(res) => println!("Success: {:?}", res), /// } /// # } /// ``` #[derive(Clone)] pub struct CloudShell { pub client: common::Client, pub auth: Box, _user_agent: String, _base_url: String, _root_url: String, } impl common::Hub for CloudShell {} impl<'a, C> CloudShell { pub fn new(client: common::Client, auth: A) -> CloudShell { CloudShell { client, auth: Box::new(auth), _user_agent: "google-api-rust-client/6.0.0".to_string(), _base_url: "https://cloudshell.googleapis.com/".to_string(), _root_url: "https://cloudshell.googleapis.com/".to_string(), } } pub fn operations(&'a self) -> OperationMethods<'a, C> { OperationMethods { hub: self } } pub fn users(&'a self) -> UserMethods<'a, C> { UserMethods { hub: self } } /// Set the user-agent header field to use in all requests to the server. /// It defaults to `google-api-rust-client/6.0.0`. /// /// Returns the previously set user-agent. pub fn user_agent(&mut self, agent_name: String) -> String { std::mem::replace(&mut self._user_agent, agent_name) } /// Set the base url to use in all requests to the server. /// It defaults to `https://cloudshell.googleapis.com/`. /// /// Returns the previously set base url. pub fn base_url(&mut self, new_base_url: String) -> String { std::mem::replace(&mut self._base_url, new_base_url) } /// Set the root url to use in all requests to the server. /// It defaults to `https://cloudshell.googleapis.com/`. /// /// Returns the previously set root url. pub fn root_url(&mut self, new_root_url: String) -> String { std::mem::replace(&mut self._root_url, new_root_url) } } // ############ // SCHEMAS ### // ########## /// Request message for AddPublicKey. /// /// # Activities /// /// This type is used in activities, which are methods you may call on this type or where this type is involved in. /// The list links the activity name, along with information about where it is used (one of *request* and *response*). /// /// * [environments add public key users](UserEnvironmentAddPublicKeyCall) (request) #[cfg_attr(feature = "utoipa", derive(utoipa::ToSchema))] #[serde_with::serde_as] #[derive(Default, Clone, Debug, serde::Serialize, serde::Deserialize)] pub struct AddPublicKeyRequest { /// Key that should be added to the environment. Supported formats are `ssh-dss` (see RFC4253), `ssh-rsa` (see RFC4253), `ecdsa-sha2-nistp256` (see RFC5656), `ecdsa-sha2-nistp384` (see RFC5656) and `ecdsa-sha2-nistp521` (see RFC5656). It should be structured as , where part is encoded with Base64. pub key: Option, } impl common::RequestValue for AddPublicKeyRequest {} /// Request message for AuthorizeEnvironment. /// /// # Activities /// /// This type is used in activities, which are methods you may call on this type or where this type is involved in. /// The list links the activity name, along with information about where it is used (one of *request* and *response*). /// /// * [environments authorize users](UserEnvironmentAuthorizeCall) (request) #[cfg_attr(feature = "utoipa", derive(utoipa::ToSchema))] #[serde_with::serde_as] #[derive(Default, Clone, Debug, serde::Serialize, serde::Deserialize)] pub struct AuthorizeEnvironmentRequest { /// The OAuth access token that should be sent to the environment. #[serde(rename = "accessToken")] pub access_token: Option, /// The time when the credentials expire. If not set, defaults to one hour from when the server received the request. #[serde(rename = "expireTime")] pub expire_time: Option>, /// The OAuth ID token that should be sent to the environment. #[serde(rename = "idToken")] pub id_token: Option, } impl common::RequestValue for AuthorizeEnvironmentRequest {} /// The request message for Operations.CancelOperation. /// /// # Activities /// /// This type is used in activities, which are methods you may call on this type or where this type is involved in. /// The list links the activity name, along with information about where it is used (one of *request* and *response*). /// /// * [cancel operations](OperationCancelCall) (request) #[cfg_attr(feature = "utoipa", derive(utoipa::ToSchema))] #[serde_with::serde_as] #[derive(Default, Clone, Debug, serde::Serialize, serde::Deserialize)] pub struct CancelOperationRequest { _never_set: Option, } impl common::RequestValue for CancelOperationRequest {} /// A generic empty message that you can re-use to avoid defining duplicated empty messages in your APIs. A typical example is to use it as the request or the response type of an API method. For instance: service Foo { rpc Bar(google.protobuf.Empty) returns (google.protobuf.Empty); } /// /// # Activities /// /// This type is used in activities, which are methods you may call on this type or where this type is involved in. /// The list links the activity name, along with information about where it is used (one of *request* and *response*). /// /// * [cancel operations](OperationCancelCall) (response) /// * [delete operations](OperationDeleteCall) (response) #[cfg_attr(feature = "utoipa", derive(utoipa::ToSchema))] #[serde_with::serde_as] #[derive(Default, Clone, Debug, serde::Serialize, serde::Deserialize)] pub struct Empty { _never_set: Option, } impl common::ResponseResult for Empty {} /// A Cloud Shell environment, which is defined as the combination of a Docker image specifying what is installed on the environment and a home directory containing the user’s data that will remain across sessions. Each user has at least an environment with the ID “default”. /// /// # Activities /// /// This type is used in activities, which are methods you may call on this type or where this type is involved in. /// The list links the activity name, along with information about where it is used (one of *request* and *response*). /// /// * [environments get users](UserEnvironmentGetCall) (response) #[cfg_attr(feature = "utoipa", derive(utoipa::ToSchema))] #[serde_with::serde_as] #[derive(Default, Clone, Debug, serde::Serialize, serde::Deserialize)] pub struct Environment { /// Required. Immutable. Full path to the Docker image used to run this environment, e.g. "gcr.io/dev-con/cloud-devshell:latest". #[serde(rename = "dockerImage")] pub docker_image: Option, /// Output only. The environment's identifier, unique among the user's environments. pub id: Option, /// Immutable. Full name of this resource, in the format `users/{owner_email}/environments/{environment_id}`. `{owner_email}` is the email address of the user to whom this environment belongs, and `{environment_id}` is the identifier of this environment. For example, `users/someone@example.com/environments/default`. pub name: Option, /// Output only. Public keys associated with the environment. Clients can connect to this environment via SSH only if they possess a private key corresponding to at least one of these public keys. Keys can be added to or removed from the environment using the AddPublicKey and RemovePublicKey methods. #[serde(rename = "publicKeys")] pub public_keys: Option>, /// Output only. Host to which clients can connect to initiate SSH sessions with the environment. #[serde(rename = "sshHost")] pub ssh_host: Option, /// Output only. Port to which clients can connect to initiate SSH sessions with the environment. #[serde(rename = "sshPort")] pub ssh_port: Option, /// Output only. Username that clients should use when initiating SSH sessions with the environment. #[serde(rename = "sshUsername")] pub ssh_username: Option, /// Output only. Current execution state of this environment. pub state: Option, /// Output only. Host to which clients can connect to initiate HTTPS or WSS connections with the environment. #[serde(rename = "webHost")] pub web_host: Option, } impl common::ResponseResult for Environment {} /// The response message for Operations.ListOperations. /// /// # Activities /// /// This type is used in activities, which are methods you may call on this type or where this type is involved in. /// The list links the activity name, along with information about where it is used (one of *request* and *response*). /// /// * [list operations](OperationListCall) (response) #[cfg_attr(feature = "utoipa", derive(utoipa::ToSchema))] #[serde_with::serde_as] #[derive(Default, Clone, Debug, serde::Serialize, serde::Deserialize)] pub struct ListOperationsResponse { /// The standard List next-page token. #[serde(rename = "nextPageToken")] pub next_page_token: Option, /// A list of operations that matches the specified filter in the request. pub operations: Option>, } impl common::ResponseResult for ListOperationsResponse {} /// This resource represents a long-running operation that is the result of a network API call. /// /// # Activities /// /// This type is used in activities, which are methods you may call on this type or where this type is involved in. /// The list links the activity name, along with information about where it is used (one of *request* and *response*). /// /// * [cancel operations](OperationCancelCall) (none) /// * [delete operations](OperationDeleteCall) (none) /// * [get operations](OperationGetCall) (response) /// * [list operations](OperationListCall) (none) /// * [environments add public key users](UserEnvironmentAddPublicKeyCall) (response) /// * [environments authorize users](UserEnvironmentAuthorizeCall) (response) /// * [environments remove public key users](UserEnvironmentRemovePublicKeyCall) (response) /// * [environments start users](UserEnvironmentStartCall) (response) #[cfg_attr(feature = "utoipa", derive(utoipa::ToSchema))] #[serde_with::serde_as] #[derive(Default, Clone, Debug, serde::Serialize, serde::Deserialize)] pub struct Operation { /// If the value is `false`, it means the operation is still in progress. If `true`, the operation is completed, and either `error` or `response` is available. pub done: Option, /// The error result of the operation in case of failure or cancellation. pub error: Option, /// Service-specific metadata associated with the operation. It typically contains progress information and common metadata such as create time. Some services might not provide such metadata. Any method that returns a long-running operation should document the metadata type, if any. pub metadata: Option>, /// The server-assigned name, which is only unique within the same service that originally returns it. If you use the default HTTP mapping, the `name` should be a resource name ending with `operations/{unique_id}`. pub name: Option, /// The normal, successful response of the operation. If the original method returns no data on success, such as `Delete`, the response is `google.protobuf.Empty`. If the original method is standard `Get`/`Create`/`Update`, the response should be the resource. For other methods, the response should have the type `XxxResponse`, where `Xxx` is the original method name. For example, if the original method name is `TakeSnapshot()`, the inferred response type is `TakeSnapshotResponse`. pub response: Option>, } impl common::Resource for Operation {} impl common::ResponseResult for Operation {} /// Request message for RemovePublicKey. /// /// # Activities /// /// This type is used in activities, which are methods you may call on this type or where this type is involved in. /// The list links the activity name, along with information about where it is used (one of *request* and *response*). /// /// * [environments remove public key users](UserEnvironmentRemovePublicKeyCall) (request) #[cfg_attr(feature = "utoipa", derive(utoipa::ToSchema))] #[serde_with::serde_as] #[derive(Default, Clone, Debug, serde::Serialize, serde::Deserialize)] pub struct RemovePublicKeyRequest { /// Key that should be removed from the environment. pub key: Option, } impl common::RequestValue for RemovePublicKeyRequest {} /// Request message for StartEnvironment. /// /// # Activities /// /// This type is used in activities, which are methods you may call on this type or where this type is involved in. /// The list links the activity name, along with information about where it is used (one of *request* and *response*). /// /// * [environments start users](UserEnvironmentStartCall) (request) #[cfg_attr(feature = "utoipa", derive(utoipa::ToSchema))] #[serde_with::serde_as] #[derive(Default, Clone, Debug, serde::Serialize, serde::Deserialize)] pub struct StartEnvironmentRequest { /// The initial access token passed to the environment. If this is present and valid, the environment will be pre-authenticated with gcloud so that the user can run gcloud commands in Cloud Shell without having to log in. This code can be updated later by calling AuthorizeEnvironment. #[serde(rename = "accessToken")] pub access_token: Option, /// Public keys that should be added to the environment before it is started. #[serde(rename = "publicKeys")] pub public_keys: Option>, } impl common::RequestValue for StartEnvironmentRequest {} /// The `Status` type defines a logical error model that is suitable for different programming environments, including REST APIs and RPC APIs. It is used by [gRPC](https://github.com/grpc). Each `Status` message contains three pieces of data: error code, error message, and error details. You can find out more about this error model and how to work with it in the [API Design Guide](https://cloud.google.com/apis/design/errors). /// /// This type is not used in any activity, and only used as *part* of another schema. /// #[cfg_attr(feature = "utoipa", derive(utoipa::ToSchema))] #[serde_with::serde_as] #[derive(Default, Clone, Debug, serde::Serialize, serde::Deserialize)] pub struct Status { /// The status code, which should be an enum value of google.rpc.Code. pub code: Option, /// A list of messages that carry the error details. There is a common set of message types for APIs to use. pub details: Option>>, /// A developer-facing error message, which should be in English. Any user-facing error message should be localized and sent in the google.rpc.Status.details field, or localized by the client. pub message: Option, } impl common::Part for Status {} // ################### // MethodBuilders ### // ################# /// A builder providing access to all methods supported on *operation* resources. /// It is not used directly, but through the [`CloudShell`] hub. /// /// # Example /// /// Instantiate a resource builder /// /// ```test_harness,no_run /// extern crate hyper; /// extern crate hyper_rustls; /// extern crate google_cloudshell1 as cloudshell1; /// /// # async fn dox() { /// use cloudshell1::{CloudShell, FieldMask, hyper_rustls, hyper_util, yup_oauth2}; /// /// let secret: yup_oauth2::ApplicationSecret = Default::default(); /// let auth = yup_oauth2::InstalledFlowAuthenticator::builder( /// secret, /// yup_oauth2::InstalledFlowReturnMethod::HTTPRedirect, /// ).build().await.unwrap(); /// /// let client = hyper_util::client::legacy::Client::builder( /// hyper_util::rt::TokioExecutor::new() /// ) /// .build( /// hyper_rustls::HttpsConnectorBuilder::new() /// .with_native_roots() /// .unwrap() /// .https_or_http() /// .enable_http1() /// .build() /// ); /// let mut hub = CloudShell::new(client, auth); /// // Usually you wouldn't bind this to a variable, but keep calling *CallBuilders* /// // like `cancel(...)`, `delete(...)`, `get(...)` and `list(...)` /// // to build up your call. /// let rb = hub.operations(); /// # } /// ``` pub struct OperationMethods<'a, C> where C: 'a, { hub: &'a CloudShell, } impl<'a, C> common::MethodsBuilder for OperationMethods<'a, C> {} impl<'a, C> OperationMethods<'a, C> { /// Create a builder to help you perform the following task: /// /// Starts asynchronous cancellation on a long-running operation. The server makes a best effort to cancel the operation, but success is not guaranteed. If the server doesn't support this method, it returns `google.rpc.Code.UNIMPLEMENTED`. Clients can use Operations.GetOperation or other methods to check whether the cancellation succeeded or whether the operation completed despite cancellation. On successful cancellation, the operation is not deleted; instead, it becomes an operation with an Operation.error value with a google.rpc.Status.code of 1, corresponding to `Code.CANCELLED`. /// /// # Arguments /// /// * `request` - No description provided. /// * `name` - The name of the operation resource to be cancelled. pub fn cancel( &self, request: CancelOperationRequest, name: &str, ) -> OperationCancelCall<'a, C> { OperationCancelCall { hub: self.hub, _request: request, _name: name.to_string(), _delegate: Default::default(), _additional_params: Default::default(), _scopes: Default::default(), } } /// Create a builder to help you perform the following task: /// /// Deletes a long-running operation. This method indicates that the client is no longer interested in the operation result. It does not cancel the operation. If the server doesn't support this method, it returns `google.rpc.Code.UNIMPLEMENTED`. /// /// # Arguments /// /// * `name` - The name of the operation resource to be deleted. pub fn delete(&self, name: &str) -> OperationDeleteCall<'a, C> { OperationDeleteCall { hub: self.hub, _name: name.to_string(), _delegate: Default::default(), _additional_params: Default::default(), _scopes: Default::default(), } } /// Create a builder to help you perform the following task: /// /// Gets the latest state of a long-running operation. Clients can use this method to poll the operation result at intervals as recommended by the API service. /// /// # Arguments /// /// * `name` - The name of the operation resource. pub fn get(&self, name: &str) -> OperationGetCall<'a, C> { OperationGetCall { hub: self.hub, _name: name.to_string(), _delegate: Default::default(), _additional_params: Default::default(), _scopes: Default::default(), } } /// Create a builder to help you perform the following task: /// /// Lists operations that match the specified filter in the request. If the server doesn't support this method, it returns `UNIMPLEMENTED`. /// /// # Arguments /// /// * `name` - The name of the operation's parent resource. pub fn list(&self, name: &str) -> OperationListCall<'a, C> { OperationListCall { hub: self.hub, _name: name.to_string(), _page_token: Default::default(), _page_size: Default::default(), _filter: Default::default(), _delegate: Default::default(), _additional_params: Default::default(), _scopes: Default::default(), } } } /// A builder providing access to all methods supported on *user* resources. /// It is not used directly, but through the [`CloudShell`] hub. /// /// # Example /// /// Instantiate a resource builder /// /// ```test_harness,no_run /// extern crate hyper; /// extern crate hyper_rustls; /// extern crate google_cloudshell1 as cloudshell1; /// /// # async fn dox() { /// use cloudshell1::{CloudShell, FieldMask, hyper_rustls, hyper_util, yup_oauth2}; /// /// let secret: yup_oauth2::ApplicationSecret = Default::default(); /// let auth = yup_oauth2::InstalledFlowAuthenticator::builder( /// secret, /// yup_oauth2::InstalledFlowReturnMethod::HTTPRedirect, /// ).build().await.unwrap(); /// /// let client = hyper_util::client::legacy::Client::builder( /// hyper_util::rt::TokioExecutor::new() /// ) /// .build( /// hyper_rustls::HttpsConnectorBuilder::new() /// .with_native_roots() /// .unwrap() /// .https_or_http() /// .enable_http1() /// .build() /// ); /// let mut hub = CloudShell::new(client, auth); /// // Usually you wouldn't bind this to a variable, but keep calling *CallBuilders* /// // like `environments_add_public_key(...)`, `environments_authorize(...)`, `environments_get(...)`, `environments_remove_public_key(...)` and `environments_start(...)` /// // to build up your call. /// let rb = hub.users(); /// # } /// ``` pub struct UserMethods<'a, C> where C: 'a, { hub: &'a CloudShell, } impl<'a, C> common::MethodsBuilder for UserMethods<'a, C> {} impl<'a, C> UserMethods<'a, C> { /// Create a builder to help you perform the following task: /// /// Adds a public SSH key to an environment, allowing clients with the corresponding private key to connect to that environment via SSH. If a key with the same content already exists, this will error with ALREADY_EXISTS. /// /// # Arguments /// /// * `request` - No description provided. /// * `environment` - Environment this key should be added to, e.g. `users/me/environments/default`. pub fn environments_add_public_key( &self, request: AddPublicKeyRequest, environment: &str, ) -> UserEnvironmentAddPublicKeyCall<'a, C> { UserEnvironmentAddPublicKeyCall { hub: self.hub, _request: request, _environment: environment.to_string(), _delegate: Default::default(), _additional_params: Default::default(), _scopes: Default::default(), } } /// Create a builder to help you perform the following task: /// /// Sends OAuth credentials to a running environment on behalf of a user. When this completes, the environment will be authorized to run various Google Cloud command line tools without requiring the user to manually authenticate. /// /// # Arguments /// /// * `request` - No description provided. /// * `name` - Name of the resource that should receive the credentials, for example `users/me/environments/default` or `users/someone@example.com/environments/default`. pub fn environments_authorize( &self, request: AuthorizeEnvironmentRequest, name: &str, ) -> UserEnvironmentAuthorizeCall<'a, C> { UserEnvironmentAuthorizeCall { hub: self.hub, _request: request, _name: name.to_string(), _delegate: Default::default(), _additional_params: Default::default(), _scopes: Default::default(), } } /// Create a builder to help you perform the following task: /// /// Gets an environment. Returns NOT_FOUND if the environment does not exist. /// /// # Arguments /// /// * `name` - Required. Name of the requested resource, for example `users/me/environments/default` or `users/someone@example.com/environments/default`. pub fn environments_get(&self, name: &str) -> UserEnvironmentGetCall<'a, C> { UserEnvironmentGetCall { hub: self.hub, _name: name.to_string(), _delegate: Default::default(), _additional_params: Default::default(), _scopes: Default::default(), } } /// Create a builder to help you perform the following task: /// /// Removes a public SSH key from an environment. Clients will no longer be able to connect to the environment using the corresponding private key. If a key with the same content is not present, this will error with NOT_FOUND. /// /// # Arguments /// /// * `request` - No description provided. /// * `environment` - Environment this key should be removed from, e.g. `users/me/environments/default`. pub fn environments_remove_public_key( &self, request: RemovePublicKeyRequest, environment: &str, ) -> UserEnvironmentRemovePublicKeyCall<'a, C> { UserEnvironmentRemovePublicKeyCall { hub: self.hub, _request: request, _environment: environment.to_string(), _delegate: Default::default(), _additional_params: Default::default(), _scopes: Default::default(), } } /// Create a builder to help you perform the following task: /// /// Starts an existing environment, allowing clients to connect to it. The returned operation will contain an instance of StartEnvironmentMetadata in its metadata field. Users can wait for the environment to start by polling this operation via GetOperation. Once the environment has finished starting and is ready to accept connections, the operation will contain a StartEnvironmentResponse in its response field. /// /// # Arguments /// /// * `request` - No description provided. /// * `name` - Name of the resource that should be started, for example `users/me/environments/default` or `users/someone@example.com/environments/default`. pub fn environments_start( &self, request: StartEnvironmentRequest, name: &str, ) -> UserEnvironmentStartCall<'a, C> { UserEnvironmentStartCall { hub: self.hub, _request: request, _name: name.to_string(), _delegate: Default::default(), _additional_params: Default::default(), _scopes: Default::default(), } } } // ################### // CallBuilders ### // ################# /// Starts asynchronous cancellation on a long-running operation. The server makes a best effort to cancel the operation, but success is not guaranteed. If the server doesn't support this method, it returns `google.rpc.Code.UNIMPLEMENTED`. Clients can use Operations.GetOperation or other methods to check whether the cancellation succeeded or whether the operation completed despite cancellation. On successful cancellation, the operation is not deleted; instead, it becomes an operation with an Operation.error value with a google.rpc.Status.code of 1, corresponding to `Code.CANCELLED`. /// /// A builder for the *cancel* method supported by a *operation* resource. /// It is not used directly, but through a [`OperationMethods`] instance. /// /// # Example /// /// Instantiate a resource method builder /// /// ```test_harness,no_run /// # extern crate hyper; /// # extern crate hyper_rustls; /// # extern crate google_cloudshell1 as cloudshell1; /// use cloudshell1::api::CancelOperationRequest; /// # async fn dox() { /// # use cloudshell1::{CloudShell, FieldMask, hyper_rustls, hyper_util, yup_oauth2}; /// /// # let secret: yup_oauth2::ApplicationSecret = Default::default(); /// # let auth = yup_oauth2::InstalledFlowAuthenticator::builder( /// # secret, /// # yup_oauth2::InstalledFlowReturnMethod::HTTPRedirect, /// # ).build().await.unwrap(); /// /// # let client = hyper_util::client::legacy::Client::builder( /// # hyper_util::rt::TokioExecutor::new() /// # ) /// # .build( /// # hyper_rustls::HttpsConnectorBuilder::new() /// # .with_native_roots() /// # .unwrap() /// # .https_or_http() /// # .enable_http1() /// # .build() /// # ); /// # let mut hub = CloudShell::new(client, auth); /// // 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 = CancelOperationRequest::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.operations().cancel(req, "name") /// .doit().await; /// # } /// ``` pub struct OperationCancelCall<'a, C> where C: 'a, { hub: &'a CloudShell, _request: CancelOperationRequest, _name: String, _delegate: Option<&'a mut dyn common::Delegate>, _additional_params: HashMap, _scopes: BTreeSet, } impl<'a, C> common::CallBuilder for OperationCancelCall<'a, C> {} impl<'a, C> OperationCancelCall<'a, C> where C: common::Connector, { /// Perform the operation you have build so far. pub async fn doit(mut self) -> common::Result<(common::Response, Empty)> { use std::borrow::Cow; use std::io::{Read, Seek}; use common::{url::Params, ToParts}; use hyper::header::{AUTHORIZATION, CONTENT_LENGTH, CONTENT_TYPE, LOCATION, USER_AGENT}; let mut dd = common::DefaultDelegate; let mut dlg: &mut dyn common::Delegate = self._delegate.unwrap_or(&mut dd); dlg.begin(common::MethodInfo { id: "cloudshell.operations.cancel", http_method: hyper::Method::POST, }); for &field in ["alt", "name"].iter() { if self._additional_params.contains_key(field) { dlg.finished(false); return Err(common::Error::FieldClash(field)); } } let mut params = Params::with_capacity(4 + self._additional_params.len()); params.push("name", self._name); params.extend(self._additional_params.iter()); params.push("alt", "json"); let mut url = self.hub._base_url.clone() + "v1/{+name}:cancel"; if self._scopes.is_empty() { self._scopes .insert(Scope::CloudPlatform.as_ref().to_string()); } #[allow(clippy::single_element_loop)] for &(find_this, param_name) in [("{+name}", "name")].iter() { url = params.uri_replacement(url, param_name, find_this, true); } { let to_remove = ["name"]; params.remove_params(&to_remove); } let url = params.parse_with_url(&url); let mut json_mime_type = mime::APPLICATION_JSON; let mut request_value_reader = { let mut value = serde_json::value::to_value(&self._request).expect("serde to work"); common::remove_json_null_values(&mut value); let mut dst = std::io::Cursor::new(Vec::with_capacity(128)); serde_json::to_writer(&mut dst, &value).unwrap(); dst }; let request_size = request_value_reader .seek(std::io::SeekFrom::End(0)) .unwrap(); request_value_reader .seek(std::io::SeekFrom::Start(0)) .unwrap(); loop { let token = match self .hub .auth .get_token(&self._scopes.iter().map(String::as_str).collect::>()[..]) .await { Ok(token) => token, Err(e) => match dlg.token(e) { Ok(token) => token, Err(e) => { dlg.finished(false); return Err(common::Error::MissingToken(e)); } }, }; request_value_reader .seek(std::io::SeekFrom::Start(0)) .unwrap(); let mut req_result = { let client = &self.hub.client; dlg.pre_request(); let mut req_builder = hyper::Request::builder() .method(hyper::Method::POST) .uri(url.as_str()) .header(USER_AGENT, self.hub._user_agent.clone()); if let Some(token) = token.as_ref() { req_builder = req_builder.header(AUTHORIZATION, format!("Bearer {}", token)); } let request = req_builder .header(CONTENT_TYPE, json_mime_type.to_string()) .header(CONTENT_LENGTH, request_size as u64) .body(common::to_body( request_value_reader.get_ref().clone().into(), )); client.request(request.unwrap()).await }; match req_result { Err(err) => { if let common::Retry::After(d) = dlg.http_error(&err) { sleep(d).await; continue; } dlg.finished(false); return Err(common::Error::HttpError(err)); } Ok(res) => { let (mut parts, body) = res.into_parts(); let mut body = common::Body::new(body); if !parts.status.is_success() { let bytes = common::to_bytes(body).await.unwrap_or_default(); let error = serde_json::from_str(&common::to_string(&bytes)); let response = common::to_response(parts, bytes.into()); if let common::Retry::After(d) = dlg.http_failure(&response, error.as_ref().ok()) { sleep(d).await; continue; } dlg.finished(false); return Err(match error { Ok(value) => common::Error::BadRequest(value), _ => common::Error::Failure(response), }); } let response = { let bytes = common::to_bytes(body).await.unwrap_or_default(); let encoded = common::to_string(&bytes); match serde_json::from_str(&encoded) { Ok(decoded) => (common::to_response(parts, bytes.into()), decoded), Err(error) => { dlg.response_json_decode_error(&encoded, &error); return Err(common::Error::JsonDecodeError( encoded.to_string(), error, )); } } }; dlg.finished(true); return Ok(response); } } } } /// /// 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 request(mut self, new_value: CancelOperationRequest) -> OperationCancelCall<'a, C> { self._request = new_value; self } /// The name of the operation resource to be cancelled. /// /// 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 name(mut self, new_value: &str) -> OperationCancelCall<'a, C> { self._name = new_value.to_string(); self } /// The delegate implementation is consulted whenever there is an intermediate result, or if something goes wrong /// while executing the actual API request. /// /// ````text /// 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 delegate( mut self, new_value: &'a mut dyn common::Delegate, ) -> OperationCancelCall<'a, C> { self._delegate = Some(new_value); self } /// 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 param(mut self, name: T, value: T) -> OperationCancelCall<'a, C> where T: AsRef, { self._additional_params .insert(name.as_ref().to_string(), value.as_ref().to_string()); self } /// 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_scope(mut self, scope: St) -> OperationCancelCall<'a, C> where St: AsRef, { self._scopes.insert(String::from(scope.as_ref())); self } /// Identifies the authorization scope(s) for the method you are building. /// /// See [`Self::add_scope()`] for details. pub fn add_scopes(mut self, scopes: I) -> OperationCancelCall<'a, C> where I: IntoIterator, St: AsRef, { self._scopes .extend(scopes.into_iter().map(|s| String::from(s.as_ref()))); self } /// 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). pub fn clear_scopes(mut self) -> OperationCancelCall<'a, C> { self._scopes.clear(); self } } /// Deletes a long-running operation. This method indicates that the client is no longer interested in the operation result. It does not cancel the operation. If the server doesn't support this method, it returns `google.rpc.Code.UNIMPLEMENTED`. /// /// A builder for the *delete* method supported by a *operation* resource. /// It is not used directly, but through a [`OperationMethods`] instance. /// /// # Example /// /// Instantiate a resource method builder /// /// ```test_harness,no_run /// # extern crate hyper; /// # extern crate hyper_rustls; /// # extern crate google_cloudshell1 as cloudshell1; /// # async fn dox() { /// # use cloudshell1::{CloudShell, FieldMask, hyper_rustls, hyper_util, yup_oauth2}; /// /// # let secret: yup_oauth2::ApplicationSecret = Default::default(); /// # let auth = yup_oauth2::InstalledFlowAuthenticator::builder( /// # secret, /// # yup_oauth2::InstalledFlowReturnMethod::HTTPRedirect, /// # ).build().await.unwrap(); /// /// # let client = hyper_util::client::legacy::Client::builder( /// # hyper_util::rt::TokioExecutor::new() /// # ) /// # .build( /// # hyper_rustls::HttpsConnectorBuilder::new() /// # .with_native_roots() /// # .unwrap() /// # .https_or_http() /// # .enable_http1() /// # .build() /// # ); /// # let mut hub = CloudShell::new(client, auth); /// // 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.operations().delete("name") /// .doit().await; /// # } /// ``` pub struct OperationDeleteCall<'a, C> where C: 'a, { hub: &'a CloudShell, _name: String, _delegate: Option<&'a mut dyn common::Delegate>, _additional_params: HashMap, _scopes: BTreeSet, } impl<'a, C> common::CallBuilder for OperationDeleteCall<'a, C> {} impl<'a, C> OperationDeleteCall<'a, C> where C: common::Connector, { /// Perform the operation you have build so far. pub async fn doit(mut self) -> common::Result<(common::Response, Empty)> { use std::borrow::Cow; use std::io::{Read, Seek}; use common::{url::Params, ToParts}; use hyper::header::{AUTHORIZATION, CONTENT_LENGTH, CONTENT_TYPE, LOCATION, USER_AGENT}; let mut dd = common::DefaultDelegate; let mut dlg: &mut dyn common::Delegate = self._delegate.unwrap_or(&mut dd); dlg.begin(common::MethodInfo { id: "cloudshell.operations.delete", http_method: hyper::Method::DELETE, }); for &field in ["alt", "name"].iter() { if self._additional_params.contains_key(field) { dlg.finished(false); return Err(common::Error::FieldClash(field)); } } let mut params = Params::with_capacity(3 + self._additional_params.len()); params.push("name", self._name); params.extend(self._additional_params.iter()); params.push("alt", "json"); let mut url = self.hub._base_url.clone() + "v1/{+name}"; if self._scopes.is_empty() { self._scopes .insert(Scope::CloudPlatform.as_ref().to_string()); } #[allow(clippy::single_element_loop)] for &(find_this, param_name) in [("{+name}", "name")].iter() { url = params.uri_replacement(url, param_name, find_this, true); } { let to_remove = ["name"]; params.remove_params(&to_remove); } let url = params.parse_with_url(&url); loop { let token = match self .hub .auth .get_token(&self._scopes.iter().map(String::as_str).collect::>()[..]) .await { Ok(token) => token, Err(e) => match dlg.token(e) { Ok(token) => token, Err(e) => { dlg.finished(false); return Err(common::Error::MissingToken(e)); } }, }; let mut req_result = { let client = &self.hub.client; dlg.pre_request(); let mut req_builder = hyper::Request::builder() .method(hyper::Method::DELETE) .uri(url.as_str()) .header(USER_AGENT, self.hub._user_agent.clone()); if let Some(token) = token.as_ref() { req_builder = req_builder.header(AUTHORIZATION, format!("Bearer {}", token)); } let request = req_builder .header(CONTENT_LENGTH, 0_u64) .body(common::to_body::(None)); client.request(request.unwrap()).await }; match req_result { Err(err) => { if let common::Retry::After(d) = dlg.http_error(&err) { sleep(d).await; continue; } dlg.finished(false); return Err(common::Error::HttpError(err)); } Ok(res) => { let (mut parts, body) = res.into_parts(); let mut body = common::Body::new(body); if !parts.status.is_success() { let bytes = common::to_bytes(body).await.unwrap_or_default(); let error = serde_json::from_str(&common::to_string(&bytes)); let response = common::to_response(parts, bytes.into()); if let common::Retry::After(d) = dlg.http_failure(&response, error.as_ref().ok()) { sleep(d).await; continue; } dlg.finished(false); return Err(match error { Ok(value) => common::Error::BadRequest(value), _ => common::Error::Failure(response), }); } let response = { let bytes = common::to_bytes(body).await.unwrap_or_default(); let encoded = common::to_string(&bytes); match serde_json::from_str(&encoded) { Ok(decoded) => (common::to_response(parts, bytes.into()), decoded), Err(error) => { dlg.response_json_decode_error(&encoded, &error); return Err(common::Error::JsonDecodeError( encoded.to_string(), error, )); } } }; dlg.finished(true); return Ok(response); } } } } /// The name of the operation resource to be deleted. /// /// 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 name(mut self, new_value: &str) -> OperationDeleteCall<'a, C> { self._name = new_value.to_string(); self } /// The delegate implementation is consulted whenever there is an intermediate result, or if something goes wrong /// while executing the actual API request. /// /// ````text /// 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 delegate( mut self, new_value: &'a mut dyn common::Delegate, ) -> OperationDeleteCall<'a, C> { self._delegate = Some(new_value); self } /// 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 param(mut self, name: T, value: T) -> OperationDeleteCall<'a, C> where T: AsRef, { self._additional_params .insert(name.as_ref().to_string(), value.as_ref().to_string()); self } /// 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_scope(mut self, scope: St) -> OperationDeleteCall<'a, C> where St: AsRef, { self._scopes.insert(String::from(scope.as_ref())); self } /// Identifies the authorization scope(s) for the method you are building. /// /// See [`Self::add_scope()`] for details. pub fn add_scopes(mut self, scopes: I) -> OperationDeleteCall<'a, C> where I: IntoIterator, St: AsRef, { self._scopes .extend(scopes.into_iter().map(|s| String::from(s.as_ref()))); self } /// 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). pub fn clear_scopes(mut self) -> OperationDeleteCall<'a, C> { self._scopes.clear(); self } } /// Gets the latest state of a long-running operation. Clients can use this method to poll the operation result at intervals as recommended by the API service. /// /// A builder for the *get* method supported by a *operation* resource. /// It is not used directly, but through a [`OperationMethods`] instance. /// /// # Example /// /// Instantiate a resource method builder /// /// ```test_harness,no_run /// # extern crate hyper; /// # extern crate hyper_rustls; /// # extern crate google_cloudshell1 as cloudshell1; /// # async fn dox() { /// # use cloudshell1::{CloudShell, FieldMask, hyper_rustls, hyper_util, yup_oauth2}; /// /// # let secret: yup_oauth2::ApplicationSecret = Default::default(); /// # let auth = yup_oauth2::InstalledFlowAuthenticator::builder( /// # secret, /// # yup_oauth2::InstalledFlowReturnMethod::HTTPRedirect, /// # ).build().await.unwrap(); /// /// # let client = hyper_util::client::legacy::Client::builder( /// # hyper_util::rt::TokioExecutor::new() /// # ) /// # .build( /// # hyper_rustls::HttpsConnectorBuilder::new() /// # .with_native_roots() /// # .unwrap() /// # .https_or_http() /// # .enable_http1() /// # .build() /// # ); /// # let mut hub = CloudShell::new(client, auth); /// // 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.operations().get("name") /// .doit().await; /// # } /// ``` pub struct OperationGetCall<'a, C> where C: 'a, { hub: &'a CloudShell, _name: String, _delegate: Option<&'a mut dyn common::Delegate>, _additional_params: HashMap, _scopes: BTreeSet, } impl<'a, C> common::CallBuilder for OperationGetCall<'a, C> {} impl<'a, C> OperationGetCall<'a, C> where C: common::Connector, { /// Perform the operation you have build so far. pub async fn doit(mut self) -> common::Result<(common::Response, Operation)> { use std::borrow::Cow; use std::io::{Read, Seek}; use common::{url::Params, ToParts}; use hyper::header::{AUTHORIZATION, CONTENT_LENGTH, CONTENT_TYPE, LOCATION, USER_AGENT}; let mut dd = common::DefaultDelegate; let mut dlg: &mut dyn common::Delegate = self._delegate.unwrap_or(&mut dd); dlg.begin(common::MethodInfo { id: "cloudshell.operations.get", http_method: hyper::Method::GET, }); for &field in ["alt", "name"].iter() { if self._additional_params.contains_key(field) { dlg.finished(false); return Err(common::Error::FieldClash(field)); } } let mut params = Params::with_capacity(3 + self._additional_params.len()); params.push("name", self._name); params.extend(self._additional_params.iter()); params.push("alt", "json"); let mut url = self.hub._base_url.clone() + "v1/{+name}"; if self._scopes.is_empty() { self._scopes .insert(Scope::CloudPlatform.as_ref().to_string()); } #[allow(clippy::single_element_loop)] for &(find_this, param_name) in [("{+name}", "name")].iter() { url = params.uri_replacement(url, param_name, find_this, true); } { let to_remove = ["name"]; params.remove_params(&to_remove); } let url = params.parse_with_url(&url); loop { let token = match self .hub .auth .get_token(&self._scopes.iter().map(String::as_str).collect::>()[..]) .await { Ok(token) => token, Err(e) => match dlg.token(e) { Ok(token) => token, Err(e) => { dlg.finished(false); return Err(common::Error::MissingToken(e)); } }, }; let mut req_result = { let client = &self.hub.client; dlg.pre_request(); let mut req_builder = hyper::Request::builder() .method(hyper::Method::GET) .uri(url.as_str()) .header(USER_AGENT, self.hub._user_agent.clone()); if let Some(token) = token.as_ref() { req_builder = req_builder.header(AUTHORIZATION, format!("Bearer {}", token)); } let request = req_builder .header(CONTENT_LENGTH, 0_u64) .body(common::to_body::(None)); client.request(request.unwrap()).await }; match req_result { Err(err) => { if let common::Retry::After(d) = dlg.http_error(&err) { sleep(d).await; continue; } dlg.finished(false); return Err(common::Error::HttpError(err)); } Ok(res) => { let (mut parts, body) = res.into_parts(); let mut body = common::Body::new(body); if !parts.status.is_success() { let bytes = common::to_bytes(body).await.unwrap_or_default(); let error = serde_json::from_str(&common::to_string(&bytes)); let response = common::to_response(parts, bytes.into()); if let common::Retry::After(d) = dlg.http_failure(&response, error.as_ref().ok()) { sleep(d).await; continue; } dlg.finished(false); return Err(match error { Ok(value) => common::Error::BadRequest(value), _ => common::Error::Failure(response), }); } let response = { let bytes = common::to_bytes(body).await.unwrap_or_default(); let encoded = common::to_string(&bytes); match serde_json::from_str(&encoded) { Ok(decoded) => (common::to_response(parts, bytes.into()), decoded), Err(error) => { dlg.response_json_decode_error(&encoded, &error); return Err(common::Error::JsonDecodeError( encoded.to_string(), error, )); } } }; dlg.finished(true); return Ok(response); } } } } /// The name of the operation resource. /// /// 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 name(mut self, new_value: &str) -> OperationGetCall<'a, C> { self._name = new_value.to_string(); self } /// The delegate implementation is consulted whenever there is an intermediate result, or if something goes wrong /// while executing the actual API request. /// /// ````text /// 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 delegate(mut self, new_value: &'a mut dyn common::Delegate) -> OperationGetCall<'a, C> { self._delegate = Some(new_value); self } /// 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 param(mut self, name: T, value: T) -> OperationGetCall<'a, C> where T: AsRef, { self._additional_params .insert(name.as_ref().to_string(), value.as_ref().to_string()); self } /// 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_scope(mut self, scope: St) -> OperationGetCall<'a, C> where St: AsRef, { self._scopes.insert(String::from(scope.as_ref())); self } /// Identifies the authorization scope(s) for the method you are building. /// /// See [`Self::add_scope()`] for details. pub fn add_scopes(mut self, scopes: I) -> OperationGetCall<'a, C> where I: IntoIterator, St: AsRef, { self._scopes .extend(scopes.into_iter().map(|s| String::from(s.as_ref()))); self } /// 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). pub fn clear_scopes(mut self) -> OperationGetCall<'a, C> { self._scopes.clear(); self } } /// Lists operations that match the specified filter in the request. If the server doesn't support this method, it returns `UNIMPLEMENTED`. /// /// A builder for the *list* method supported by a *operation* resource. /// It is not used directly, but through a [`OperationMethods`] instance. /// /// # Example /// /// Instantiate a resource method builder /// /// ```test_harness,no_run /// # extern crate hyper; /// # extern crate hyper_rustls; /// # extern crate google_cloudshell1 as cloudshell1; /// # async fn dox() { /// # use cloudshell1::{CloudShell, FieldMask, hyper_rustls, hyper_util, yup_oauth2}; /// /// # let secret: yup_oauth2::ApplicationSecret = Default::default(); /// # let auth = yup_oauth2::InstalledFlowAuthenticator::builder( /// # secret, /// # yup_oauth2::InstalledFlowReturnMethod::HTTPRedirect, /// # ).build().await.unwrap(); /// /// # let client = hyper_util::client::legacy::Client::builder( /// # hyper_util::rt::TokioExecutor::new() /// # ) /// # .build( /// # hyper_rustls::HttpsConnectorBuilder::new() /// # .with_native_roots() /// # .unwrap() /// # .https_or_http() /// # .enable_http1() /// # .build() /// # ); /// # let mut hub = CloudShell::new(client, auth); /// // 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.operations().list("name") /// .page_token("eos") /// .page_size(-4) /// .filter("ea") /// .doit().await; /// # } /// ``` pub struct OperationListCall<'a, C> where C: 'a, { hub: &'a CloudShell, _name: String, _page_token: Option, _page_size: Option, _filter: Option, _delegate: Option<&'a mut dyn common::Delegate>, _additional_params: HashMap, _scopes: BTreeSet, } impl<'a, C> common::CallBuilder for OperationListCall<'a, C> {} impl<'a, C> OperationListCall<'a, C> where C: common::Connector, { /// Perform the operation you have build so far. pub async fn doit(mut self) -> common::Result<(common::Response, ListOperationsResponse)> { use std::borrow::Cow; use std::io::{Read, Seek}; use common::{url::Params, ToParts}; use hyper::header::{AUTHORIZATION, CONTENT_LENGTH, CONTENT_TYPE, LOCATION, USER_AGENT}; let mut dd = common::DefaultDelegate; let mut dlg: &mut dyn common::Delegate = self._delegate.unwrap_or(&mut dd); dlg.begin(common::MethodInfo { id: "cloudshell.operations.list", http_method: hyper::Method::GET, }); for &field in ["alt", "name", "pageToken", "pageSize", "filter"].iter() { if self._additional_params.contains_key(field) { dlg.finished(false); return Err(common::Error::FieldClash(field)); } } let mut params = Params::with_capacity(6 + self._additional_params.len()); params.push("name", self._name); if let Some(value) = self._page_token.as_ref() { params.push("pageToken", value); } if let Some(value) = self._page_size.as_ref() { params.push("pageSize", value.to_string()); } if let Some(value) = self._filter.as_ref() { params.push("filter", value); } params.extend(self._additional_params.iter()); params.push("alt", "json"); let mut url = self.hub._base_url.clone() + "v1/{+name}"; if self._scopes.is_empty() { self._scopes .insert(Scope::CloudPlatform.as_ref().to_string()); } #[allow(clippy::single_element_loop)] for &(find_this, param_name) in [("{+name}", "name")].iter() { url = params.uri_replacement(url, param_name, find_this, true); } { let to_remove = ["name"]; params.remove_params(&to_remove); } let url = params.parse_with_url(&url); loop { let token = match self .hub .auth .get_token(&self._scopes.iter().map(String::as_str).collect::>()[..]) .await { Ok(token) => token, Err(e) => match dlg.token(e) { Ok(token) => token, Err(e) => { dlg.finished(false); return Err(common::Error::MissingToken(e)); } }, }; let mut req_result = { let client = &self.hub.client; dlg.pre_request(); let mut req_builder = hyper::Request::builder() .method(hyper::Method::GET) .uri(url.as_str()) .header(USER_AGENT, self.hub._user_agent.clone()); if let Some(token) = token.as_ref() { req_builder = req_builder.header(AUTHORIZATION, format!("Bearer {}", token)); } let request = req_builder .header(CONTENT_LENGTH, 0_u64) .body(common::to_body::(None)); client.request(request.unwrap()).await }; match req_result { Err(err) => { if let common::Retry::After(d) = dlg.http_error(&err) { sleep(d).await; continue; } dlg.finished(false); return Err(common::Error::HttpError(err)); } Ok(res) => { let (mut parts, body) = res.into_parts(); let mut body = common::Body::new(body); if !parts.status.is_success() { let bytes = common::to_bytes(body).await.unwrap_or_default(); let error = serde_json::from_str(&common::to_string(&bytes)); let response = common::to_response(parts, bytes.into()); if let common::Retry::After(d) = dlg.http_failure(&response, error.as_ref().ok()) { sleep(d).await; continue; } dlg.finished(false); return Err(match error { Ok(value) => common::Error::BadRequest(value), _ => common::Error::Failure(response), }); } let response = { let bytes = common::to_bytes(body).await.unwrap_or_default(); let encoded = common::to_string(&bytes); match serde_json::from_str(&encoded) { Ok(decoded) => (common::to_response(parts, bytes.into()), decoded), Err(error) => { dlg.response_json_decode_error(&encoded, &error); return Err(common::Error::JsonDecodeError( encoded.to_string(), error, )); } } }; dlg.finished(true); return Ok(response); } } } } /// The name of the operation's parent resource. /// /// 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 name(mut self, new_value: &str) -> OperationListCall<'a, C> { self._name = new_value.to_string(); self } /// The standard list page token. /// /// Sets the *page token* query property to the given value. pub fn page_token(mut self, new_value: &str) -> OperationListCall<'a, C> { self._page_token = Some(new_value.to_string()); self } /// The standard list page size. /// /// Sets the *page size* query property to the given value. pub fn page_size(mut self, new_value: i32) -> OperationListCall<'a, C> { self._page_size = Some(new_value); self } /// The standard list filter. /// /// Sets the *filter* query property to the given value. pub fn filter(mut self, new_value: &str) -> OperationListCall<'a, C> { self._filter = Some(new_value.to_string()); self } /// The delegate implementation is consulted whenever there is an intermediate result, or if something goes wrong /// while executing the actual API request. /// /// ````text /// 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 delegate(mut self, new_value: &'a mut dyn common::Delegate) -> OperationListCall<'a, C> { self._delegate = Some(new_value); self } /// 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 param(mut self, name: T, value: T) -> OperationListCall<'a, C> where T: AsRef, { self._additional_params .insert(name.as_ref().to_string(), value.as_ref().to_string()); self } /// 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_scope(mut self, scope: St) -> OperationListCall<'a, C> where St: AsRef, { self._scopes.insert(String::from(scope.as_ref())); self } /// Identifies the authorization scope(s) for the method you are building. /// /// See [`Self::add_scope()`] for details. pub fn add_scopes(mut self, scopes: I) -> OperationListCall<'a, C> where I: IntoIterator, St: AsRef, { self._scopes .extend(scopes.into_iter().map(|s| String::from(s.as_ref()))); self } /// 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). pub fn clear_scopes(mut self) -> OperationListCall<'a, C> { self._scopes.clear(); self } } /// Adds a public SSH key to an environment, allowing clients with the corresponding private key to connect to that environment via SSH. If a key with the same content already exists, this will error with ALREADY_EXISTS. /// /// A builder for the *environments.addPublicKey* method supported by a *user* resource. /// It is not used directly, but through a [`UserMethods`] instance. /// /// # Example /// /// Instantiate a resource method builder /// /// ```test_harness,no_run /// # extern crate hyper; /// # extern crate hyper_rustls; /// # extern crate google_cloudshell1 as cloudshell1; /// use cloudshell1::api::AddPublicKeyRequest; /// # async fn dox() { /// # use cloudshell1::{CloudShell, FieldMask, hyper_rustls, hyper_util, yup_oauth2}; /// /// # let secret: yup_oauth2::ApplicationSecret = Default::default(); /// # let auth = yup_oauth2::InstalledFlowAuthenticator::builder( /// # secret, /// # yup_oauth2::InstalledFlowReturnMethod::HTTPRedirect, /// # ).build().await.unwrap(); /// /// # let client = hyper_util::client::legacy::Client::builder( /// # hyper_util::rt::TokioExecutor::new() /// # ) /// # .build( /// # hyper_rustls::HttpsConnectorBuilder::new() /// # .with_native_roots() /// # .unwrap() /// # .https_or_http() /// # .enable_http1() /// # .build() /// # ); /// # let mut hub = CloudShell::new(client, auth); /// // 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 = AddPublicKeyRequest::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.users().environments_add_public_key(req, "environment") /// .doit().await; /// # } /// ``` pub struct UserEnvironmentAddPublicKeyCall<'a, C> where C: 'a, { hub: &'a CloudShell, _request: AddPublicKeyRequest, _environment: String, _delegate: Option<&'a mut dyn common::Delegate>, _additional_params: HashMap, _scopes: BTreeSet, } impl<'a, C> common::CallBuilder for UserEnvironmentAddPublicKeyCall<'a, C> {} impl<'a, C> UserEnvironmentAddPublicKeyCall<'a, C> where C: common::Connector, { /// Perform the operation you have build so far. pub async fn doit(mut self) -> common::Result<(common::Response, Operation)> { use std::borrow::Cow; use std::io::{Read, Seek}; use common::{url::Params, ToParts}; use hyper::header::{AUTHORIZATION, CONTENT_LENGTH, CONTENT_TYPE, LOCATION, USER_AGENT}; let mut dd = common::DefaultDelegate; let mut dlg: &mut dyn common::Delegate = self._delegate.unwrap_or(&mut dd); dlg.begin(common::MethodInfo { id: "cloudshell.users.environments.addPublicKey", http_method: hyper::Method::POST, }); for &field in ["alt", "environment"].iter() { if self._additional_params.contains_key(field) { dlg.finished(false); return Err(common::Error::FieldClash(field)); } } let mut params = Params::with_capacity(4 + self._additional_params.len()); params.push("environment", self._environment); params.extend(self._additional_params.iter()); params.push("alt", "json"); let mut url = self.hub._base_url.clone() + "v1/{+environment}:addPublicKey"; if self._scopes.is_empty() { self._scopes .insert(Scope::CloudPlatform.as_ref().to_string()); } #[allow(clippy::single_element_loop)] for &(find_this, param_name) in [("{+environment}", "environment")].iter() { url = params.uri_replacement(url, param_name, find_this, true); } { let to_remove = ["environment"]; params.remove_params(&to_remove); } let url = params.parse_with_url(&url); let mut json_mime_type = mime::APPLICATION_JSON; let mut request_value_reader = { let mut value = serde_json::value::to_value(&self._request).expect("serde to work"); common::remove_json_null_values(&mut value); let mut dst = std::io::Cursor::new(Vec::with_capacity(128)); serde_json::to_writer(&mut dst, &value).unwrap(); dst }; let request_size = request_value_reader .seek(std::io::SeekFrom::End(0)) .unwrap(); request_value_reader .seek(std::io::SeekFrom::Start(0)) .unwrap(); loop { let token = match self .hub .auth .get_token(&self._scopes.iter().map(String::as_str).collect::>()[..]) .await { Ok(token) => token, Err(e) => match dlg.token(e) { Ok(token) => token, Err(e) => { dlg.finished(false); return Err(common::Error::MissingToken(e)); } }, }; request_value_reader .seek(std::io::SeekFrom::Start(0)) .unwrap(); let mut req_result = { let client = &self.hub.client; dlg.pre_request(); let mut req_builder = hyper::Request::builder() .method(hyper::Method::POST) .uri(url.as_str()) .header(USER_AGENT, self.hub._user_agent.clone()); if let Some(token) = token.as_ref() { req_builder = req_builder.header(AUTHORIZATION, format!("Bearer {}", token)); } let request = req_builder .header(CONTENT_TYPE, json_mime_type.to_string()) .header(CONTENT_LENGTH, request_size as u64) .body(common::to_body( request_value_reader.get_ref().clone().into(), )); client.request(request.unwrap()).await }; match req_result { Err(err) => { if let common::Retry::After(d) = dlg.http_error(&err) { sleep(d).await; continue; } dlg.finished(false); return Err(common::Error::HttpError(err)); } Ok(res) => { let (mut parts, body) = res.into_parts(); let mut body = common::Body::new(body); if !parts.status.is_success() { let bytes = common::to_bytes(body).await.unwrap_or_default(); let error = serde_json::from_str(&common::to_string(&bytes)); let response = common::to_response(parts, bytes.into()); if let common::Retry::After(d) = dlg.http_failure(&response, error.as_ref().ok()) { sleep(d).await; continue; } dlg.finished(false); return Err(match error { Ok(value) => common::Error::BadRequest(value), _ => common::Error::Failure(response), }); } let response = { let bytes = common::to_bytes(body).await.unwrap_or_default(); let encoded = common::to_string(&bytes); match serde_json::from_str(&encoded) { Ok(decoded) => (common::to_response(parts, bytes.into()), decoded), Err(error) => { dlg.response_json_decode_error(&encoded, &error); return Err(common::Error::JsonDecodeError( encoded.to_string(), error, )); } } }; dlg.finished(true); return Ok(response); } } } } /// /// 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 request( mut self, new_value: AddPublicKeyRequest, ) -> UserEnvironmentAddPublicKeyCall<'a, C> { self._request = new_value; self } /// Environment this key should be added to, e.g. `users/me/environments/default`. /// /// Sets the *environment* 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 environment(mut self, new_value: &str) -> UserEnvironmentAddPublicKeyCall<'a, C> { self._environment = new_value.to_string(); self } /// The delegate implementation is consulted whenever there is an intermediate result, or if something goes wrong /// while executing the actual API request. /// /// ````text /// 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 delegate( mut self, new_value: &'a mut dyn common::Delegate, ) -> UserEnvironmentAddPublicKeyCall<'a, C> { self._delegate = Some(new_value); self } /// 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 param(mut self, name: T, value: T) -> UserEnvironmentAddPublicKeyCall<'a, C> where T: AsRef, { self._additional_params .insert(name.as_ref().to_string(), value.as_ref().to_string()); self } /// 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_scope(mut self, scope: St) -> UserEnvironmentAddPublicKeyCall<'a, C> where St: AsRef, { self._scopes.insert(String::from(scope.as_ref())); self } /// Identifies the authorization scope(s) for the method you are building. /// /// See [`Self::add_scope()`] for details. pub fn add_scopes(mut self, scopes: I) -> UserEnvironmentAddPublicKeyCall<'a, C> where I: IntoIterator, St: AsRef, { self._scopes .extend(scopes.into_iter().map(|s| String::from(s.as_ref()))); self } /// 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). pub fn clear_scopes(mut self) -> UserEnvironmentAddPublicKeyCall<'a, C> { self._scopes.clear(); self } } /// Sends OAuth credentials to a running environment on behalf of a user. When this completes, the environment will be authorized to run various Google Cloud command line tools without requiring the user to manually authenticate. /// /// A builder for the *environments.authorize* method supported by a *user* resource. /// It is not used directly, but through a [`UserMethods`] instance. /// /// # Example /// /// Instantiate a resource method builder /// /// ```test_harness,no_run /// # extern crate hyper; /// # extern crate hyper_rustls; /// # extern crate google_cloudshell1 as cloudshell1; /// use cloudshell1::api::AuthorizeEnvironmentRequest; /// # async fn dox() { /// # use cloudshell1::{CloudShell, FieldMask, hyper_rustls, hyper_util, yup_oauth2}; /// /// # let secret: yup_oauth2::ApplicationSecret = Default::default(); /// # let auth = yup_oauth2::InstalledFlowAuthenticator::builder( /// # secret, /// # yup_oauth2::InstalledFlowReturnMethod::HTTPRedirect, /// # ).build().await.unwrap(); /// /// # let client = hyper_util::client::legacy::Client::builder( /// # hyper_util::rt::TokioExecutor::new() /// # ) /// # .build( /// # hyper_rustls::HttpsConnectorBuilder::new() /// # .with_native_roots() /// # .unwrap() /// # .https_or_http() /// # .enable_http1() /// # .build() /// # ); /// # let mut hub = CloudShell::new(client, auth); /// // 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 = AuthorizeEnvironmentRequest::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.users().environments_authorize(req, "name") /// .doit().await; /// # } /// ``` pub struct UserEnvironmentAuthorizeCall<'a, C> where C: 'a, { hub: &'a CloudShell, _request: AuthorizeEnvironmentRequest, _name: String, _delegate: Option<&'a mut dyn common::Delegate>, _additional_params: HashMap, _scopes: BTreeSet, } impl<'a, C> common::CallBuilder for UserEnvironmentAuthorizeCall<'a, C> {} impl<'a, C> UserEnvironmentAuthorizeCall<'a, C> where C: common::Connector, { /// Perform the operation you have build so far. pub async fn doit(mut self) -> common::Result<(common::Response, Operation)> { use std::borrow::Cow; use std::io::{Read, Seek}; use common::{url::Params, ToParts}; use hyper::header::{AUTHORIZATION, CONTENT_LENGTH, CONTENT_TYPE, LOCATION, USER_AGENT}; let mut dd = common::DefaultDelegate; let mut dlg: &mut dyn common::Delegate = self._delegate.unwrap_or(&mut dd); dlg.begin(common::MethodInfo { id: "cloudshell.users.environments.authorize", http_method: hyper::Method::POST, }); for &field in ["alt", "name"].iter() { if self._additional_params.contains_key(field) { dlg.finished(false); return Err(common::Error::FieldClash(field)); } } let mut params = Params::with_capacity(4 + self._additional_params.len()); params.push("name", self._name); params.extend(self._additional_params.iter()); params.push("alt", "json"); let mut url = self.hub._base_url.clone() + "v1/{+name}:authorize"; if self._scopes.is_empty() { self._scopes .insert(Scope::CloudPlatform.as_ref().to_string()); } #[allow(clippy::single_element_loop)] for &(find_this, param_name) in [("{+name}", "name")].iter() { url = params.uri_replacement(url, param_name, find_this, true); } { let to_remove = ["name"]; params.remove_params(&to_remove); } let url = params.parse_with_url(&url); let mut json_mime_type = mime::APPLICATION_JSON; let mut request_value_reader = { let mut value = serde_json::value::to_value(&self._request).expect("serde to work"); common::remove_json_null_values(&mut value); let mut dst = std::io::Cursor::new(Vec::with_capacity(128)); serde_json::to_writer(&mut dst, &value).unwrap(); dst }; let request_size = request_value_reader .seek(std::io::SeekFrom::End(0)) .unwrap(); request_value_reader .seek(std::io::SeekFrom::Start(0)) .unwrap(); loop { let token = match self .hub .auth .get_token(&self._scopes.iter().map(String::as_str).collect::>()[..]) .await { Ok(token) => token, Err(e) => match dlg.token(e) { Ok(token) => token, Err(e) => { dlg.finished(false); return Err(common::Error::MissingToken(e)); } }, }; request_value_reader .seek(std::io::SeekFrom::Start(0)) .unwrap(); let mut req_result = { let client = &self.hub.client; dlg.pre_request(); let mut req_builder = hyper::Request::builder() .method(hyper::Method::POST) .uri(url.as_str()) .header(USER_AGENT, self.hub._user_agent.clone()); if let Some(token) = token.as_ref() { req_builder = req_builder.header(AUTHORIZATION, format!("Bearer {}", token)); } let request = req_builder .header(CONTENT_TYPE, json_mime_type.to_string()) .header(CONTENT_LENGTH, request_size as u64) .body(common::to_body( request_value_reader.get_ref().clone().into(), )); client.request(request.unwrap()).await }; match req_result { Err(err) => { if let common::Retry::After(d) = dlg.http_error(&err) { sleep(d).await; continue; } dlg.finished(false); return Err(common::Error::HttpError(err)); } Ok(res) => { let (mut parts, body) = res.into_parts(); let mut body = common::Body::new(body); if !parts.status.is_success() { let bytes = common::to_bytes(body).await.unwrap_or_default(); let error = serde_json::from_str(&common::to_string(&bytes)); let response = common::to_response(parts, bytes.into()); if let common::Retry::After(d) = dlg.http_failure(&response, error.as_ref().ok()) { sleep(d).await; continue; } dlg.finished(false); return Err(match error { Ok(value) => common::Error::BadRequest(value), _ => common::Error::Failure(response), }); } let response = { let bytes = common::to_bytes(body).await.unwrap_or_default(); let encoded = common::to_string(&bytes); match serde_json::from_str(&encoded) { Ok(decoded) => (common::to_response(parts, bytes.into()), decoded), Err(error) => { dlg.response_json_decode_error(&encoded, &error); return Err(common::Error::JsonDecodeError( encoded.to_string(), error, )); } } }; dlg.finished(true); return Ok(response); } } } } /// /// 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 request( mut self, new_value: AuthorizeEnvironmentRequest, ) -> UserEnvironmentAuthorizeCall<'a, C> { self._request = new_value; self } /// Name of the resource that should receive the credentials, for example `users/me/environments/default` or `users/someone@example.com/environments/default`. /// /// 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 name(mut self, new_value: &str) -> UserEnvironmentAuthorizeCall<'a, C> { self._name = new_value.to_string(); self } /// The delegate implementation is consulted whenever there is an intermediate result, or if something goes wrong /// while executing the actual API request. /// /// ````text /// 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 delegate( mut self, new_value: &'a mut dyn common::Delegate, ) -> UserEnvironmentAuthorizeCall<'a, C> { self._delegate = Some(new_value); self } /// 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 param(mut self, name: T, value: T) -> UserEnvironmentAuthorizeCall<'a, C> where T: AsRef, { self._additional_params .insert(name.as_ref().to_string(), value.as_ref().to_string()); self } /// 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_scope(mut self, scope: St) -> UserEnvironmentAuthorizeCall<'a, C> where St: AsRef, { self._scopes.insert(String::from(scope.as_ref())); self } /// Identifies the authorization scope(s) for the method you are building. /// /// See [`Self::add_scope()`] for details. pub fn add_scopes(mut self, scopes: I) -> UserEnvironmentAuthorizeCall<'a, C> where I: IntoIterator, St: AsRef, { self._scopes .extend(scopes.into_iter().map(|s| String::from(s.as_ref()))); self } /// 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). pub fn clear_scopes(mut self) -> UserEnvironmentAuthorizeCall<'a, C> { self._scopes.clear(); self } } /// Gets an environment. Returns NOT_FOUND if the environment does not exist. /// /// A builder for the *environments.get* method supported by a *user* resource. /// It is not used directly, but through a [`UserMethods`] instance. /// /// # Example /// /// Instantiate a resource method builder /// /// ```test_harness,no_run /// # extern crate hyper; /// # extern crate hyper_rustls; /// # extern crate google_cloudshell1 as cloudshell1; /// # async fn dox() { /// # use cloudshell1::{CloudShell, FieldMask, hyper_rustls, hyper_util, yup_oauth2}; /// /// # let secret: yup_oauth2::ApplicationSecret = Default::default(); /// # let auth = yup_oauth2::InstalledFlowAuthenticator::builder( /// # secret, /// # yup_oauth2::InstalledFlowReturnMethod::HTTPRedirect, /// # ).build().await.unwrap(); /// /// # let client = hyper_util::client::legacy::Client::builder( /// # hyper_util::rt::TokioExecutor::new() /// # ) /// # .build( /// # hyper_rustls::HttpsConnectorBuilder::new() /// # .with_native_roots() /// # .unwrap() /// # .https_or_http() /// # .enable_http1() /// # .build() /// # ); /// # let mut hub = CloudShell::new(client, auth); /// // 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.users().environments_get("name") /// .doit().await; /// # } /// ``` pub struct UserEnvironmentGetCall<'a, C> where C: 'a, { hub: &'a CloudShell, _name: String, _delegate: Option<&'a mut dyn common::Delegate>, _additional_params: HashMap, _scopes: BTreeSet, } impl<'a, C> common::CallBuilder for UserEnvironmentGetCall<'a, C> {} impl<'a, C> UserEnvironmentGetCall<'a, C> where C: common::Connector, { /// Perform the operation you have build so far. pub async fn doit(mut self) -> common::Result<(common::Response, Environment)> { use std::borrow::Cow; use std::io::{Read, Seek}; use common::{url::Params, ToParts}; use hyper::header::{AUTHORIZATION, CONTENT_LENGTH, CONTENT_TYPE, LOCATION, USER_AGENT}; let mut dd = common::DefaultDelegate; let mut dlg: &mut dyn common::Delegate = self._delegate.unwrap_or(&mut dd); dlg.begin(common::MethodInfo { id: "cloudshell.users.environments.get", http_method: hyper::Method::GET, }); for &field in ["alt", "name"].iter() { if self._additional_params.contains_key(field) { dlg.finished(false); return Err(common::Error::FieldClash(field)); } } let mut params = Params::with_capacity(3 + self._additional_params.len()); params.push("name", self._name); params.extend(self._additional_params.iter()); params.push("alt", "json"); let mut url = self.hub._base_url.clone() + "v1/{+name}"; if self._scopes.is_empty() { self._scopes .insert(Scope::CloudPlatform.as_ref().to_string()); } #[allow(clippy::single_element_loop)] for &(find_this, param_name) in [("{+name}", "name")].iter() { url = params.uri_replacement(url, param_name, find_this, true); } { let to_remove = ["name"]; params.remove_params(&to_remove); } let url = params.parse_with_url(&url); loop { let token = match self .hub .auth .get_token(&self._scopes.iter().map(String::as_str).collect::>()[..]) .await { Ok(token) => token, Err(e) => match dlg.token(e) { Ok(token) => token, Err(e) => { dlg.finished(false); return Err(common::Error::MissingToken(e)); } }, }; let mut req_result = { let client = &self.hub.client; dlg.pre_request(); let mut req_builder = hyper::Request::builder() .method(hyper::Method::GET) .uri(url.as_str()) .header(USER_AGENT, self.hub._user_agent.clone()); if let Some(token) = token.as_ref() { req_builder = req_builder.header(AUTHORIZATION, format!("Bearer {}", token)); } let request = req_builder .header(CONTENT_LENGTH, 0_u64) .body(common::to_body::(None)); client.request(request.unwrap()).await }; match req_result { Err(err) => { if let common::Retry::After(d) = dlg.http_error(&err) { sleep(d).await; continue; } dlg.finished(false); return Err(common::Error::HttpError(err)); } Ok(res) => { let (mut parts, body) = res.into_parts(); let mut body = common::Body::new(body); if !parts.status.is_success() { let bytes = common::to_bytes(body).await.unwrap_or_default(); let error = serde_json::from_str(&common::to_string(&bytes)); let response = common::to_response(parts, bytes.into()); if let common::Retry::After(d) = dlg.http_failure(&response, error.as_ref().ok()) { sleep(d).await; continue; } dlg.finished(false); return Err(match error { Ok(value) => common::Error::BadRequest(value), _ => common::Error::Failure(response), }); } let response = { let bytes = common::to_bytes(body).await.unwrap_or_default(); let encoded = common::to_string(&bytes); match serde_json::from_str(&encoded) { Ok(decoded) => (common::to_response(parts, bytes.into()), decoded), Err(error) => { dlg.response_json_decode_error(&encoded, &error); return Err(common::Error::JsonDecodeError( encoded.to_string(), error, )); } } }; dlg.finished(true); return Ok(response); } } } } /// Required. Name of the requested resource, for example `users/me/environments/default` or `users/someone@example.com/environments/default`. /// /// 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 name(mut self, new_value: &str) -> UserEnvironmentGetCall<'a, C> { self._name = new_value.to_string(); self } /// The delegate implementation is consulted whenever there is an intermediate result, or if something goes wrong /// while executing the actual API request. /// /// ````text /// 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 delegate( mut self, new_value: &'a mut dyn common::Delegate, ) -> UserEnvironmentGetCall<'a, C> { self._delegate = Some(new_value); self } /// 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 param(mut self, name: T, value: T) -> UserEnvironmentGetCall<'a, C> where T: AsRef, { self._additional_params .insert(name.as_ref().to_string(), value.as_ref().to_string()); self } /// 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_scope(mut self, scope: St) -> UserEnvironmentGetCall<'a, C> where St: AsRef, { self._scopes.insert(String::from(scope.as_ref())); self } /// Identifies the authorization scope(s) for the method you are building. /// /// See [`Self::add_scope()`] for details. pub fn add_scopes(mut self, scopes: I) -> UserEnvironmentGetCall<'a, C> where I: IntoIterator, St: AsRef, { self._scopes .extend(scopes.into_iter().map(|s| String::from(s.as_ref()))); self } /// 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). pub fn clear_scopes(mut self) -> UserEnvironmentGetCall<'a, C> { self._scopes.clear(); self } } /// Removes a public SSH key from an environment. Clients will no longer be able to connect to the environment using the corresponding private key. If a key with the same content is not present, this will error with NOT_FOUND. /// /// A builder for the *environments.removePublicKey* method supported by a *user* resource. /// It is not used directly, but through a [`UserMethods`] instance. /// /// # Example /// /// Instantiate a resource method builder /// /// ```test_harness,no_run /// # extern crate hyper; /// # extern crate hyper_rustls; /// # extern crate google_cloudshell1 as cloudshell1; /// use cloudshell1::api::RemovePublicKeyRequest; /// # async fn dox() { /// # use cloudshell1::{CloudShell, FieldMask, hyper_rustls, hyper_util, yup_oauth2}; /// /// # let secret: yup_oauth2::ApplicationSecret = Default::default(); /// # let auth = yup_oauth2::InstalledFlowAuthenticator::builder( /// # secret, /// # yup_oauth2::InstalledFlowReturnMethod::HTTPRedirect, /// # ).build().await.unwrap(); /// /// # let client = hyper_util::client::legacy::Client::builder( /// # hyper_util::rt::TokioExecutor::new() /// # ) /// # .build( /// # hyper_rustls::HttpsConnectorBuilder::new() /// # .with_native_roots() /// # .unwrap() /// # .https_or_http() /// # .enable_http1() /// # .build() /// # ); /// # let mut hub = CloudShell::new(client, auth); /// // 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 = RemovePublicKeyRequest::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.users().environments_remove_public_key(req, "environment") /// .doit().await; /// # } /// ``` pub struct UserEnvironmentRemovePublicKeyCall<'a, C> where C: 'a, { hub: &'a CloudShell, _request: RemovePublicKeyRequest, _environment: String, _delegate: Option<&'a mut dyn common::Delegate>, _additional_params: HashMap, _scopes: BTreeSet, } impl<'a, C> common::CallBuilder for UserEnvironmentRemovePublicKeyCall<'a, C> {} impl<'a, C> UserEnvironmentRemovePublicKeyCall<'a, C> where C: common::Connector, { /// Perform the operation you have build so far. pub async fn doit(mut self) -> common::Result<(common::Response, Operation)> { use std::borrow::Cow; use std::io::{Read, Seek}; use common::{url::Params, ToParts}; use hyper::header::{AUTHORIZATION, CONTENT_LENGTH, CONTENT_TYPE, LOCATION, USER_AGENT}; let mut dd = common::DefaultDelegate; let mut dlg: &mut dyn common::Delegate = self._delegate.unwrap_or(&mut dd); dlg.begin(common::MethodInfo { id: "cloudshell.users.environments.removePublicKey", http_method: hyper::Method::POST, }); for &field in ["alt", "environment"].iter() { if self._additional_params.contains_key(field) { dlg.finished(false); return Err(common::Error::FieldClash(field)); } } let mut params = Params::with_capacity(4 + self._additional_params.len()); params.push("environment", self._environment); params.extend(self._additional_params.iter()); params.push("alt", "json"); let mut url = self.hub._base_url.clone() + "v1/{+environment}:removePublicKey"; if self._scopes.is_empty() { self._scopes .insert(Scope::CloudPlatform.as_ref().to_string()); } #[allow(clippy::single_element_loop)] for &(find_this, param_name) in [("{+environment}", "environment")].iter() { url = params.uri_replacement(url, param_name, find_this, true); } { let to_remove = ["environment"]; params.remove_params(&to_remove); } let url = params.parse_with_url(&url); let mut json_mime_type = mime::APPLICATION_JSON; let mut request_value_reader = { let mut value = serde_json::value::to_value(&self._request).expect("serde to work"); common::remove_json_null_values(&mut value); let mut dst = std::io::Cursor::new(Vec::with_capacity(128)); serde_json::to_writer(&mut dst, &value).unwrap(); dst }; let request_size = request_value_reader .seek(std::io::SeekFrom::End(0)) .unwrap(); request_value_reader .seek(std::io::SeekFrom::Start(0)) .unwrap(); loop { let token = match self .hub .auth .get_token(&self._scopes.iter().map(String::as_str).collect::>()[..]) .await { Ok(token) => token, Err(e) => match dlg.token(e) { Ok(token) => token, Err(e) => { dlg.finished(false); return Err(common::Error::MissingToken(e)); } }, }; request_value_reader .seek(std::io::SeekFrom::Start(0)) .unwrap(); let mut req_result = { let client = &self.hub.client; dlg.pre_request(); let mut req_builder = hyper::Request::builder() .method(hyper::Method::POST) .uri(url.as_str()) .header(USER_AGENT, self.hub._user_agent.clone()); if let Some(token) = token.as_ref() { req_builder = req_builder.header(AUTHORIZATION, format!("Bearer {}", token)); } let request = req_builder .header(CONTENT_TYPE, json_mime_type.to_string()) .header(CONTENT_LENGTH, request_size as u64) .body(common::to_body( request_value_reader.get_ref().clone().into(), )); client.request(request.unwrap()).await }; match req_result { Err(err) => { if let common::Retry::After(d) = dlg.http_error(&err) { sleep(d).await; continue; } dlg.finished(false); return Err(common::Error::HttpError(err)); } Ok(res) => { let (mut parts, body) = res.into_parts(); let mut body = common::Body::new(body); if !parts.status.is_success() { let bytes = common::to_bytes(body).await.unwrap_or_default(); let error = serde_json::from_str(&common::to_string(&bytes)); let response = common::to_response(parts, bytes.into()); if let common::Retry::After(d) = dlg.http_failure(&response, error.as_ref().ok()) { sleep(d).await; continue; } dlg.finished(false); return Err(match error { Ok(value) => common::Error::BadRequest(value), _ => common::Error::Failure(response), }); } let response = { let bytes = common::to_bytes(body).await.unwrap_or_default(); let encoded = common::to_string(&bytes); match serde_json::from_str(&encoded) { Ok(decoded) => (common::to_response(parts, bytes.into()), decoded), Err(error) => { dlg.response_json_decode_error(&encoded, &error); return Err(common::Error::JsonDecodeError( encoded.to_string(), error, )); } } }; dlg.finished(true); return Ok(response); } } } } /// /// 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 request( mut self, new_value: RemovePublicKeyRequest, ) -> UserEnvironmentRemovePublicKeyCall<'a, C> { self._request = new_value; self } /// Environment this key should be removed from, e.g. `users/me/environments/default`. /// /// Sets the *environment* 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 environment(mut self, new_value: &str) -> UserEnvironmentRemovePublicKeyCall<'a, C> { self._environment = new_value.to_string(); self } /// The delegate implementation is consulted whenever there is an intermediate result, or if something goes wrong /// while executing the actual API request. /// /// ````text /// 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 delegate( mut self, new_value: &'a mut dyn common::Delegate, ) -> UserEnvironmentRemovePublicKeyCall<'a, C> { self._delegate = Some(new_value); self } /// 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 param(mut self, name: T, value: T) -> UserEnvironmentRemovePublicKeyCall<'a, C> where T: AsRef, { self._additional_params .insert(name.as_ref().to_string(), value.as_ref().to_string()); self } /// 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_scope(mut self, scope: St) -> UserEnvironmentRemovePublicKeyCall<'a, C> where St: AsRef, { self._scopes.insert(String::from(scope.as_ref())); self } /// Identifies the authorization scope(s) for the method you are building. /// /// See [`Self::add_scope()`] for details. pub fn add_scopes(mut self, scopes: I) -> UserEnvironmentRemovePublicKeyCall<'a, C> where I: IntoIterator, St: AsRef, { self._scopes .extend(scopes.into_iter().map(|s| String::from(s.as_ref()))); self } /// 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). pub fn clear_scopes(mut self) -> UserEnvironmentRemovePublicKeyCall<'a, C> { self._scopes.clear(); self } } /// Starts an existing environment, allowing clients to connect to it. The returned operation will contain an instance of StartEnvironmentMetadata in its metadata field. Users can wait for the environment to start by polling this operation via GetOperation. Once the environment has finished starting and is ready to accept connections, the operation will contain a StartEnvironmentResponse in its response field. /// /// A builder for the *environments.start* method supported by a *user* resource. /// It is not used directly, but through a [`UserMethods`] instance. /// /// # Example /// /// Instantiate a resource method builder /// /// ```test_harness,no_run /// # extern crate hyper; /// # extern crate hyper_rustls; /// # extern crate google_cloudshell1 as cloudshell1; /// use cloudshell1::api::StartEnvironmentRequest; /// # async fn dox() { /// # use cloudshell1::{CloudShell, FieldMask, hyper_rustls, hyper_util, yup_oauth2}; /// /// # let secret: yup_oauth2::ApplicationSecret = Default::default(); /// # let auth = yup_oauth2::InstalledFlowAuthenticator::builder( /// # secret, /// # yup_oauth2::InstalledFlowReturnMethod::HTTPRedirect, /// # ).build().await.unwrap(); /// /// # let client = hyper_util::client::legacy::Client::builder( /// # hyper_util::rt::TokioExecutor::new() /// # ) /// # .build( /// # hyper_rustls::HttpsConnectorBuilder::new() /// # .with_native_roots() /// # .unwrap() /// # .https_or_http() /// # .enable_http1() /// # .build() /// # ); /// # let mut hub = CloudShell::new(client, auth); /// // 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 = StartEnvironmentRequest::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.users().environments_start(req, "name") /// .doit().await; /// # } /// ``` pub struct UserEnvironmentStartCall<'a, C> where C: 'a, { hub: &'a CloudShell, _request: StartEnvironmentRequest, _name: String, _delegate: Option<&'a mut dyn common::Delegate>, _additional_params: HashMap, _scopes: BTreeSet, } impl<'a, C> common::CallBuilder for UserEnvironmentStartCall<'a, C> {} impl<'a, C> UserEnvironmentStartCall<'a, C> where C: common::Connector, { /// Perform the operation you have build so far. pub async fn doit(mut self) -> common::Result<(common::Response, Operation)> { use std::borrow::Cow; use std::io::{Read, Seek}; use common::{url::Params, ToParts}; use hyper::header::{AUTHORIZATION, CONTENT_LENGTH, CONTENT_TYPE, LOCATION, USER_AGENT}; let mut dd = common::DefaultDelegate; let mut dlg: &mut dyn common::Delegate = self._delegate.unwrap_or(&mut dd); dlg.begin(common::MethodInfo { id: "cloudshell.users.environments.start", http_method: hyper::Method::POST, }); for &field in ["alt", "name"].iter() { if self._additional_params.contains_key(field) { dlg.finished(false); return Err(common::Error::FieldClash(field)); } } let mut params = Params::with_capacity(4 + self._additional_params.len()); params.push("name", self._name); params.extend(self._additional_params.iter()); params.push("alt", "json"); let mut url = self.hub._base_url.clone() + "v1/{+name}:start"; if self._scopes.is_empty() { self._scopes .insert(Scope::CloudPlatform.as_ref().to_string()); } #[allow(clippy::single_element_loop)] for &(find_this, param_name) in [("{+name}", "name")].iter() { url = params.uri_replacement(url, param_name, find_this, true); } { let to_remove = ["name"]; params.remove_params(&to_remove); } let url = params.parse_with_url(&url); let mut json_mime_type = mime::APPLICATION_JSON; let mut request_value_reader = { let mut value = serde_json::value::to_value(&self._request).expect("serde to work"); common::remove_json_null_values(&mut value); let mut dst = std::io::Cursor::new(Vec::with_capacity(128)); serde_json::to_writer(&mut dst, &value).unwrap(); dst }; let request_size = request_value_reader .seek(std::io::SeekFrom::End(0)) .unwrap(); request_value_reader .seek(std::io::SeekFrom::Start(0)) .unwrap(); loop { let token = match self .hub .auth .get_token(&self._scopes.iter().map(String::as_str).collect::>()[..]) .await { Ok(token) => token, Err(e) => match dlg.token(e) { Ok(token) => token, Err(e) => { dlg.finished(false); return Err(common::Error::MissingToken(e)); } }, }; request_value_reader .seek(std::io::SeekFrom::Start(0)) .unwrap(); let mut req_result = { let client = &self.hub.client; dlg.pre_request(); let mut req_builder = hyper::Request::builder() .method(hyper::Method::POST) .uri(url.as_str()) .header(USER_AGENT, self.hub._user_agent.clone()); if let Some(token) = token.as_ref() { req_builder = req_builder.header(AUTHORIZATION, format!("Bearer {}", token)); } let request = req_builder .header(CONTENT_TYPE, json_mime_type.to_string()) .header(CONTENT_LENGTH, request_size as u64) .body(common::to_body( request_value_reader.get_ref().clone().into(), )); client.request(request.unwrap()).await }; match req_result { Err(err) => { if let common::Retry::After(d) = dlg.http_error(&err) { sleep(d).await; continue; } dlg.finished(false); return Err(common::Error::HttpError(err)); } Ok(res) => { let (mut parts, body) = res.into_parts(); let mut body = common::Body::new(body); if !parts.status.is_success() { let bytes = common::to_bytes(body).await.unwrap_or_default(); let error = serde_json::from_str(&common::to_string(&bytes)); let response = common::to_response(parts, bytes.into()); if let common::Retry::After(d) = dlg.http_failure(&response, error.as_ref().ok()) { sleep(d).await; continue; } dlg.finished(false); return Err(match error { Ok(value) => common::Error::BadRequest(value), _ => common::Error::Failure(response), }); } let response = { let bytes = common::to_bytes(body).await.unwrap_or_default(); let encoded = common::to_string(&bytes); match serde_json::from_str(&encoded) { Ok(decoded) => (common::to_response(parts, bytes.into()), decoded), Err(error) => { dlg.response_json_decode_error(&encoded, &error); return Err(common::Error::JsonDecodeError( encoded.to_string(), error, )); } } }; dlg.finished(true); return Ok(response); } } } } /// /// 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 request( mut self, new_value: StartEnvironmentRequest, ) -> UserEnvironmentStartCall<'a, C> { self._request = new_value; self } /// Name of the resource that should be started, for example `users/me/environments/default` or `users/someone@example.com/environments/default`. /// /// 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 name(mut self, new_value: &str) -> UserEnvironmentStartCall<'a, C> { self._name = new_value.to_string(); self } /// The delegate implementation is consulted whenever there is an intermediate result, or if something goes wrong /// while executing the actual API request. /// /// ````text /// 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 delegate( mut self, new_value: &'a mut dyn common::Delegate, ) -> UserEnvironmentStartCall<'a, C> { self._delegate = Some(new_value); self } /// 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 param(mut self, name: T, value: T) -> UserEnvironmentStartCall<'a, C> where T: AsRef, { self._additional_params .insert(name.as_ref().to_string(), value.as_ref().to_string()); self } /// 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_scope(mut self, scope: St) -> UserEnvironmentStartCall<'a, C> where St: AsRef, { self._scopes.insert(String::from(scope.as_ref())); self } /// Identifies the authorization scope(s) for the method you are building. /// /// See [`Self::add_scope()`] for details. pub fn add_scopes(mut self, scopes: I) -> UserEnvironmentStartCall<'a, C> where I: IntoIterator, St: AsRef, { self._scopes .extend(scopes.into_iter().map(|s| String::from(s.as_ref()))); self } /// 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). pub fn clear_scopes(mut self) -> UserEnvironmentStartCall<'a, C> { self._scopes.clear(); self } }