[−][src]Crate google_servicedirectory1_beta1
This documentation was generated from Service Directory crate version 1.0.14+20200624, where 20200624 is the exact revision of the servicedirectory:v1beta1 schema built by the mako code generator v1.0.14.
Everything else about the Service Directory v1_beta1 API can be found at the official documentation site. The original source code is on github.
Features
Handle the following Resources with ease from the central hub ...
- projects
- locations get, locations list, locations namespaces create, locations namespaces delete, locations namespaces get, locations namespaces get iam policy, locations namespaces list, locations namespaces patch, locations namespaces services create, locations namespaces services delete, locations namespaces services endpoints create, locations namespaces services endpoints delete, locations namespaces services endpoints get, locations namespaces services endpoints list, locations namespaces services endpoints patch, locations namespaces services get, locations namespaces services get iam policy, locations namespaces services list, locations namespaces services patch, locations namespaces services resolve, locations namespaces services set iam policy, locations namespaces services test iam permissions, locations namespaces set iam policy and locations namespaces test iam permissions
Not what you are looking for ? Find all other Google APIs in their Rust documentation index.
Structure of this Library
The API is structured into the following primary items:
- Hub
- a central object to maintain state and allow accessing all Activities
- creates Method Builders which in turn allow access to individual Call Builders
- Resources
- primary types that you can apply Activities to
- a collection of properties and Parts
- Parts
- a collection of properties
- never directly used in Activities
- Activities
- 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:
let r = hub.resource().activity(...).doit()
Or specifically ...
let r = hub.projects().locations_namespaces_get_iam_policy(...).doit() let r = hub.projects().locations_namespaces_services_set_iam_policy(...).doit() let r = hub.projects().locations_namespaces_set_iam_policy(...).doit() let r = hub.projects().locations_namespaces_services_get_iam_policy(...).doit()
The resource()
and activity(...)
calls create builders. 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 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:
[dependencies]
google-servicedirectory1_beta1 = "*"
# 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
extern crate hyper; extern crate hyper_rustls; extern crate yup_oauth2 as oauth2; extern crate google_servicedirectory1_beta1 as servicedirectory1_beta1; use servicedirectory1_beta1::GetIamPolicyRequest; use servicedirectory1_beta1::{Result, Error}; use std::default::Default; use oauth2::{Authenticator, DefaultAuthenticatorDelegate, ApplicationSecret, MemoryStorage}; use servicedirectory1_beta1::ServiceDirectory; // 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 = ServiceDirectory::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 = GetIamPolicyRequest::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_namespaces_get_iam_policy(req, "resource") .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 enumeration as return value of the doit() methods, or handed as possibly intermediate results to either the Hub Delegate, or the Authenticator Delegate.
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, should be
read by you to obtain the media.
If such a method also supports a Response Result, 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 to the
Method Builder 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 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 and decodable via json. Optionals are used to indicate that partial requests are responses are valid. Most optionals are are considered Parts 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, 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 are handed by copy
- strings are passed as
&str
- request values are moved
Arguments will always be copied or cloned into the builder, to make them independent of their original life times.
Structs
Binding | Associates |
Chunk | |
ContentRange | Implements the Content-Range header, for serialization only |
DefaultDelegate | A delegate with a conservative default implementation, which is used if no other delegate is set. |
DummyNetworkStream | |
Empty | 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: |
Endpoint | An individual endpoint that provides a service. The service must already exist to create an endpoint. |
ErrorResponse | A utility to represent detailed errors we might see in case there are BadRequests. The latter happen if the sent parameters or request structures are unsound |
Expr | Represents a textual expression in the Common Expression Language (CEL) syntax. CEL is a C-like expression language. The syntax and semantics of CEL are documented at https://github.com/google/cel-spec. |
GetIamPolicyRequest | Request message for |
GetPolicyOptions | Encapsulates settings provided to GetIamPolicy. |
JsonServerError | A utility type which can decode a server response that indicates error |
ListEndpointsResponse | The response message for RegistrationService.ListEndpoints. |
ListLocationsResponse | The response message for Locations.ListLocations. |
ListNamespacesResponse | The response message for RegistrationService.ListNamespaces. |
ListServicesResponse | The response message for RegistrationService.ListServices. |
Location | A resource that represents Google Cloud Platform location. |
MethodInfo | Contains information about an API request. |
MultiPartReader | Provides a |
Namespace | A container for services. Namespaces allow administrators to group services together and define permissions for a collection of services. |
Policy | An Identity and Access Management (IAM) policy, which specifies access controls for Google Cloud resources. |
ProjectLocationGetCall | Gets information about a location. |
ProjectLocationListCall | Lists information about the supported locations for this service. |
ProjectLocationNamespaceCreateCall | Creates a namespace, and returns the new Namespace. |
ProjectLocationNamespaceDeleteCall | Deletes a namespace. This also deletes all services and endpoints in the namespace. |
ProjectLocationNamespaceGetCall | Gets a namespace. |
ProjectLocationNamespaceGetIamPolicyCall | Gets the IAM Policy for a resource (namespace or service only). |
ProjectLocationNamespaceListCall | Lists all namespaces. |
ProjectLocationNamespacePatchCall | Updates a namespace. |
ProjectLocationNamespaceServiceCreateCall | Creates a service, and returns the new Service. |
ProjectLocationNamespaceServiceDeleteCall | Deletes a service. This also deletes all endpoints associated with the service. |
ProjectLocationNamespaceServiceEndpointCreateCall | Creates a endpoint, and returns the new Endpoint. |
ProjectLocationNamespaceServiceEndpointDeleteCall | Deletes a endpoint. |
ProjectLocationNamespaceServiceEndpointGetCall | Gets a endpoint. |
ProjectLocationNamespaceServiceEndpointListCall | Lists all endpoints. |
ProjectLocationNamespaceServiceEndpointPatchCall | Updates a endpoint. |
ProjectLocationNamespaceServiceGetCall | Gets a service. |
ProjectLocationNamespaceServiceGetIamPolicyCall | Gets the IAM Policy for a resource (namespace or service only). |
ProjectLocationNamespaceServiceListCall | Lists all services belonging to a namespace. |
ProjectLocationNamespaceServicePatchCall | Updates a service. |
ProjectLocationNamespaceServiceResolveCall | Returns a service and its associated endpoints. Resolving a service is not considered an active developer method. |
ProjectLocationNamespaceServiceSetIamPolicyCall | Sets the IAM Policy for a resource (namespace or service only). |
ProjectLocationNamespaceServiceTestIamPermissionCall | Tests IAM permissions for a resource (namespace or service only). |
ProjectLocationNamespaceSetIamPolicyCall | Sets the IAM Policy for a resource (namespace or service only). |
ProjectLocationNamespaceTestIamPermissionCall | Tests IAM permissions for a resource (namespace or service only). |
ProjectMethods | A builder providing access to all methods supported on project resources.
It is not used directly, but through the |
RangeResponseHeader | |
ResolveServiceRequest | The request message for LookupService.ResolveService. Looks up a service by its name, returns the service and its endpoints. |
ResolveServiceResponse | The response message for LookupService.ResolveService. |
ResumableUploadHelper | A utility type to perform a resumable upload from start to end. |
ServerError | |
ServerMessage | |
Service | An individual service. A service contains a name and optional metadata. A service must exist before endpoints can be added to it. |
ServiceDirectory | Central instance to access all ServiceDirectory related resource activities |
SetIamPolicyRequest | Request message for |
TestIamPermissionsRequest | Request message for |
TestIamPermissionsResponse | Response message for |
XUploadContentType | The |
Enums
Error | |
Scope | Identifies the an OAuth2 authorization scope. A scope is needed when requesting an authorization token. |
Traits
CallBuilder | Identifies types which represent builders for a particular resource method |
Delegate | A trait specifying functionality to help controlling any request performed by the API. The trait has a conservative default implementation. |
Hub | Identifies the Hub. There is only one per library, this trait is supposed to make intended use more explicit. The hub allows to access all resource methods more easily. |
MethodsBuilder | Identifies types for building methods of a particular resource type |
NestedType | Identifies types which are only used by other types internally. They have no special meaning, this trait just marks them for completeness. |
Part | Identifies types which are only used as part of other types, which
usually are carrying the |
ReadSeek | A utility to specify reader types which provide seeking capabilities too |
RequestValue | Identifies types which are used in API requests. |
Resource | Identifies types which can be inserted and deleted. Types with this trait are most commonly used by clients of this API. |
ResponseResult | Identifies types which are used in API responses. |
ToParts | A trait for all types that can convert themselves into a parts string |
UnusedType | Identifies types which are not actually used by the API This might be a bug within the google API schema. |
Functions
remove_json_null_values |
Type Definitions
Result | A universal result type used as return for all calls. |