[−][src]Crate google_bigtableadmin2
This documentation was generated from Bigtable Admin crate version 1.0.12+20190506, where 20190506 is the exact revision of the bigtableadmin:v2 schema built by the mako code generator v1.0.12.
Everything else about the Bigtable Admin v2 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 ...
- operations
- cancel, delete, get and projects operations list
- projects
- instances app profiles create, instances app profiles delete, instances app profiles get, instances app profiles list, instances app profiles patch, instances clusters create, instances clusters delete, instances clusters get, instances clusters list, instances clusters update, instances create, instances delete, instances get, instances get iam policy, instances list, instances partial update instance, instances set iam policy, instances tables check consistency, instances tables create, instances tables delete, instances tables drop row range, instances tables generate consistency token, instances tables get, instances tables get iam policy, instances tables list, instances tables modify column families, instances tables set iam policy, instances tables test iam permissions, instances test iam permissions, instances update, locations get and locations 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().projects_operations_list(...).doit() let r = hub.operations().delete(...).doit() let r = hub.operations().get(...).doit() let r = hub.projects().instances_create(...).doit() let r = hub.operations().cancel(...).doit() let r = hub.projects().instances_app_profiles_patch(...).doit() let r = hub.projects().instances_partial_update_instance(...).doit() let r = hub.projects().instances_clusters_create(...).doit() let r = hub.projects().instances_clusters_update(...).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-bigtableadmin2 = "*"
# 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_bigtableadmin2 as bigtableadmin2; use bigtableadmin2::{Result, Error}; use std::default::Default; use oauth2::{Authenticator, DefaultAuthenticatorDelegate, ApplicationSecret, MemoryStorage}; use bigtableadmin2::BigtableAdmin; // 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 = BigtableAdmin::new(hyper::Client::with_connector(hyper::net::HttpsConnector::new(hyper_rustls::TlsClient::new())), auth); // 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().projects_operations_list("name") .page_token("dolores") .page_size(-63) .filter("accusam") .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
AppProfile | A configuration object describing how Cloud Bigtable should treat traffic from a particular end user application. |
AuditConfig | 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. |
AuditLogConfig | Provides the configuration for logging a type of permissions. Example: |
BigtableAdmin | Central instance to access all BigtableAdmin related resource activities |
Binding | Associates |
CheckConsistencyRequest | Request message for google.bigtable.admin.v2.BigtableTableAdmin.CheckConsistency |
CheckConsistencyResponse | Response message for google.bigtable.admin.v2.BigtableTableAdmin.CheckConsistency |
Chunk | |
Cluster | A resizable group of nodes in a particular cloud location, capable of serving all Tables in the parent Instance. |
ClusterState | The state of a table's data in a particular cluster. |
ColumnFamily | A set of columns within a table which share a common configuration. |
ContentRange | Implements the Content-Range header, for serialization only |
CreateInstanceRequest | Request message for BigtableInstanceAdmin.CreateInstance. |
CreateTableRequest | Request message for google.bigtable.admin.v2.BigtableTableAdmin.CreateTable |
DefaultDelegate | A delegate with a conservative default implementation, which is used if no other delegate is set. |
DropRowRangeRequest | Request message for google.bigtable.admin.v2.BigtableTableAdmin.DropRowRange |
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 an expression text. Example: |
GcRule | Rule for determining which cells to delete during garbage collection. |
GenerateConsistencyTokenRequest | Request message for google.bigtable.admin.v2.BigtableTableAdmin.GenerateConsistencyToken |
GenerateConsistencyTokenResponse | Response message for google.bigtable.admin.v2.BigtableTableAdmin.GenerateConsistencyToken |
GetIamPolicyRequest | Request message for |
Instance | A collection of Bigtable Tables and the resources that serve them. All tables in an instance are served from all Clusters in the instance. |
Intersection | A GcRule which deletes cells matching all of the given rules. |
JsonServerError | A utility type which can decode a server response that indicates error |
ListAppProfilesResponse | Response message for BigtableInstanceAdmin.ListAppProfiles. |
ListClustersResponse | Response message for BigtableInstanceAdmin.ListClusters. |
ListInstancesResponse | Response message for BigtableInstanceAdmin.ListInstances. |
ListLocationsResponse | The response message for Locations.ListLocations. |
ListOperationsResponse | The response message for Operations.ListOperations. |
ListTablesResponse | Response message for google.bigtable.admin.v2.BigtableTableAdmin.ListTables |
Location | A resource that represents Google Cloud Platform location. |
MethodInfo | Contains information about an API request. |
Modification | A create, update, or delete of a particular column family. |
ModifyColumnFamiliesRequest | Request message for google.bigtable.admin.v2.BigtableTableAdmin.ModifyColumnFamilies |
MultiClusterRoutingUseAny | Read/write requests may be routed to any cluster in the instance, and will fail over to another cluster in the event of transient errors or delays. Choosing this option sacrifices read-your-writes consistency to improve availability. |
MultiPartReader | Provides a |
Operation | This resource represents a long-running operation that is the result of a network API call. |
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
|
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
|
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. |
OperationMethods | A builder providing access to all methods supported on operation resources.
It is not used directly, but through the |
OperationProjectOperationListCall | Lists operations that match the specified filter in the request. If the
server doesn't support this method, it returns |
Policy | Defines an Identity and Access Management (IAM) policy. It is used to specify access control policies for Cloud Platform resources. |
ProjectInstanceAppProfileCreateCall | Creates an app profile within an instance. |
ProjectInstanceAppProfileDeleteCall | Deletes an app profile from an instance. |
ProjectInstanceAppProfileGetCall | Gets information about an app profile. |
ProjectInstanceAppProfileListCall | Lists information about app profiles in an instance. |
ProjectInstanceAppProfilePatchCall | Updates an app profile within an instance. |
ProjectInstanceClusterCreateCall | Creates a cluster within an instance. |
ProjectInstanceClusterDeleteCall | Deletes a cluster from an instance. |
ProjectInstanceClusterGetCall | Gets information about a cluster. |
ProjectInstanceClusterListCall | Lists information about clusters in an instance. |
ProjectInstanceClusterUpdateCall | Updates a cluster within an instance. |
ProjectInstanceCreateCall | Create an instance within a project. |
ProjectInstanceDeleteCall | Delete an instance from a project. |
ProjectInstanceGetCall | Gets information about an instance. |
ProjectInstanceGetIamPolicyCall | Gets the access control policy for an instance resource. Returns an empty policy if an instance exists but does not have a policy set. |
ProjectInstanceListCall | Lists information about instances in a project. |
ProjectInstancePartialUpdateInstanceCall | Partially updates an instance within a project. This method can modify all fields of an Instance and is the preferred way to update an Instance. |
ProjectInstanceSetIamPolicyCall | Sets the access control policy on an instance resource. Replaces any existing policy. |
ProjectInstanceTableCheckConsistencyCall | Checks replication consistency based on a consistency token, that is, if replication has caught up based on the conditions specified in the token and the check request. |
ProjectInstanceTableCreateCall | Creates a new table in the specified instance. The table can be created with a full set of initial column families, specified in the request. |
ProjectInstanceTableDeleteCall | Permanently deletes a specified table and all of its data. |
ProjectInstanceTableDropRowRangeCall | Permanently drop/delete a row range from a specified table. The request can specify whether to delete all rows in a table, or only those that match a particular prefix. |
ProjectInstanceTableGenerateConsistencyTokenCall | Generates a consistency token for a Table, which can be used in CheckConsistency to check whether mutations to the table that finished before this call started have been replicated. The tokens will be available for 90 days. |
ProjectInstanceTableGetCall | Gets metadata information about the specified table. |
ProjectInstanceTableGetIamPolicyCall | Gets the access control policy for an instance resource. Returns an empty policy if an table exists but does not have a policy set. |
ProjectInstanceTableListCall | Lists all tables served from a specified instance. |
ProjectInstanceTableModifyColumnFamilyCall | Performs a series of column family modifications on the specified table. Either all or none of the modifications will occur before this method returns, but data requests received prior to that point may see a table where only some modifications have taken effect. |
ProjectInstanceTableSetIamPolicyCall | Sets the access control policy on a table resource. Replaces any existing policy. |
ProjectInstanceTableTestIamPermissionCall | Returns permissions that the caller has on the specified table resource. |
ProjectInstanceTestIamPermissionCall | Returns permissions that the caller has on the specified instance resource. |
ProjectInstanceUpdateCall | Updates an instance within a project. This method updates only the display name and type for an Instance. To update other Instance properties, such as labels, use PartialUpdateInstance. |
ProjectLocationGetCall | Gets information about a location. |
ProjectLocationListCall | Lists information about the supported locations for this service. |
ProjectMethods | A builder providing access to all methods supported on project resources.
It is not used directly, but through the |
RangeResponseHeader | |
ResumableUploadHelper | A utility type to perform a resumable upload from start to end. |
ServerError | |
ServerMessage | |
SetIamPolicyRequest | Request message for |
SingleClusterRouting | Unconditionally routes all read/write requests to a specific cluster. This option preserves read-your-writes consistency, but does not improve availability. |
Split | An initial split point for a newly created table. |
Status | The |
Table | A collection of user data indexed by row, column, and timestamp. Each table is served using the resources of its parent cluster. |
TestIamPermissionsRequest | Request message for |
TestIamPermissionsResponse | Response message for |
Union | A GcRule which deletes cells matching any of the given rules. |
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. |