OMGeeky/google-apis-rs
1
0
Fork 0
mirror of https://github.com/OMGeeky/google-apis-rs.git synced 2026-01-12 06:23:18 +01:00
Code Issues Packages Projects Releases Wiki Activity
Files
32b9880b201303e9e84c5aa74a77dd67efb94de2
google-apis-rs/gen/dataplex1/README.md
Sebastian Thiel 7abe6a3de2 regenerate all APIs and CLIs (#357)
2022-09-14 08:40:50 +08:00

201 lines
20 KiB
Markdown
Raw Blame History

<!---
DO NOT EDIT !
This file was generated automatically from 'src/generator/templates/api/README.md.mako'
DO NOT EDIT !
-->
The `google-dataplex1` library allows access to all features of the *Google Cloud Dataplex* service.
This documentation was generated from *Cloud Dataplex* crate version *4.0.1+20220223*, where *20220223* is the exact revision of the *dataplex:v1* schema built by the [mako](http://www.makotemplates.org/) code generator *v4.0.1*.
Everything else about the *Cloud Dataplex* *v1* API can be found at the
[official documentation site](https://cloud.google.com/dataplex/docs).
# Features
Handle the following *Resources* with ease from the central [hub](https://docs.rs/google-dataplex1/4.0.1+20220223/google_dataplex1/CloudDataplex) ...
* projects
* [*locations get*](https://docs.rs/google-dataplex1/4.0.1+20220223/google_dataplex1/api::ProjectLocationGetCall), [*locations lakes actions list*](https://docs.rs/google-dataplex1/4.0.1+20220223/google_dataplex1/api::ProjectLocationLakeActionListCall), [*locations lakes content get iam policy*](https://docs.rs/google-dataplex1/4.0.1+20220223/google_dataplex1/api::ProjectLocationLakeContentGetIamPolicyCall), [*locations lakes content set iam policy*](https://docs.rs/google-dataplex1/4.0.1+20220223/google_dataplex1/api::ProjectLocationLakeContentSetIamPolicyCall), [*locations lakes content test iam permissions*](https://docs.rs/google-dataplex1/4.0.1+20220223/google_dataplex1/api::ProjectLocationLakeContentTestIamPermissionCall), [*locations lakes contentitems create*](https://docs.rs/google-dataplex1/4.0.1+20220223/google_dataplex1/api::ProjectLocationLakeContentitemCreateCall), [*locations lakes contentitems delete*](https://docs.rs/google-dataplex1/4.0.1+20220223/google_dataplex1/api::ProjectLocationLakeContentitemDeleteCall), [*locations lakes contentitems get*](https://docs.rs/google-dataplex1/4.0.1+20220223/google_dataplex1/api::ProjectLocationLakeContentitemGetCall), [*locations lakes contentitems list*](https://docs.rs/google-dataplex1/4.0.1+20220223/google_dataplex1/api::ProjectLocationLakeContentitemListCall), [*locations lakes contentitems patch*](https://docs.rs/google-dataplex1/4.0.1+20220223/google_dataplex1/api::ProjectLocationLakeContentitemPatchCall), [*locations lakes create*](https://docs.rs/google-dataplex1/4.0.1+20220223/google_dataplex1/api::ProjectLocationLakeCreateCall), [*locations lakes delete*](https://docs.rs/google-dataplex1/4.0.1+20220223/google_dataplex1/api::ProjectLocationLakeDeleteCall), [*locations lakes environments create*](https://docs.rs/google-dataplex1/4.0.1+20220223/google_dataplex1/api::ProjectLocationLakeEnvironmentCreateCall), [*locations lakes environments delete*](https://docs.rs/google-dataplex1/4.0.1+20220223/google_dataplex1/api::ProjectLocationLakeEnvironmentDeleteCall), [*locations lakes environments get*](https://docs.rs/google-dataplex1/4.0.1+20220223/google_dataplex1/api::ProjectLocationLakeEnvironmentGetCall), [*locations lakes environments get iam policy*](https://docs.rs/google-dataplex1/4.0.1+20220223/google_dataplex1/api::ProjectLocationLakeEnvironmentGetIamPolicyCall), [*locations lakes environments list*](https://docs.rs/google-dataplex1/4.0.1+20220223/google_dataplex1/api::ProjectLocationLakeEnvironmentListCall), [*locations lakes environments patch*](https://docs.rs/google-dataplex1/4.0.1+20220223/google_dataplex1/api::ProjectLocationLakeEnvironmentPatchCall), [*locations lakes environments sessions list*](https://docs.rs/google-dataplex1/4.0.1+20220223/google_dataplex1/api::ProjectLocationLakeEnvironmentSessionListCall), [*locations lakes environments set iam policy*](https://docs.rs/google-dataplex1/4.0.1+20220223/google_dataplex1/api::ProjectLocationLakeEnvironmentSetIamPolicyCall), [*locations lakes environments test iam permissions*](https://docs.rs/google-dataplex1/4.0.1+20220223/google_dataplex1/api::ProjectLocationLakeEnvironmentTestIamPermissionCall), [*locations lakes get*](https://docs.rs/google-dataplex1/4.0.1+20220223/google_dataplex1/api::ProjectLocationLakeGetCall), [*locations lakes get iam policy*](https://docs.rs/google-dataplex1/4.0.1+20220223/google_dataplex1/api::ProjectLocationLakeGetIamPolicyCall), [*locations lakes list*](https://docs.rs/google-dataplex1/4.0.1+20220223/google_dataplex1/api::ProjectLocationLakeListCall), [*locations lakes patch*](https://docs.rs/google-dataplex1/4.0.1+20220223/google_dataplex1/api::ProjectLocationLakePatchCall), [*locations lakes set iam policy*](https://docs.rs/google-dataplex1/4.0.1+20220223/google_dataplex1/api::ProjectLocationLakeSetIamPolicyCall), [*locations lakes tasks create*](https://docs.rs/google-dataplex1/4.0.1+20220223/google_dataplex1/api::ProjectLocationLakeTaskCreateCall), [*locations lakes tasks delete*](https://docs.rs/google-dataplex1/4.0.1+20220223/google_dataplex1/api::ProjectLocationLakeTaskDeleteCall), [*locations lakes tasks get*](https://docs.rs/google-dataplex1/4.0.1+20220223/google_dataplex1/api::ProjectLocationLakeTaskGetCall), [*locations lakes tasks get iam policy*](https://docs.rs/google-dataplex1/4.0.1+20220223/google_dataplex1/api::ProjectLocationLakeTaskGetIamPolicyCall), [*locations lakes tasks jobs cancel*](https://docs.rs/google-dataplex1/4.0.1+20220223/google_dataplex1/api::ProjectLocationLakeTaskJobCancelCall), [*locations lakes tasks jobs get*](https://docs.rs/google-dataplex1/4.0.1+20220223/google_dataplex1/api::ProjectLocationLakeTaskJobGetCall), [*locations lakes tasks jobs list*](https://docs.rs/google-dataplex1/4.0.1+20220223/google_dataplex1/api::ProjectLocationLakeTaskJobListCall), [*locations lakes tasks list*](https://docs.rs/google-dataplex1/4.0.1+20220223/google_dataplex1/api::ProjectLocationLakeTaskListCall), [*locations lakes tasks patch*](https://docs.rs/google-dataplex1/4.0.1+20220223/google_dataplex1/api::ProjectLocationLakeTaskPatchCall), [*locations lakes tasks set iam policy*](https://docs.rs/google-dataplex1/4.0.1+20220223/google_dataplex1/api::ProjectLocationLakeTaskSetIamPolicyCall), [*locations lakes tasks test iam permissions*](https://docs.rs/google-dataplex1/4.0.1+20220223/google_dataplex1/api::ProjectLocationLakeTaskTestIamPermissionCall), [*locations lakes test iam permissions*](https://docs.rs/google-dataplex1/4.0.1+20220223/google_dataplex1/api::ProjectLocationLakeTestIamPermissionCall), [*locations lakes zones actions list*](https://docs.rs/google-dataplex1/4.0.1+20220223/google_dataplex1/api::ProjectLocationLakeZoneActionListCall), [*locations lakes zones assets actions list*](https://docs.rs/google-dataplex1/4.0.1+20220223/google_dataplex1/api::ProjectLocationLakeZoneAssetActionListCall), [*locations lakes zones assets create*](https://docs.rs/google-dataplex1/4.0.1+20220223/google_dataplex1/api::ProjectLocationLakeZoneAssetCreateCall), [*locations lakes zones assets delete*](https://docs.rs/google-dataplex1/4.0.1+20220223/google_dataplex1/api::ProjectLocationLakeZoneAssetDeleteCall), [*locations lakes zones assets get*](https://docs.rs/google-dataplex1/4.0.1+20220223/google_dataplex1/api::ProjectLocationLakeZoneAssetGetCall), [*locations lakes zones assets get iam policy*](https://docs.rs/google-dataplex1/4.0.1+20220223/google_dataplex1/api::ProjectLocationLakeZoneAssetGetIamPolicyCall), [*locations lakes zones assets list*](https://docs.rs/google-dataplex1/4.0.1+20220223/google_dataplex1/api::ProjectLocationLakeZoneAssetListCall), [*locations lakes zones assets patch*](https://docs.rs/google-dataplex1/4.0.1+20220223/google_dataplex1/api::ProjectLocationLakeZoneAssetPatchCall), [*locations lakes zones assets set iam policy*](https://docs.rs/google-dataplex1/4.0.1+20220223/google_dataplex1/api::ProjectLocationLakeZoneAssetSetIamPolicyCall), [*locations lakes zones assets test iam permissions*](https://docs.rs/google-dataplex1/4.0.1+20220223/google_dataplex1/api::ProjectLocationLakeZoneAssetTestIamPermissionCall), [*locations lakes zones create*](https://docs.rs/google-dataplex1/4.0.1+20220223/google_dataplex1/api::ProjectLocationLakeZoneCreateCall), [*locations lakes zones delete*](https://docs.rs/google-dataplex1/4.0.1+20220223/google_dataplex1/api::ProjectLocationLakeZoneDeleteCall), [*locations lakes zones entities create*](https://docs.rs/google-dataplex1/4.0.1+20220223/google_dataplex1/api::ProjectLocationLakeZoneEntityCreateCall), [*locations lakes zones entities delete*](https://docs.rs/google-dataplex1/4.0.1+20220223/google_dataplex1/api::ProjectLocationLakeZoneEntityDeleteCall), [*locations lakes zones entities get*](https://docs.rs/google-dataplex1/4.0.1+20220223/google_dataplex1/api::ProjectLocationLakeZoneEntityGetCall), [*locations lakes zones entities list*](https://docs.rs/google-dataplex1/4.0.1+20220223/google_dataplex1/api::ProjectLocationLakeZoneEntityListCall), [*locations lakes zones entities partitions create*](https://docs.rs/google-dataplex1/4.0.1+20220223/google_dataplex1/api::ProjectLocationLakeZoneEntityPartitionCreateCall), [*locations lakes zones entities partitions delete*](https://docs.rs/google-dataplex1/4.0.1+20220223/google_dataplex1/api::ProjectLocationLakeZoneEntityPartitionDeleteCall), [*locations lakes zones entities partitions get*](https://docs.rs/google-dataplex1/4.0.1+20220223/google_dataplex1/api::ProjectLocationLakeZoneEntityPartitionGetCall), [*locations lakes zones entities partitions list*](https://docs.rs/google-dataplex1/4.0.1+20220223/google_dataplex1/api::ProjectLocationLakeZoneEntityPartitionListCall), [*locations lakes zones entities update*](https://docs.rs/google-dataplex1/4.0.1+20220223/google_dataplex1/api::ProjectLocationLakeZoneEntityUpdateCall), [*locations lakes zones get*](https://docs.rs/google-dataplex1/4.0.1+20220223/google_dataplex1/api::ProjectLocationLakeZoneGetCall), [*locations lakes zones get iam policy*](https://docs.rs/google-dataplex1/4.0.1+20220223/google_dataplex1/api::ProjectLocationLakeZoneGetIamPolicyCall), [*locations lakes zones list*](https://docs.rs/google-dataplex1/4.0.1+20220223/google_dataplex1/api::ProjectLocationLakeZoneListCall), [*locations lakes zones patch*](https://docs.rs/google-dataplex1/4.0.1+20220223/google_dataplex1/api::ProjectLocationLakeZonePatchCall), [*locations lakes zones set iam policy*](https://docs.rs/google-dataplex1/4.0.1+20220223/google_dataplex1/api::ProjectLocationLakeZoneSetIamPolicyCall), [*locations lakes zones test iam permissions*](https://docs.rs/google-dataplex1/4.0.1+20220223/google_dataplex1/api::ProjectLocationLakeZoneTestIamPermissionCall), [*locations list*](https://docs.rs/google-dataplex1/4.0.1+20220223/google_dataplex1/api::ProjectLocationListCall), [*locations operations cancel*](https://docs.rs/google-dataplex1/4.0.1+20220223/google_dataplex1/api::ProjectLocationOperationCancelCall), [*locations operations delete*](https://docs.rs/google-dataplex1/4.0.1+20220223/google_dataplex1/api::ProjectLocationOperationDeleteCall), [*locations operations get*](https://docs.rs/google-dataplex1/4.0.1+20220223/google_dataplex1/api::ProjectLocationOperationGetCall) and [*locations operations list*](https://docs.rs/google-dataplex1/4.0.1+20220223/google_dataplex1/api::ProjectLocationOperationListCall)
# Structure of this Library
The API is structured into the following primary items:
* **[Hub](https://docs.rs/google-dataplex1/4.0.1+20220223/google_dataplex1/CloudDataplex)**
* a central object to maintain state and allow accessing all *Activities*
* creates [*Method Builders*](https://docs.rs/google-dataplex1/4.0.1+20220223/google_dataplex1/client::MethodsBuilder) which in turn
allow access to individual [*Call Builders*](https://docs.rs/google-dataplex1/4.0.1+20220223/google_dataplex1/client::CallBuilder)
* **[Resources](https://docs.rs/google-dataplex1/4.0.1+20220223/google_dataplex1/client::Resource)**
* primary types that you can apply *Activities* to
* a collection of properties and *Parts*
* **[Parts](https://docs.rs/google-dataplex1/4.0.1+20220223/google_dataplex1/client::Part)**
* a collection of properties
* never directly used in *Activities*
* **[Activities](https://docs.rs/google-dataplex1/4.0.1+20220223/google_dataplex1/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.projects().locations_lakes_environments_create(...).doit().await
let r = hub.projects().locations_lakes_environments_delete(...).doit().await
let r = hub.projects().locations_lakes_environments_patch(...).doit().await
let r = hub.projects().locations_lakes_tasks_create(...).doit().await
let r = hub.projects().locations_lakes_tasks_delete(...).doit().await
let r = hub.projects().locations_lakes_tasks_patch(...).doit().await
let r = hub.projects().locations_lakes_zones_assets_create(...).doit().await
let r = hub.projects().locations_lakes_zones_assets_delete(...).doit().await
let r = hub.projects().locations_lakes_zones_assets_patch(...).doit().await
let r = hub.projects().locations_lakes_zones_create(...).doit().await
let r = hub.projects().locations_lakes_zones_delete(...).doit().await
let r = hub.projects().locations_lakes_zones_patch(...).doit().await
let r = hub.projects().locations_lakes_create(...).doit().await
let r = hub.projects().locations_lakes_delete(...).doit().await
let r = hub.projects().locations_lakes_patch(...).doit().await
let r = hub.projects().locations_operations_get(...).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-dataplex1 = "*"
serde = "^1.0"
serde_json = "^1.0"
```
## A complete example
```Rust
extern crate hyper;
extern crate hyper_rustls;
extern crate google_dataplex1 as dataplex1;
use dataplex1::api::GoogleCloudDataplexV1Environment;
use dataplex1::{Result, Error};
use std::default::Default;
use dataplex1::{CloudDataplex, oauth2, hyper, hyper_rustls};
// 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 = CloudDataplex::new(hyper::Client::builder().build(hyper_rustls::HttpsConnectorBuilder::new().with_native_roots().https_or_http().enable_http1().enable_http2().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 = GoogleCloudDataplexV1Environment::default();
// You can configure optional parameters by calling the respective setters at will, and
// execute the final call using `doit()`.
// Values shown here are possibly random and not representative !
let result = hub.projects().locations_lakes_environments_create(req, "parent")
.validate_only(true)
.environment_id("voluptua.")
.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-dataplex1/4.0.1+20220223/google_dataplex1/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-dataplex1/4.0.1+20220223/google_dataplex1/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-dataplex1/4.0.1+20220223/google_dataplex1/client::Result), should be
read by you to obtain the media.
If such a method also supports a [Response Result](https://docs.rs/google-dataplex1/4.0.1+20220223/google_dataplex1/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-dataplex1/4.0.1+20220223/google_dataplex1/client::Delegate) to the
[Method Builder](https://docs.rs/google-dataplex1/4.0.1+20220223/google_dataplex1/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-dataplex1/4.0.1+20220223/google_dataplex1/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-dataplex1/4.0.1+20220223/google_dataplex1/client::RequestValue) and
[decodable](https://docs.rs/google-dataplex1/4.0.1+20220223/google_dataplex1/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-dataplex1/4.0.1+20220223/google_dataplex1/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-dataplex1/4.0.1+20220223/google_dataplex1/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-dataplex1/4.0.1+20220223/google_dataplex1/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
# License
The **dataplex1** 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
Reference in New Issue View Git Blame Copy Permalink