Crate google_pubsub1_beta2 [−] [src]
This documentation was generated from pubsub crate version 1.0.0+20160317, where 20160317 is the exact revision of the pubsub:v1beta2 schema built by the mako code generator v1.0.0.
Everything else about the pubsub v1_beta2 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
- subscriptions acknowledge, subscriptions create, subscriptions delete, subscriptions get, subscriptions get iam policy, subscriptions list, subscriptions modify ack deadline, subscriptions modify push config, subscriptions pull, subscriptions set iam policy, subscriptions test iam permissions, topics create, topics delete, topics get, topics get iam policy, topics list, topics publish, topics set iam policy, topics subscriptions list and topics 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().subscriptions_acknowledge(...).doit() let r = hub.projects().subscriptions_modify_push_config(...).doit() let r = hub.projects().subscriptions_delete(...).doit() let r = hub.projects().topics_delete(...).doit() let r = hub.projects().subscriptions_modify_ack_deadline(...).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-pubsub1_beta2 = "*"
A complete example
extern crate hyper; extern crate yup_oauth2 as oauth2; extern crate google_pubsub1_beta2 as pubsub1_beta2; use pubsub1_beta2::AcknowledgeRequest; use pubsub1_beta2::{Result, Error}; use std::default::Default; use oauth2::{Authenticator, DefaultAuthenticatorDelegate, ApplicationSecret, MemoryStorage}; use pubsub1_beta2::Pubsub; // 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::new(), <MemoryStorage as Default>::default(), None); let mut hub = Pubsub::new(hyper::Client::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 = AcknowledgeRequest::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().subscriptions_acknowledge(req, "subscription") .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
AcknowledgeRequest |
Request for the Acknowledge method. |
Binding |
Associates |
DefaultDelegate |
A delegate with a conservative default implementation, which is used if no other delegate is set. |
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: service Foo { rpc Bar(google.protobuf.Empty) returns (google.protobuf.Empty); } The JSON representation for |
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 |
ListSubscriptionsResponse |
Response for the |
ListTopicSubscriptionsResponse |
Response for the |
ListTopicsResponse |
Response for the |
MethodInfo |
Contains information about an API request. |
ModifyAckDeadlineRequest |
Request for the ModifyAckDeadline method. |
ModifyPushConfigRequest |
Request for the ModifyPushConfig method. |
MultiPartReader |
Provides a |
Policy |
Defines an Identity and Access Management (IAM) policy. It is used to specify access control policies for Cloud Platform resources. A |
ProjectMethods |
A builder providing access to all methods supported on project resources.
It is not used directly, but through the |
ProjectSubscriptionAcknowledgeCall |
Acknowledges the messages associated with the |
ProjectSubscriptionCreateCall |
Creates a subscription to a given topic. If the subscription already exists, returns |
ProjectSubscriptionDeleteCall |
Deletes an existing subscription. All pending messages in the subscription are immediately dropped. Calls to |
ProjectSubscriptionGetCall |
Gets the configuration details of a subscription. |
ProjectSubscriptionGetIamPolicyCall |
Gets the access control policy for a |
ProjectSubscriptionListCall |
Lists matching subscriptions. |
ProjectSubscriptionModifyAckDeadlineCall |
Modifies the ack deadline for a specific message. This method is useful to indicate that more time is needed to process a message by the subscriber, or to make the message available for redelivery if the processing was interrupted. |
ProjectSubscriptionModifyPushConfigCall |
Modifies the |
ProjectSubscriptionPullCall |
Pulls messages from the server. Returns an empty list if there are no messages available in the backlog. The server may return |
ProjectSubscriptionSetIamPolicyCall |
Sets the access control policy on the specified resource. Replaces any existing policy. |
ProjectSubscriptionTestIamPermissionCall |
Returns permissions that a caller has on the specified resource. |
ProjectTopicCreateCall |
Creates the given topic with the given name. |
ProjectTopicDeleteCall |
Deletes the topic with the given name. Returns |
ProjectTopicGetCall |
Gets the configuration of a topic. |
ProjectTopicGetIamPolicyCall |
Gets the access control policy for a |
ProjectTopicListCall |
Lists matching topics. |
ProjectTopicPublishCall |
Adds one or more messages to the topic. Returns |
ProjectTopicSetIamPolicyCall |
Sets the access control policy on the specified resource. Replaces any existing policy. |
ProjectTopicSubscriptionListCall |
Lists the name of the subscriptions for this topic. |
ProjectTopicTestIamPermissionCall |
Returns permissions that a caller has on the specified resource. |
PublishRequest |
Request for the Publish method. |
PublishResponse |
Response for the |
Pubsub |
Central instance to access all Pubsub related resource activities |
PubsubMessage |
A message data and its attributes. The message payload must not be empty; it must contain either a non-empty data field, or at least one attribute. |
PullRequest |
Request for the |
PullResponse |
Response for the |
PushConfig |
Configuration for a push delivery endpoint. |
ReceivedMessage |
A message and its corresponding acknowledgment ID. |
SetIamPolicyRequest |
Request message for |
Subscription |
A subscription resource. |
TestIamPermissionsRequest |
Request message for |
TestIamPermissionsResponse |
Response message for |
Topic |
A topic resource. |
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 |
Functions
remove_json_null_values |
Type Definitions
Result |
A universal result type used as return for all calls. |