[−][src]Crate google_iap1
This documentation was generated from Cloud IAP crate version 1.0.13+20200406, where 20200406 is the exact revision of the iap:v1 schema built by the mako code generator v1.0.13.
Everything else about the Cloud IAP v1 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
- brands create, brands get, brands identity aware proxy clients create, brands identity aware proxy clients delete, brands identity aware proxy clients get, brands identity aware proxy clients list, brands identity aware proxy clients reset secret and brands list
Other activities are ...
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().brands_identity_aware_proxy_clients_create(...).doit() let r = hub.projects().brands_identity_aware_proxy_clients_reset_secret(...).doit() let r = hub.projects().brands_identity_aware_proxy_clients_get(...).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-iap1 = "*"
# 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_iap1 as iap1; use iap1::IdentityAwareProxyClient; use iap1::{Result, Error}; use std::default::Default; use oauth2::{Authenticator, DefaultAuthenticatorDelegate, ApplicationSecret, MemoryStorage}; use iap1::CloudIAP; // 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 = CloudIAP::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 = IdentityAwareProxyClient::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().brands_identity_aware_proxy_clients_create(req, "parent") .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 enocodable 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
AccessDeniedPageSettings | Custom content configuration for access denied page. IAP allows customers to define a custom URI to use as the error page when access is denied to users. If IAP prevents access to this page, the default IAP error page will be displayed instead. |
AccessSettings | Access related settings for IAP protected apps. |
ApplicationSettings | Wrapper over application specific settings for IAP. |
Binding | Associates |
Brand | OAuth brand data. NOTE: Only contains a portion of the data that describes a brand. |
Chunk | |
CloudIAP | Central instance to access all CloudIAP related resource activities |
ContentRange | Implements the Content-Range header, for serialization only |
CorsSettings | Allows customers to configure HTTP request paths that'll allow HTTP OPTIONS call to bypass authentication and authorization. |
CsmSettings | Configuration for RCTokens generated for CSM workloads protected by IAP. RCTokens are IAP generated JWTs that can be verified at the application. The RCToken is primarily used for ISTIO deployments, and can be scoped to a single mesh by configuring the audience field accordingly |
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: |
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. |
GcipSettings | Allows customers to configure tenant_id for GCIP instance per-app. |
GetIamPolicyRequest | Request message for |
GetPolicyOptions | Encapsulates settings provided to GetIamPolicy. |
IapSettings | The IAP configurable settings. |
IdentityAwareProxyClient | Contains the data that describes an Identity Aware Proxy owned client. |
JsonServerError | A utility type which can decode a server response that indicates error |
ListBrandsResponse | Response message for ListBrands. |
ListIdentityAwareProxyClientsResponse | Response message for ListIdentityAwareProxyClients. |
MethodGetIamPolicyCall | Gets the access control policy for an Identity-Aware Proxy protected resource. More information about managing access via IAP can be found at: https://cloud.google.com/iap/docs/managing-access#managing_access_via_the_api |
MethodGetIapSettingCall | Gets the IAP settings on a particular IAP protected resource. |
MethodInfo | Contains information about an API request. |
MethodMethods | A builder providing access to all free methods, which are not associated with a particular resource.
It is not used directly, but through the |
MethodSetIamPolicyCall | Sets the access control policy for an Identity-Aware Proxy protected resource. Replaces any existing policy. More information about managing access via IAP can be found at: https://cloud.google.com/iap/docs/managing-access#managing_access_via_the_api |
MethodTestIamPermissionCall | Returns permissions that a caller has on the Identity-Aware Proxy protected resource. More information about managing access via IAP can be found at: https://cloud.google.com/iap/docs/managing-access#managing_access_via_the_api |
MethodUpdateIapSettingCall | Updates the IAP settings on a particular IAP protected resource. It
replaces all fields unless the |
MultiPartReader | Provides a |
OAuthSettings | Configuration for OAuth login&consent flow behavior as well as for OAuth Credentials. |
Policy | An Identity and Access Management (IAM) policy, which specifies access controls for Google Cloud resources. |
PolicyDelegationSettings | PolicyDelegationConfig allows google-internal teams to use IAP for apps hosted in a tenant project. Using these settings, the app can delegate permission check to happen against the linked customer project. This is only ever supposed to be used by google internal teams, hence the restriction on the proto. |
PolicyName | There is no detailed description. |
ProjectBrandCreateCall | Constructs a new OAuth brand for the project if one does not exist. The created brand is "internal only", meaning that OAuth clients created under it only accept requests from users who belong to the same G Suite organization as the project. The brand is created in an un-reviewed status. NOTE: The "internal only" status can be manually changed in the Google Cloud console. Requires that a brand does not already exist for the project, and that the specified support email is owned by the caller. |
ProjectBrandGetCall | Retrieves the OAuth brand of the project. |
ProjectBrandIdentityAwareProxyClientCreateCall | Creates an Identity Aware Proxy (IAP) OAuth client. The client is owned by IAP. Requires that the brand for the project exists and that it is set for internal-only use. |
ProjectBrandIdentityAwareProxyClientDeleteCall | Deletes an Identity Aware Proxy (IAP) OAuth client. Useful for removing obsolete clients, managing the number of clients in a given project, and cleaning up after tests. Requires that the client is owned by IAP. |
ProjectBrandIdentityAwareProxyClientGetCall | Retrieves an Identity Aware Proxy (IAP) OAuth client. Requires that the client is owned by IAP. |
ProjectBrandIdentityAwareProxyClientListCall | Lists the existing clients for the brand. |
ProjectBrandIdentityAwareProxyClientResetSecretCall | Resets an Identity Aware Proxy (IAP) OAuth client secret. Useful if the secret was compromised. Requires that the client is owned by IAP. |
ProjectBrandListCall | Lists the existing brands for the project. |
ProjectMethods | A builder providing access to all methods supported on project resources.
It is not used directly, but through the |
RangeResponseHeader | |
ResetIdentityAwareProxyClientSecretRequest | The request sent to ResetIdentityAwareProxyClientSecret. |
ResourceType | There is no detailed description. |
ResumableUploadHelper | A utility type to perform a resumable upload from start to end. |
ServerError | |
ServerMessage | |
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. |