[−][src]Crate google_cloudprivatecatalogproducer1_beta1

This documentation was generated from Cloud PrivateCatalog Producer crate version 1.0.10+20190622, where 20190622 is the exact revision of the cloudprivatecatalogproducer:v1beta1 schema built by the mako code generator v1.0.10.

Everything else about the Cloud PrivateCatalog Producer 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 ...

catalogs
associations create, associations delete, associations get, associations list, create, delete, get, get iam policy, list, patch, products copy, products create, products delete, products get, products icons upload, products list, products patch, products versions create, products versions delete, products versions get, products versions list, products versions patch, set iam policy, test iam permissions and undelete
operations
cancel, delete, get and list

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.operations().cancel(...).doit()
let r = hub.catalogs().products_versions_delete(...).doit()
let r = hub.catalogs().products_icons_upload(...).doit()
let r = hub.catalogs().associations_delete(...).doit()
let r = hub.operations().delete(...).doit()
let r = hub.catalogs().products_delete(...).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-cloudprivatecatalogproducer1_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_cloudprivatecatalogproducer1_beta1 as cloudprivatecatalogproducer1_beta1;
use cloudprivatecatalogproducer1_beta1::GoogleLongrunningCancelOperationRequest;
use cloudprivatecatalogproducer1_beta1::{Result, Error};
use std::default::Default;
use oauth2::{Authenticator, DefaultAuthenticatorDelegate, ApplicationSecret, MemoryStorage};
use cloudprivatecatalogproducer1_beta1::CloudPrivateCatalogProducer;
 
// 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 = CloudPrivateCatalogProducer::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 = GoogleLongrunningCancelOperationRequest::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.operations().cancel(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 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

CatalogAssociationCreateCall	Creates an Association instance under a given Catalog.
CatalogAssociationDeleteCall	Deletes the given Association.
CatalogAssociationGetCall	Returns the requested Association resource.
CatalogAssociationListCall	Lists all Association resources under a catalog.
CatalogCreateCall	Creates a new Catalog resource.
CatalogDeleteCall	Soft deletes an existing Catalog and all resources under it. The catalog can only be deleted if there is no associations under it or DeleteCatalogRequest.force is true. The delete operation can be recovered by the PrivateCatalogProducer.UndeleteCatalog method.
CatalogGetCall	Returns the requested Catalog resource.
CatalogGetIamPolicyCall	Gets IAM policy for the specified Catalog.
CatalogListCall	Lists Catalog resources that the producer has access to, within the scope of the parent resource.
CatalogMethods	A builder providing access to all methods supported on catalog resources. It is not used directly, but through the `CloudPrivateCatalogProducer` hub.
CatalogPatchCall	Updates a specific Catalog resource.
CatalogProductCopyCall	Copies a Product under another Catalog.
CatalogProductCreateCall	Creates a Product instance under a given Catalog.
CatalogProductDeleteCall	Hard deletes a Product.
CatalogProductGetCall	Returns the requested Product resource.
CatalogProductIconUploadCall	Creates an Icon instance under a given Product. If Product only has a default icon, a new Icon instance is created and associated with the given Product. If Product already has a non-default icon, the action creates a new Icon instance, associates the newly created Icon with the given Product and deletes the old icon.
CatalogProductListCall	Lists Product resources that the producer has access to, within the scope of the parent catalog.
CatalogProductPatchCall	Updates a specific Product resource.
CatalogProductVersionCreateCall	Creates a Version instance under a given Product.
CatalogProductVersionDeleteCall	Hard deletes a Version.
CatalogProductVersionGetCall	Returns the requested Version resource.
CatalogProductVersionListCall	Lists Version resources that the producer has access to, within the scope of the parent Product.
CatalogProductVersionPatchCall	Updates a specific Version resource.
CatalogSetIamPolicyCall	Sets the IAM policy for the specified Catalog.
CatalogTestIamPermissionCall	Tests the IAM permissions for the specified Catalog.
CatalogUndeleteCall	Undeletes a deleted Catalog and all resources under it.
Chunk
CloudPrivateCatalogProducer	Central instance to access all CloudPrivateCatalogProducer related resource activities
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
GoogleCloudPrivatecatalogproducerV1beta1ListCatalogsResponse	There is no detailed description.
GoogleCloudPrivatecatalogproducerV1beta1UndeleteCatalogRequest	There is no detailed description.
GoogleCloudPrivatecatalogproducerV1beta1Catalog	The producer representation of a catalog which is a curated collection of solutions that can be managed, controlled, and shared by cloud admins.
GoogleCloudPrivatecatalogproducerV1beta1Version	The producer representation of a version, which is a child resource under a `Product` with asset data.
GoogleCloudPrivatecatalogproducerV1beta1ListAssociationsResponse	There is no detailed description.
GoogleCloudPrivatecatalogproducerV1beta1ListVersionsResponse	There is no detailed description.
GoogleCloudPrivatecatalogproducerV1beta1Association	An association tuple that pairs a `Catalog` to a resource that can use the `Catalog`. After association, a google.cloud.privatecatalog.v1beta1.Catalog becomes available to consumers under specified Association.resource and all of its child nodes. Users who have the `cloudprivatecatalog.targets.get` permission on any of the resource nodes can access the catalog and child products under the node.
GoogleCloudPrivatecatalogproducerV1beta1ListProductsResponse	There is no detailed description.
GoogleCloudPrivatecatalogproducerV1beta1Product	The producer representation of a product which is a child resource of `Catalog` with display metadata and a list of `Version` resources.
GoogleCloudPrivatecatalogproducerV1beta1CopyProductRequest	There is no detailed description.
GoogleCloudPrivatecatalogproducerV1beta1UploadIconRequest	There is no detailed description.
GoogleCloudPrivatecatalogproducerV1beta1CreateAssociationRequest	There is no detailed description.
GoogleIamV1Binding	Associates `members` with a `role`.
GoogleIamV1Policy	Defines an Identity and Access Management (IAM) policy. It is used to specify access control policies for Cloud Platform resources.
GoogleIamV1TestIamPermissionsRequest	Request message for `TestIamPermissions` method.
GoogleIamV1TestIamPermissionsResponse	Response message for `TestIamPermissions` method.
GoogleIamV1SetIamPolicyRequest	Request message for `SetIamPolicy` method.
GoogleIamV1AuditConfig	Specifies the audit configuration for a service. The configuration determines which permission types are logged, and what identities, if any, are exempted from logging. An AuditConfig must have one or more AuditLogConfigs.
GoogleIamV1AuditLogConfig	Provides the configuration for logging a type of permissions. Example:
GoogleLongrunningCancelOperationRequest	The request message for Operations.CancelOperation.
GoogleLongrunningListOperationsResponse	The response message for Operations.ListOperations.
GoogleLongrunningOperation	This resource represents a long-running operation that is the result of a network API call.
GoogleProtobufEmpty	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:
GoogleRpcStatus	The `Status` type defines a logical error model that is suitable for different programming environments, including REST APIs and RPC APIs. It is used by gRPC. Each `Status` message contains three pieces of data: error code, error message, and error details.
GoogleTypeExpr	Represents an expression text. Example:
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.
OperationCancelCall	Starts asynchronous cancellation on a long-running operation. The server makes a best effort to cancel the operation, but success is not guaranteed. If the server doesn't support this method, it returns `google.rpc.Code.UNIMPLEMENTED`. Clients can use Operations.GetOperation or other methods to check whether the cancellation succeeded or whether the operation completed despite cancellation. On successful cancellation, the operation is not deleted; instead, it becomes an operation with an Operation.error value with a google.rpc.Status.code of 1, corresponding to `Code.CANCELLED`.
OperationDeleteCall	Deletes a long-running operation. This method indicates that the client is no longer interested in the operation result. It does not cancel the operation. If the server doesn't support this method, it returns `google.rpc.Code.UNIMPLEMENTED`.
OperationGetCall	Gets the latest state of a long-running operation. Clients can use this method to poll the operation result at intervals as recommended by the API service.
OperationListCall	Lists operations that match the specified filter in the request. If the server doesn't support this method, it returns `UNIMPLEMENTED`.
OperationMethods	A builder providing access to all methods supported on operation resources. It is not used directly, but through the `CloudPrivateCatalogProducer` hub.
RangeResponseHeader
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.