pub struct AnalyticsHubService { /* private fields */ }Expand description
Implements a client for the Analytics Hub API.
§Example
let client = AnalyticsHubService::builder().build().await?;
// use `client` to make requests to the Analytics Hub API.§Service Description
The AnalyticsHubService API facilitates data sharing within and across
organizations. It allows data providers to publish listings that reference
shared datasets. With Analytics Hub, users can discover and search for
listings that they have access to. Subscribers can view and subscribe to
listings. When you subscribe to a listing, Analytics Hub creates a linked
dataset in your project.
§Configuration
To configure AnalyticsHubService use the with_* methods in the type returned
by builder(). The default configuration should
work for most applications. Common configuration changes include
- with_endpoint(): by default this client uses the global default endpoint
(
https://analyticshub.googleapis.com). Applications using regional endpoints or running in restricted networks (e.g. a network configured override this default. - with_credentials(): by default this client uses Application Default Credentials. Applications using custom authentication may need to override this default.
§Pooling and Cloning
AnalyticsHubService holds a connection pool internally, it is advised to
create one and the reuse it. You do not need to wrap AnalyticsHubService in
an Rc or Arc to reuse it, because it
already uses an Arc internally.
Implementations§
Source§impl AnalyticsHubService
impl AnalyticsHubService
Sourcepub fn builder() -> ClientBuilder
pub fn builder() -> ClientBuilder
Returns a builder for AnalyticsHubService.
let client = AnalyticsHubService::builder().build().await?;Sourcepub fn from_stub<T>(stub: T) -> Selfwhere
T: AnalyticsHubService + 'static,
pub fn from_stub<T>(stub: T) -> Selfwhere
T: AnalyticsHubService + 'static,
Creates a new client from the provided stub.
The most common case for calling this function is in tests mocking the client’s behavior.
Sourcepub fn list_data_exchanges(&self) -> ListDataExchanges
pub fn list_data_exchanges(&self) -> ListDataExchanges
Lists all data exchanges in a given project and location.
Sourcepub fn list_org_data_exchanges(&self) -> ListOrgDataExchanges
pub fn list_org_data_exchanges(&self) -> ListOrgDataExchanges
Lists all data exchanges from projects in a given organization and location.
Sourcepub fn get_data_exchange(&self) -> GetDataExchange
pub fn get_data_exchange(&self) -> GetDataExchange
Gets the details of a data exchange.
Sourcepub fn create_data_exchange(&self) -> CreateDataExchange
pub fn create_data_exchange(&self) -> CreateDataExchange
Creates a new data exchange.
Sourcepub fn update_data_exchange(&self) -> UpdateDataExchange
pub fn update_data_exchange(&self) -> UpdateDataExchange
Updates an existing data exchange.
Sourcepub fn delete_data_exchange(&self) -> DeleteDataExchange
pub fn delete_data_exchange(&self) -> DeleteDataExchange
Deletes an existing data exchange.
Sourcepub fn list_listings(&self) -> ListListings
pub fn list_listings(&self) -> ListListings
Lists all listings in a given project and location.
Sourcepub fn get_listing(&self) -> GetListing
pub fn get_listing(&self) -> GetListing
Gets the details of a listing.
Sourcepub fn create_listing(&self) -> CreateListing
pub fn create_listing(&self) -> CreateListing
Creates a new listing.
Sourcepub fn update_listing(&self) -> UpdateListing
pub fn update_listing(&self) -> UpdateListing
Updates an existing listing.
Sourcepub fn delete_listing(&self) -> DeleteListing
pub fn delete_listing(&self) -> DeleteListing
Deletes a listing.
Sourcepub fn subscribe_listing(&self) -> SubscribeListing
pub fn subscribe_listing(&self) -> SubscribeListing
Subscribes to a listing.
Currently, with Analytics Hub, you can create listings that reference only BigQuery datasets. Upon subscription to a listing for a BigQuery dataset, Analytics Hub creates a linked dataset in the subscriber’s project.
Sourcepub fn subscribe_data_exchange(&self) -> SubscribeDataExchange
pub fn subscribe_data_exchange(&self) -> SubscribeDataExchange
Creates a Subscription to a Data Clean Room. This is a long-running operation as it will create one or more linked datasets. Throws a Bad Request error if the Data Exchange does not contain any listings.
§Long running operations
This method is used to start, and/or poll a long-running Operation. The Working with long-running operations chapter in the user guide covers these operations in detail.
Sourcepub fn refresh_subscription(&self) -> RefreshSubscription
pub fn refresh_subscription(&self) -> RefreshSubscription
Refreshes a Subscription to a Data Exchange. A Data Exchange can become stale when a publisher adds or removes data. This is a long-running operation as it may create many linked datasets.
§Long running operations
This method is used to start, and/or poll a long-running Operation. The Working with long-running operations chapter in the user guide covers these operations in detail.
Sourcepub fn get_subscription(&self) -> GetSubscription
pub fn get_subscription(&self) -> GetSubscription
Gets the details of a Subscription.
Sourcepub fn list_subscriptions(&self) -> ListSubscriptions
pub fn list_subscriptions(&self) -> ListSubscriptions
Lists all subscriptions in a given project and location.
Lists all subscriptions on a given Data Exchange or Listing.
Sourcepub fn revoke_subscription(&self) -> RevokeSubscription
pub fn revoke_subscription(&self) -> RevokeSubscription
Revokes a given subscription.
Sourcepub fn delete_subscription(&self) -> DeleteSubscription
pub fn delete_subscription(&self) -> DeleteSubscription
Deletes a subscription.
§Long running operations
This method is used to start, and/or poll a long-running Operation. The Working with long-running operations chapter in the user guide covers these operations in detail.
Sourcepub fn get_iam_policy(&self) -> GetIamPolicy
pub fn get_iam_policy(&self) -> GetIamPolicy
Gets the IAM policy.
Sourcepub fn set_iam_policy(&self) -> SetIamPolicy
pub fn set_iam_policy(&self) -> SetIamPolicy
Sets the IAM policy.
Sourcepub fn test_iam_permissions(&self) -> TestIamPermissions
pub fn test_iam_permissions(&self) -> TestIamPermissions
Returns the permissions that a caller has.
Sourcepub fn create_query_template(&self) -> CreateQueryTemplate
pub fn create_query_template(&self) -> CreateQueryTemplate
Creates a new QueryTemplate
Sourcepub fn get_query_template(&self) -> GetQueryTemplate
pub fn get_query_template(&self) -> GetQueryTemplate
Gets a QueryTemplate
Sourcepub fn list_query_templates(&self) -> ListQueryTemplates
pub fn list_query_templates(&self) -> ListQueryTemplates
Lists all QueryTemplates in a given project and location.
Sourcepub fn update_query_template(&self) -> UpdateQueryTemplate
pub fn update_query_template(&self) -> UpdateQueryTemplate
Updates an existing QueryTemplate
Sourcepub fn delete_query_template(&self) -> DeleteQueryTemplate
pub fn delete_query_template(&self) -> DeleteQueryTemplate
Deletes a query template.
Sourcepub fn submit_query_template(&self) -> SubmitQueryTemplate
pub fn submit_query_template(&self) -> SubmitQueryTemplate
Submits a query template for approval.
Sourcepub fn approve_query_template(&self) -> ApproveQueryTemplate
pub fn approve_query_template(&self) -> ApproveQueryTemplate
Approves a query template.
Sourcepub fn get_operation(&self) -> GetOperation
pub fn get_operation(&self) -> GetOperation
Provides the Operations service functionality in this service.
Trait Implementations§
Source§impl Clone for AnalyticsHubService
impl Clone for AnalyticsHubService
Source§fn clone(&self) -> AnalyticsHubService
fn clone(&self) -> AnalyticsHubService
1.0.0 · Source§fn clone_from(&mut self, source: &Self)
fn clone_from(&mut self, source: &Self)
source. Read more