The `google-sqladmin1_beta4` library allows access to all features of the *Google SQL Admin* service. This documentation was generated from *SQL Admin* crate version *5.0.5+20240618*, where *20240618* is the exact revision of the *sqladmin:v1beta4* schema built by the [mako](http://www.makotemplates.org/) code generator *v5.0.5*. Everything else about the *SQL Admin* *v1_beta4* API can be found at the [official documentation site](https://developers.google.com/cloud-sql/). # Features Handle the following *Resources* with ease from the central [hub](https://docs.rs/google-sqladmin1_beta4/5.0.5+20240618/google_sqladmin1_beta4/SQLAdmin) ... * [backup runs](https://docs.rs/google-sqladmin1_beta4/5.0.5+20240618/google_sqladmin1_beta4/api::BackupRun) * [*delete*](https://docs.rs/google-sqladmin1_beta4/5.0.5+20240618/google_sqladmin1_beta4/api::BackupRunDeleteCall), [*get*](https://docs.rs/google-sqladmin1_beta4/5.0.5+20240618/google_sqladmin1_beta4/api::BackupRunGetCall), [*insert*](https://docs.rs/google-sqladmin1_beta4/5.0.5+20240618/google_sqladmin1_beta4/api::BackupRunInsertCall) and [*list*](https://docs.rs/google-sqladmin1_beta4/5.0.5+20240618/google_sqladmin1_beta4/api::BackupRunListCall) * connect * [*generate ephemeral*](https://docs.rs/google-sqladmin1_beta4/5.0.5+20240618/google_sqladmin1_beta4/api::ConnectGenerateEphemeralCall) and [*get*](https://docs.rs/google-sqladmin1_beta4/5.0.5+20240618/google_sqladmin1_beta4/api::ConnectGetCall) * [databases](https://docs.rs/google-sqladmin1_beta4/5.0.5+20240618/google_sqladmin1_beta4/api::Database) * [*delete*](https://docs.rs/google-sqladmin1_beta4/5.0.5+20240618/google_sqladmin1_beta4/api::DatabaseDeleteCall), [*get*](https://docs.rs/google-sqladmin1_beta4/5.0.5+20240618/google_sqladmin1_beta4/api::DatabaseGetCall), [*insert*](https://docs.rs/google-sqladmin1_beta4/5.0.5+20240618/google_sqladmin1_beta4/api::DatabaseInsertCall), [*list*](https://docs.rs/google-sqladmin1_beta4/5.0.5+20240618/google_sqladmin1_beta4/api::DatabaseListCall), [*patch*](https://docs.rs/google-sqladmin1_beta4/5.0.5+20240618/google_sqladmin1_beta4/api::DatabasePatchCall) and [*update*](https://docs.rs/google-sqladmin1_beta4/5.0.5+20240618/google_sqladmin1_beta4/api::DatabaseUpdateCall) * [flags](https://docs.rs/google-sqladmin1_beta4/5.0.5+20240618/google_sqladmin1_beta4/api::Flag) * [*list*](https://docs.rs/google-sqladmin1_beta4/5.0.5+20240618/google_sqladmin1_beta4/api::FlagListCall) * instances * [*acquire ssrs lease*](https://docs.rs/google-sqladmin1_beta4/5.0.5+20240618/google_sqladmin1_beta4/api::InstanceAcquireSsrsLeaseCall), [*add server ca*](https://docs.rs/google-sqladmin1_beta4/5.0.5+20240618/google_sqladmin1_beta4/api::InstanceAddServerCaCall), [*clone*](https://docs.rs/google-sqladmin1_beta4/5.0.5+20240618/google_sqladmin1_beta4/api::InstanceCloneCall), [*delete*](https://docs.rs/google-sqladmin1_beta4/5.0.5+20240618/google_sqladmin1_beta4/api::InstanceDeleteCall), [*demote*](https://docs.rs/google-sqladmin1_beta4/5.0.5+20240618/google_sqladmin1_beta4/api::InstanceDemoteCall), [*demote master*](https://docs.rs/google-sqladmin1_beta4/5.0.5+20240618/google_sqladmin1_beta4/api::InstanceDemoteMasterCall), [*export*](https://docs.rs/google-sqladmin1_beta4/5.0.5+20240618/google_sqladmin1_beta4/api::InstanceExportCall), [*failover*](https://docs.rs/google-sqladmin1_beta4/5.0.5+20240618/google_sqladmin1_beta4/api::InstanceFailoverCall), [*get*](https://docs.rs/google-sqladmin1_beta4/5.0.5+20240618/google_sqladmin1_beta4/api::InstanceGetCall), [*import*](https://docs.rs/google-sqladmin1_beta4/5.0.5+20240618/google_sqladmin1_beta4/api::InstanceImportCall), [*insert*](https://docs.rs/google-sqladmin1_beta4/5.0.5+20240618/google_sqladmin1_beta4/api::InstanceInsertCall), [*list*](https://docs.rs/google-sqladmin1_beta4/5.0.5+20240618/google_sqladmin1_beta4/api::InstanceListCall), [*list server cas*](https://docs.rs/google-sqladmin1_beta4/5.0.5+20240618/google_sqladmin1_beta4/api::InstanceListServerCaCall), [*patch*](https://docs.rs/google-sqladmin1_beta4/5.0.5+20240618/google_sqladmin1_beta4/api::InstancePatchCall), [*promote replica*](https://docs.rs/google-sqladmin1_beta4/5.0.5+20240618/google_sqladmin1_beta4/api::InstancePromoteReplicaCall), [*reencrypt*](https://docs.rs/google-sqladmin1_beta4/5.0.5+20240618/google_sqladmin1_beta4/api::InstanceReencryptCall), [*release ssrs lease*](https://docs.rs/google-sqladmin1_beta4/5.0.5+20240618/google_sqladmin1_beta4/api::InstanceReleaseSsrsLeaseCall), [*reset ssl config*](https://docs.rs/google-sqladmin1_beta4/5.0.5+20240618/google_sqladmin1_beta4/api::InstanceResetSslConfigCall), [*restart*](https://docs.rs/google-sqladmin1_beta4/5.0.5+20240618/google_sqladmin1_beta4/api::InstanceRestartCall), [*restore backup*](https://docs.rs/google-sqladmin1_beta4/5.0.5+20240618/google_sqladmin1_beta4/api::InstanceRestoreBackupCall), [*rotate server ca*](https://docs.rs/google-sqladmin1_beta4/5.0.5+20240618/google_sqladmin1_beta4/api::InstanceRotateServerCaCall), [*start replica*](https://docs.rs/google-sqladmin1_beta4/5.0.5+20240618/google_sqladmin1_beta4/api::InstanceStartReplicaCall), [*stop replica*](https://docs.rs/google-sqladmin1_beta4/5.0.5+20240618/google_sqladmin1_beta4/api::InstanceStopReplicaCall), [*switchover*](https://docs.rs/google-sqladmin1_beta4/5.0.5+20240618/google_sqladmin1_beta4/api::InstanceSwitchoverCall), [*truncate log*](https://docs.rs/google-sqladmin1_beta4/5.0.5+20240618/google_sqladmin1_beta4/api::InstanceTruncateLogCall) and [*update*](https://docs.rs/google-sqladmin1_beta4/5.0.5+20240618/google_sqladmin1_beta4/api::InstanceUpdateCall) * [operations](https://docs.rs/google-sqladmin1_beta4/5.0.5+20240618/google_sqladmin1_beta4/api::Operation) * [*cancel*](https://docs.rs/google-sqladmin1_beta4/5.0.5+20240618/google_sqladmin1_beta4/api::OperationCancelCall), [*get*](https://docs.rs/google-sqladmin1_beta4/5.0.5+20240618/google_sqladmin1_beta4/api::OperationGetCall) and [*list*](https://docs.rs/google-sqladmin1_beta4/5.0.5+20240618/google_sqladmin1_beta4/api::OperationListCall) * projects * [*instances get disk shrink config*](https://docs.rs/google-sqladmin1_beta4/5.0.5+20240618/google_sqladmin1_beta4/api::ProjectInstanceGetDiskShrinkConfigCall), [*instances get latest recovery time*](https://docs.rs/google-sqladmin1_beta4/5.0.5+20240618/google_sqladmin1_beta4/api::ProjectInstanceGetLatestRecoveryTimeCall), [*instances perform disk shrink*](https://docs.rs/google-sqladmin1_beta4/5.0.5+20240618/google_sqladmin1_beta4/api::ProjectInstancePerformDiskShrinkCall), [*instances reschedule maintenance*](https://docs.rs/google-sqladmin1_beta4/5.0.5+20240618/google_sqladmin1_beta4/api::ProjectInstanceRescheduleMaintenanceCall), [*instances reset replica size*](https://docs.rs/google-sqladmin1_beta4/5.0.5+20240618/google_sqladmin1_beta4/api::ProjectInstanceResetReplicaSizeCall), [*instances start external sync*](https://docs.rs/google-sqladmin1_beta4/5.0.5+20240618/google_sqladmin1_beta4/api::ProjectInstanceStartExternalSyncCall) and [*instances verify external sync settings*](https://docs.rs/google-sqladmin1_beta4/5.0.5+20240618/google_sqladmin1_beta4/api::ProjectInstanceVerifyExternalSyncSettingCall) * [ssl certs](https://docs.rs/google-sqladmin1_beta4/5.0.5+20240618/google_sqladmin1_beta4/api::SslCert) * [*create ephemeral*](https://docs.rs/google-sqladmin1_beta4/5.0.5+20240618/google_sqladmin1_beta4/api::SslCertCreateEphemeralCall), [*delete*](https://docs.rs/google-sqladmin1_beta4/5.0.5+20240618/google_sqladmin1_beta4/api::SslCertDeleteCall), [*get*](https://docs.rs/google-sqladmin1_beta4/5.0.5+20240618/google_sqladmin1_beta4/api::SslCertGetCall), [*insert*](https://docs.rs/google-sqladmin1_beta4/5.0.5+20240618/google_sqladmin1_beta4/api::SslCertInsertCall) and [*list*](https://docs.rs/google-sqladmin1_beta4/5.0.5+20240618/google_sqladmin1_beta4/api::SslCertListCall) * [tiers](https://docs.rs/google-sqladmin1_beta4/5.0.5+20240618/google_sqladmin1_beta4/api::Tier) * [*list*](https://docs.rs/google-sqladmin1_beta4/5.0.5+20240618/google_sqladmin1_beta4/api::TierListCall) * [users](https://docs.rs/google-sqladmin1_beta4/5.0.5+20240618/google_sqladmin1_beta4/api::User) * [*delete*](https://docs.rs/google-sqladmin1_beta4/5.0.5+20240618/google_sqladmin1_beta4/api::UserDeleteCall), [*get*](https://docs.rs/google-sqladmin1_beta4/5.0.5+20240618/google_sqladmin1_beta4/api::UserGetCall), [*insert*](https://docs.rs/google-sqladmin1_beta4/5.0.5+20240618/google_sqladmin1_beta4/api::UserInsertCall), [*list*](https://docs.rs/google-sqladmin1_beta4/5.0.5+20240618/google_sqladmin1_beta4/api::UserListCall) and [*update*](https://docs.rs/google-sqladmin1_beta4/5.0.5+20240618/google_sqladmin1_beta4/api::UserUpdateCall) # Structure of this Library The API is structured into the following primary items: * **[Hub](https://docs.rs/google-sqladmin1_beta4/5.0.5+20240618/google_sqladmin1_beta4/SQLAdmin)** * a central object to maintain state and allow accessing all *Activities* * creates [*Method Builders*](https://docs.rs/google-sqladmin1_beta4/5.0.5+20240618/google_sqladmin1_beta4/client::MethodsBuilder) which in turn allow access to individual [*Call Builders*](https://docs.rs/google-sqladmin1_beta4/5.0.5+20240618/google_sqladmin1_beta4/client::CallBuilder) * **[Resources](https://docs.rs/google-sqladmin1_beta4/5.0.5+20240618/google_sqladmin1_beta4/client::Resource)** * primary types that you can apply *Activities* to * a collection of properties and *Parts* * **[Parts](https://docs.rs/google-sqladmin1_beta4/5.0.5+20240618/google_sqladmin1_beta4/client::Part)** * a collection of properties * never directly used in *Activities* * **[Activities](https://docs.rs/google-sqladmin1_beta4/5.0.5+20240618/google_sqladmin1_beta4/client::CallBuilder)** * operations to apply to *Resources* All *structures* are marked with applicable traits to further categorize them and ease browsing. Generally speaking, you can invoke *Activities* like this: ```Rust,ignore let r = hub.resource().activity(...).doit().await ``` Or specifically ... ```ignore let r = hub.backup_runs().delete(...).doit().await let r = hub.backup_runs().insert(...).doit().await let r = hub.databases().delete(...).doit().await let r = hub.databases().insert(...).doit().await let r = hub.databases().patch(...).doit().await let r = hub.databases().update(...).doit().await let r = hub.instances().add_server_ca(...).doit().await let r = hub.instances().clone(...).doit().await let r = hub.instances().delete(...).doit().await let r = hub.instances().demote(...).doit().await let r = hub.instances().demote_master(...).doit().await let r = hub.instances().export(...).doit().await let r = hub.instances().failover(...).doit().await let r = hub.instances().import(...).doit().await let r = hub.instances().insert(...).doit().await let r = hub.instances().patch(...).doit().await let r = hub.instances().promote_replica(...).doit().await let r = hub.instances().reencrypt(...).doit().await let r = hub.instances().reset_ssl_config(...).doit().await let r = hub.instances().restart(...).doit().await let r = hub.instances().restore_backup(...).doit().await let r = hub.instances().rotate_server_ca(...).doit().await let r = hub.instances().start_replica(...).doit().await let r = hub.instances().stop_replica(...).doit().await let r = hub.instances().switchover(...).doit().await let r = hub.instances().truncate_log(...).doit().await let r = hub.instances().update(...).doit().await let r = hub.operations().cancel(...).doit().await let r = hub.operations().get(...).doit().await let r = hub.operations().list(...).doit().await let r = hub.projects().instances_perform_disk_shrink(...).doit().await let r = hub.projects().instances_reschedule_maintenance(...).doit().await let r = hub.projects().instances_reset_replica_size(...).doit().await let r = hub.projects().instances_start_external_sync(...).doit().await let r = hub.ssl_certs().delete(...).doit().await let r = hub.users().delete(...).doit().await let r = hub.users().insert(...).doit().await let r = hub.users().update(...).doit().await ``` The `resource()` and `activity(...)` calls create [builders][builder-pattern]. The second one dealing with `Activities` supports various methods to configure the impending operation (not shown here). It is made such that all required arguments have to be specified right away (i.e. `(...)`), whereas all optional ones can be [build up][builder-pattern] as desired. The `doit()` method performs the actual communication with the server and returns the respective result. # Usage ## Setting up your Project To use this library, you would put the following lines into your `Cargo.toml` file: ```toml [dependencies] google-sqladmin1_beta4 = "*" serde = "^1.0" serde_json = "^1.0" ``` ## A complete example ```Rust extern crate hyper; extern crate hyper_rustls; extern crate google_sqladmin1_beta4 as sqladmin1_beta4; use sqladmin1_beta4::api::User; use sqladmin1_beta4::{Result, Error}; use std::default::Default; use sqladmin1_beta4::{SQLAdmin, oauth2, hyper, hyper_rustls, chrono, FieldMask}; // Get an ApplicationSecret instance by some means. It contains the `client_id` and // `client_secret`, among other things. let secret: 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 = oauth2::InstalledFlowAuthenticator::builder( secret, oauth2::InstalledFlowReturnMethod::HTTPRedirect, ).build().await.unwrap(); let mut hub = SQLAdmin::new(hyper::Client::builder().build(hyper_rustls::HttpsConnectorBuilder::new().with_native_roots().unwrap().https_or_http().enable_http1().build()), 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 = User::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().update(req, "project", "instance") .name("no") .host("ipsum") .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), } ``` ## Handling Errors All errors produced by the system are provided either as [Result](https://docs.rs/google-sqladmin1_beta4/5.0.5+20240618/google_sqladmin1_beta4/client::Result) enumeration as return value of the doit() methods, or handed as possibly intermediate results to either the [Hub Delegate](https://docs.rs/google-sqladmin1_beta4/5.0.5+20240618/google_sqladmin1_beta4/client::Delegate), or the [Authenticator Delegate](https://docs.rs/yup-oauth2/*/yup_oauth2/trait.AuthenticatorDelegate.html). When delegates handle errors or intermediate values, they may have a chance to instruct the system to retry. This makes the system potentially resilient to all kinds of errors. ## Uploads and Downloads If a method supports downloads, the response body, which is part of the [Result](https://docs.rs/google-sqladmin1_beta4/5.0.5+20240618/google_sqladmin1_beta4/client::Result), should be read by you to obtain the media. If such a method also supports a [Response Result](https://docs.rs/google-sqladmin1_beta4/5.0.5+20240618/google_sqladmin1_beta4/client::ResponseResult), it will return that by default. You can see it as meta-data for the actual media. To trigger a media download, you will have to set up the builder by making this call: `.param("alt", "media")`. Methods supporting uploads can do so using up to 2 different protocols: *simple* and *resumable*. The distinctiveness of each is represented by customized `doit(...)` methods, which are then named `upload(...)` and `upload_resumable(...)` respectively. ## Customization and Callbacks You may alter the way an `doit()` method is called by providing a [delegate](https://docs.rs/google-sqladmin1_beta4/5.0.5+20240618/google_sqladmin1_beta4/client::Delegate) to the [Method Builder](https://docs.rs/google-sqladmin1_beta4/5.0.5+20240618/google_sqladmin1_beta4/client::CallBuilder) before making the final `doit()` call. Respective methods will be called to provide progress information, as well as determine whether the system should retry on failure. The [delegate trait](https://docs.rs/google-sqladmin1_beta4/5.0.5+20240618/google_sqladmin1_beta4/client::Delegate) is default-implemented, allowing you to customize it with minimal effort. ## Optional Parts in Server-Requests All structures provided by this library are made to be [encodable](https://docs.rs/google-sqladmin1_beta4/5.0.5+20240618/google_sqladmin1_beta4/client::RequestValue) and [decodable](https://docs.rs/google-sqladmin1_beta4/5.0.5+20240618/google_sqladmin1_beta4/client::ResponseResult) via *json*. Optionals are used to indicate that partial requests are responses are valid. Most optionals are are considered [Parts](https://docs.rs/google-sqladmin1_beta4/5.0.5+20240618/google_sqladmin1_beta4/client::Part) which are identifiable by name, which will be sent to the server to indicate either the set parts of the request or the desired parts in the response. ## Builder Arguments Using [method builders](https://docs.rs/google-sqladmin1_beta4/5.0.5+20240618/google_sqladmin1_beta4/client::CallBuilder), you are able to prepare an action call by repeatedly calling it's methods. These will always take a single argument, for which the following statements are true. * [PODs][wiki-pod] are handed by copy * strings are passed as `&str` * [request values](https://docs.rs/google-sqladmin1_beta4/5.0.5+20240618/google_sqladmin1_beta4/client::RequestValue) are moved Arguments will always be copied or cloned into the builder, to make them independent of their original life times. [wiki-pod]: http://en.wikipedia.org/wiki/Plain_old_data_structure [builder-pattern]: http://en.wikipedia.org/wiki/Builder_pattern [google-go-api]: https://github.com/google/google-api-go-client ## Cargo Features * `utoipa` - Add support for [utoipa](https://crates.io/crates/utoipa) and derive `utoipa::ToSchema` on all the types. You'll have to import and register the required types in `#[openapi(schemas(...))]`, otherwise the generated `openapi` spec would be invalid. # License The **sqladmin1_beta4** library was generated by Sebastian Thiel, and is placed under the *MIT* license. You can read the full text at the repository's [license file][repo-license]. [repo-license]: https://github.com/Byron/google-apis-rsblob/main/LICENSE.md