[−][src]Crate google_recommender1_beta1

This documentation was generated from Recommender crate version 1.0.14+20200704, where 20200704 is the exact revision of the recommender:v1beta1 schema built by the mako code generator v1.0.14.

Everything else about the Recommender 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 insight types insights get, locations insight types insights list, locations insight types insights mark accepted, locations recommenders recommendations get, locations recommenders recommendations list, locations recommenders recommendations mark claimed, locations recommenders recommendations mark failed and locations recommenders recommendations mark succeeded

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_recommenders_recommendations_mark_succeeded(...).doit()
let r = hub.projects().locations_recommenders_recommendations_mark_claimed(...).doit()
let r = hub.projects().locations_recommenders_recommendations_mark_failed(...).doit()
let r = hub.projects().locations_recommenders_recommendations_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-recommender1_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_recommender1_beta1 as recommender1_beta1;
use recommender1_beta1::GoogleCloudRecommenderV1beta1MarkRecommendationSucceededRequest;
use recommender1_beta1::{Result, Error};
use std::default::Default;
use oauth2::{Authenticator, DefaultAuthenticatorDelegate, ApplicationSecret, MemoryStorage};
use recommender1_beta1::Recommender;
 
// 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 = Recommender::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 = GoogleCloudRecommenderV1beta1MarkRecommendationSucceededRequest::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_recommenders_recommendations_mark_succeeded(req, "name")
             .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

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
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
GoogleCloudRecommenderV1beta1MarkInsightAcceptedRequest	Request for the `MarkInsightAccepted` method.
GoogleCloudRecommenderV1beta1InsightStateInfo	Information related to insight state.
GoogleCloudRecommenderV1beta1InsightRecommendationReference	Reference to an associated recommendation.
GoogleCloudRecommenderV1beta1MarkRecommendationSucceededRequest	Request for the `MarkRecommendationSucceeded` Method.
GoogleCloudRecommenderV1beta1RecommendationContent	Contains what resources are changing and how they are changing.
GoogleCloudRecommenderV1beta1RecommendationStateInfo	Information for state. Contains state and metadata.
GoogleCloudRecommenderV1beta1ListRecommendationsResponse	Response to the `ListRecommendations` method.
GoogleCloudRecommenderV1beta1Operation	Contains an operation for a resource loosely based on the JSON-PATCH format with support for:
GoogleCloudRecommenderV1beta1MarkRecommendationFailedRequest	Request for the `MarkRecommendationFailed` Method.
GoogleCloudRecommenderV1beta1ListInsightsResponse	Response to the `ListInsights` method.
GoogleCloudRecommenderV1beta1MarkRecommendationClaimedRequest	Request for the `MarkRecommendationClaimed` Method.
GoogleCloudRecommenderV1beta1OperationGroup	Group of operations that need to be performed atomically.
GoogleCloudRecommenderV1beta1CostProjection	Contains metadata about how much money a recommendation can save or incur.
GoogleCloudRecommenderV1beta1Insight	An insight along with the information used to derive the insight. The insight may have associated recomendations as well.
GoogleCloudRecommenderV1beta1ValueMatcher	Contains various matching options for values for a GCP resource field.
GoogleCloudRecommenderV1beta1RecommendationInsightReference	Reference to an associated insight.
GoogleCloudRecommenderV1beta1Impact	Contains the impact a recommendation can have for a given category.
GoogleCloudRecommenderV1beta1Recommendation	A recommendation along with a suggested action. E.g., a rightsizing recommendation for an underutilized VM, IAM role recommendations, etc
GoogleTypeMoney	Represents an amount of money with its currency type.
JsonServerError	A utility type which can decode a server response that indicates error
MethodInfo	Contains information about an API request.
MultiPartReader	Provides a `Read` interface that converts multiple parts into the protocol identified by RFC2387. Note: This implementation is just as rich as it needs to be to perform uploads to google APIs, and might not be a fully-featured implementation.
ProjectLocationInsightTypeInsightGetCall	Gets the requested insight. Requires the recommender.*.get IAM permission for the specified insight type.
ProjectLocationInsightTypeInsightListCall	Lists insights for a Cloud project. Requires the recommender.*.list IAM permission for the specified insight type.
ProjectLocationInsightTypeInsightMarkAcceptedCall	Marks the Insight State as Accepted. Users can use this method to indicate to the Recommender API that they have applied some action based on the insight. This stops the insight content from being updated.
ProjectLocationRecommenderRecommendationGetCall	Gets the requested recommendation. Requires the recommender.*.get IAM permission for the specified recommender.
ProjectLocationRecommenderRecommendationListCall	Lists recommendations for a Cloud project. Requires the recommender.*.list IAM permission for the specified recommender.
ProjectLocationRecommenderRecommendationMarkClaimedCall	Marks the Recommendation State as Claimed. Users can use this method to indicate to the Recommender API that they are starting to apply the recommendation themselves. This stops the recommendation content from being updated. Associated insights are frozen and placed in the ACCEPTED state.
ProjectLocationRecommenderRecommendationMarkFailedCall	Marks the Recommendation State as Failed. Users can use this method to indicate to the Recommender API that they have applied the recommendation themselves, and the operation failed. This stops the recommendation content from being updated. Associated insights are frozen and placed in the ACCEPTED state.
ProjectLocationRecommenderRecommendationMarkSucceededCall	Marks the Recommendation State as Succeeded. Users can use this method to indicate to the Recommender API that they have applied the recommendation themselves, and the operation was successful. This stops the recommendation content from being updated. Associated insights are frozen and placed in the ACCEPTED state.
ProjectMethods	A builder providing access to all methods supported on project resources. It is not used directly, but through the `Recommender` hub.
RangeResponseHeader
Recommender	Central instance to access all Recommender related resource activities
ResumableUploadHelper	A utility type to perform a resumable upload from start to end.
ServerError
ServerMessage
XUploadContentType	The `X-Upload-Content-Type` header.

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 `Resource` trait.
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.