mirror of
https://github.com/OMGeeky/google-apis-rs.git
synced 2025-12-29 23:55:52 +01:00
238 lines
17 KiB
Markdown
238 lines
17 KiB
Markdown
<!---
|
|
DO NOT EDIT !
|
|
This file was generated automatically from 'src/mako/api/README.md.mako'
|
|
DO NOT EDIT !
|
|
-->
|
|
The `google-sql1_beta4` library allows access to all features of the *Google SQL Admin* service.
|
|
|
|
This documentation was generated from *SQL Admin* crate version *1.0.14+20200331*, where *20200331* is the exact revision of the *sql:v1beta4* schema built by the [mako](http://www.makotemplates.org/) code generator *v1.0.14*.
|
|
|
|
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-sql1_beta4/1.0.14+20200331/google_sql1_beta4/struct.SQLAdmin.html) ...
|
|
|
|
* [backup runs](https://docs.rs/google-sql1_beta4/1.0.14+20200331/google_sql1_beta4/struct.BackupRun.html)
|
|
* [*delete*](https://docs.rs/google-sql1_beta4/1.0.14+20200331/google_sql1_beta4/struct.BackupRunDeleteCall.html), [*get*](https://docs.rs/google-sql1_beta4/1.0.14+20200331/google_sql1_beta4/struct.BackupRunGetCall.html), [*insert*](https://docs.rs/google-sql1_beta4/1.0.14+20200331/google_sql1_beta4/struct.BackupRunInsertCall.html) and [*list*](https://docs.rs/google-sql1_beta4/1.0.14+20200331/google_sql1_beta4/struct.BackupRunListCall.html)
|
|
* [databases](https://docs.rs/google-sql1_beta4/1.0.14+20200331/google_sql1_beta4/struct.Database.html)
|
|
* [*delete*](https://docs.rs/google-sql1_beta4/1.0.14+20200331/google_sql1_beta4/struct.DatabaseDeleteCall.html), [*get*](https://docs.rs/google-sql1_beta4/1.0.14+20200331/google_sql1_beta4/struct.DatabaseGetCall.html), [*insert*](https://docs.rs/google-sql1_beta4/1.0.14+20200331/google_sql1_beta4/struct.DatabaseInsertCall.html), [*list*](https://docs.rs/google-sql1_beta4/1.0.14+20200331/google_sql1_beta4/struct.DatabaseListCall.html), [*patch*](https://docs.rs/google-sql1_beta4/1.0.14+20200331/google_sql1_beta4/struct.DatabasePatchCall.html) and [*update*](https://docs.rs/google-sql1_beta4/1.0.14+20200331/google_sql1_beta4/struct.DatabaseUpdateCall.html)
|
|
* [flags](https://docs.rs/google-sql1_beta4/1.0.14+20200331/google_sql1_beta4/struct.Flag.html)
|
|
* [*list*](https://docs.rs/google-sql1_beta4/1.0.14+20200331/google_sql1_beta4/struct.FlagListCall.html)
|
|
* instances
|
|
* [*add server ca*](https://docs.rs/google-sql1_beta4/1.0.14+20200331/google_sql1_beta4/struct.InstanceAddServerCaCall.html), [*clone*](https://docs.rs/google-sql1_beta4/1.0.14+20200331/google_sql1_beta4/struct.InstanceCloneCall.html), [*delete*](https://docs.rs/google-sql1_beta4/1.0.14+20200331/google_sql1_beta4/struct.InstanceDeleteCall.html), [*demote master*](https://docs.rs/google-sql1_beta4/1.0.14+20200331/google_sql1_beta4/struct.InstanceDemoteMasterCall.html), [*export*](https://docs.rs/google-sql1_beta4/1.0.14+20200331/google_sql1_beta4/struct.InstanceExportCall.html), [*failover*](https://docs.rs/google-sql1_beta4/1.0.14+20200331/google_sql1_beta4/struct.InstanceFailoverCall.html), [*get*](https://docs.rs/google-sql1_beta4/1.0.14+20200331/google_sql1_beta4/struct.InstanceGetCall.html), [*import*](https://docs.rs/google-sql1_beta4/1.0.14+20200331/google_sql1_beta4/struct.InstanceImportCall.html), [*insert*](https://docs.rs/google-sql1_beta4/1.0.14+20200331/google_sql1_beta4/struct.InstanceInsertCall.html), [*list*](https://docs.rs/google-sql1_beta4/1.0.14+20200331/google_sql1_beta4/struct.InstanceListCall.html), [*list server cas*](https://docs.rs/google-sql1_beta4/1.0.14+20200331/google_sql1_beta4/struct.InstanceListServerCaCall.html), [*patch*](https://docs.rs/google-sql1_beta4/1.0.14+20200331/google_sql1_beta4/struct.InstancePatchCall.html), [*promote replica*](https://docs.rs/google-sql1_beta4/1.0.14+20200331/google_sql1_beta4/struct.InstancePromoteReplicaCall.html), [*reset ssl config*](https://docs.rs/google-sql1_beta4/1.0.14+20200331/google_sql1_beta4/struct.InstanceResetSslConfigCall.html), [*restart*](https://docs.rs/google-sql1_beta4/1.0.14+20200331/google_sql1_beta4/struct.InstanceRestartCall.html), [*restore backup*](https://docs.rs/google-sql1_beta4/1.0.14+20200331/google_sql1_beta4/struct.InstanceRestoreBackupCall.html), [*rotate server ca*](https://docs.rs/google-sql1_beta4/1.0.14+20200331/google_sql1_beta4/struct.InstanceRotateServerCaCall.html), [*start replica*](https://docs.rs/google-sql1_beta4/1.0.14+20200331/google_sql1_beta4/struct.InstanceStartReplicaCall.html), [*stop replica*](https://docs.rs/google-sql1_beta4/1.0.14+20200331/google_sql1_beta4/struct.InstanceStopReplicaCall.html), [*truncate log*](https://docs.rs/google-sql1_beta4/1.0.14+20200331/google_sql1_beta4/struct.InstanceTruncateLogCall.html) and [*update*](https://docs.rs/google-sql1_beta4/1.0.14+20200331/google_sql1_beta4/struct.InstanceUpdateCall.html)
|
|
* [operations](https://docs.rs/google-sql1_beta4/1.0.14+20200331/google_sql1_beta4/struct.Operation.html)
|
|
* [*get*](https://docs.rs/google-sql1_beta4/1.0.14+20200331/google_sql1_beta4/struct.OperationGetCall.html) and [*list*](https://docs.rs/google-sql1_beta4/1.0.14+20200331/google_sql1_beta4/struct.OperationListCall.html)
|
|
* projects
|
|
* [*instances reschedule maintenance*](https://docs.rs/google-sql1_beta4/1.0.14+20200331/google_sql1_beta4/struct.ProjectInstanceRescheduleMaintenanceCall.html), [*instances start external sync*](https://docs.rs/google-sql1_beta4/1.0.14+20200331/google_sql1_beta4/struct.ProjectInstanceStartExternalSyncCall.html) and [*instances verify external sync settings*](https://docs.rs/google-sql1_beta4/1.0.14+20200331/google_sql1_beta4/struct.ProjectInstanceVerifyExternalSyncSettingCall.html)
|
|
* [ssl certs](https://docs.rs/google-sql1_beta4/1.0.14+20200331/google_sql1_beta4/struct.SslCert.html)
|
|
* [*create ephemeral*](https://docs.rs/google-sql1_beta4/1.0.14+20200331/google_sql1_beta4/struct.SslCertCreateEphemeralCall.html), [*delete*](https://docs.rs/google-sql1_beta4/1.0.14+20200331/google_sql1_beta4/struct.SslCertDeleteCall.html), [*get*](https://docs.rs/google-sql1_beta4/1.0.14+20200331/google_sql1_beta4/struct.SslCertGetCall.html), [*insert*](https://docs.rs/google-sql1_beta4/1.0.14+20200331/google_sql1_beta4/struct.SslCertInsertCall.html) and [*list*](https://docs.rs/google-sql1_beta4/1.0.14+20200331/google_sql1_beta4/struct.SslCertListCall.html)
|
|
* [tiers](https://docs.rs/google-sql1_beta4/1.0.14+20200331/google_sql1_beta4/struct.Tier.html)
|
|
* [*list*](https://docs.rs/google-sql1_beta4/1.0.14+20200331/google_sql1_beta4/struct.TierListCall.html)
|
|
* [users](https://docs.rs/google-sql1_beta4/1.0.14+20200331/google_sql1_beta4/struct.User.html)
|
|
* [*delete*](https://docs.rs/google-sql1_beta4/1.0.14+20200331/google_sql1_beta4/struct.UserDeleteCall.html), [*insert*](https://docs.rs/google-sql1_beta4/1.0.14+20200331/google_sql1_beta4/struct.UserInsertCall.html), [*list*](https://docs.rs/google-sql1_beta4/1.0.14+20200331/google_sql1_beta4/struct.UserListCall.html) and [*update*](https://docs.rs/google-sql1_beta4/1.0.14+20200331/google_sql1_beta4/struct.UserUpdateCall.html)
|
|
|
|
|
|
|
|
|
|
# Structure of this Library
|
|
|
|
The API is structured into the following primary items:
|
|
|
|
* **[Hub](https://docs.rs/google-sql1_beta4/1.0.14+20200331/google_sql1_beta4/struct.SQLAdmin.html)**
|
|
* a central object to maintain state and allow accessing all *Activities*
|
|
* creates [*Method Builders*](https://docs.rs/google-sql1_beta4/1.0.14+20200331/google_sql1_beta4/trait.MethodsBuilder.html) which in turn
|
|
allow access to individual [*Call Builders*](https://docs.rs/google-sql1_beta4/1.0.14+20200331/google_sql1_beta4/trait.CallBuilder.html)
|
|
* **[Resources](https://docs.rs/google-sql1_beta4/1.0.14+20200331/google_sql1_beta4/trait.Resource.html)**
|
|
* primary types that you can apply *Activities* to
|
|
* a collection of properties and *Parts*
|
|
* **[Parts](https://docs.rs/google-sql1_beta4/1.0.14+20200331/google_sql1_beta4/trait.Part.html)**
|
|
* a collection of properties
|
|
* never directly used in *Activities*
|
|
* **[Activities](https://docs.rs/google-sql1_beta4/1.0.14+20200331/google_sql1_beta4/trait.CallBuilder.html)**
|
|
* 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()
|
|
```
|
|
|
|
Or specifically ...
|
|
|
|
```ignore
|
|
let r = hub.ssl_certs().delete(...).doit()
|
|
let r = hub.instances().truncate_log(...).doit()
|
|
let r = hub.instances().demote_master(...).doit()
|
|
let r = hub.users().delete(...).doit()
|
|
let r = hub.databases().delete(...).doit()
|
|
let r = hub.instances().failover(...).doit()
|
|
let r = hub.projects().instances_reschedule_maintenance(...).doit()
|
|
let r = hub.databases().patch(...).doit()
|
|
let r = hub.projects().instances_start_external_sync(...).doit()
|
|
let r = hub.instances().reset_ssl_config(...).doit()
|
|
let r = hub.instances().promote_replica(...).doit()
|
|
let r = hub.databases().update(...).doit()
|
|
let r = hub.operations().list(...).doit()
|
|
let r = hub.users().update(...).doit()
|
|
let r = hub.databases().insert(...).doit()
|
|
let r = hub.instances().add_server_ca(...).doit()
|
|
let r = hub.backup_runs().delete(...).doit()
|
|
let r = hub.instances().patch(...).doit()
|
|
let r = hub.instances().clone(...).doit()
|
|
let r = hub.instances().delete(...).doit()
|
|
let r = hub.operations().get(...).doit()
|
|
let r = hub.instances().stop_replica(...).doit()
|
|
let r = hub.instances().start_replica(...).doit()
|
|
let r = hub.users().insert(...).doit()
|
|
let r = hub.instances().insert(...).doit()
|
|
let r = hub.instances().rotate_server_ca(...).doit()
|
|
let r = hub.instances().import(...).doit()
|
|
let r = hub.backup_runs().insert(...).doit()
|
|
let r = hub.instances().update(...).doit()
|
|
let r = hub.instances().restart(...).doit()
|
|
let r = hub.instances().export(...).doit()
|
|
let r = hub.instances().restore_backup(...).doit()
|
|
```
|
|
|
|
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-sql1_beta4 = "*"
|
|
# This project intentionally uses an old version of Hyper. See
|
|
# https://github.com/Byron/google-apis-rs/issues/173 for more
|
|
# information.
|
|
hyper = "^0.10"
|
|
hyper-rustls = "^0.6"
|
|
serde = "^1.0"
|
|
serde_json = "^1.0"
|
|
yup-oauth2 = "^1.0"
|
|
```
|
|
|
|
## A complete example
|
|
|
|
```Rust
|
|
extern crate hyper;
|
|
extern crate hyper_rustls;
|
|
extern crate yup_oauth2 as oauth2;
|
|
extern crate google_sql1_beta4 as sql1_beta4;
|
|
use sql1_beta4::User;
|
|
use sql1_beta4::{Result, Error};
|
|
use std::default::Default;
|
|
use oauth2::{Authenticator, DefaultAuthenticatorDelegate, ApplicationSecret, MemoryStorage};
|
|
use sql1_beta4::SQLAdmin;
|
|
|
|
// Get an ApplicationSecret instance by some means. It contains the `client_id` and
|
|
// `client_secret`, among other things.
|
|
let secret: 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 = Authenticator::new(&secret, DefaultAuthenticatorDelegate,
|
|
hyper::Client::with_connector(hyper::net::HttpsConnector::new(hyper_rustls::TlsClient::new())),
|
|
<MemoryStorage as Default>::default(), None);
|
|
let mut hub = SQLAdmin::new(hyper::Client::with_connector(hyper::net::HttpsConnector::new(hyper_rustls::TlsClient::new())), 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("Stet")
|
|
.host("sed")
|
|
.doit();
|
|
|
|
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::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-sql1_beta4/1.0.14+20200331/google_sql1_beta4/enum.Result.html) enumeration as return value of
|
|
the doit() methods, or handed as possibly intermediate results to either the
|
|
[Hub Delegate](https://docs.rs/google-sql1_beta4/1.0.14+20200331/google_sql1_beta4/trait.Delegate.html), 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-sql1_beta4/1.0.14+20200331/google_sql1_beta4/enum.Result.html), should be
|
|
read by you to obtain the media.
|
|
If such a method also supports a [Response Result](https://docs.rs/google-sql1_beta4/1.0.14+20200331/google_sql1_beta4/trait.ResponseResult.html), 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-sql1_beta4/1.0.14+20200331/google_sql1_beta4/trait.Delegate.html) to the
|
|
[Method Builder](https://docs.rs/google-sql1_beta4/1.0.14+20200331/google_sql1_beta4/trait.CallBuilder.html) 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-sql1_beta4/1.0.14+20200331/google_sql1_beta4/trait.Delegate.html) 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-sql1_beta4/1.0.14+20200331/google_sql1_beta4/trait.RequestValue.html) and
|
|
[decodable](https://docs.rs/google-sql1_beta4/1.0.14+20200331/google_sql1_beta4/trait.ResponseResult.html) via *json*. Optionals are used to indicate that partial requests are responses
|
|
are valid.
|
|
Most optionals are are considered [Parts](https://docs.rs/google-sql1_beta4/1.0.14+20200331/google_sql1_beta4/trait.Part.html) 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-sql1_beta4/1.0.14+20200331/google_sql1_beta4/trait.CallBuilder.html), 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-sql1_beta4/1.0.14+20200331/google_sql1_beta4/trait.RequestValue.html) 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
|
|
|
|
# License
|
|
The **sql1_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/master/LICENSE.md
|