AnalyticsHubService

Struct AnalyticsHubService 

Source
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

Source

pub fn builder() -> ClientBuilder

Returns a builder for AnalyticsHubService.

let client = AnalyticsHubService::builder().build().await?;
Source

pub fn from_stub<T>(stub: T) -> Self
where 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.

Source

pub fn list_data_exchanges(&self) -> ListDataExchanges

Lists all data exchanges in a given project and location.

Source

pub fn list_org_data_exchanges(&self) -> ListOrgDataExchanges

Lists all data exchanges from projects in a given organization and location.

Source

pub fn get_data_exchange(&self) -> GetDataExchange

Gets the details of a data exchange.

Source

pub fn create_data_exchange(&self) -> CreateDataExchange

Creates a new data exchange.

Source

pub fn update_data_exchange(&self) -> UpdateDataExchange

Updates an existing data exchange.

Source

pub fn delete_data_exchange(&self) -> DeleteDataExchange

Deletes an existing data exchange.

Source

pub fn list_listings(&self) -> ListListings

Lists all listings in a given project and location.

Source

pub fn get_listing(&self) -> GetListing

Gets the details of a listing.

Source

pub fn create_listing(&self) -> CreateListing

Creates a new listing.

Source

pub fn update_listing(&self) -> UpdateListing

Updates an existing listing.

Source

pub fn delete_listing(&self) -> DeleteListing

Deletes a listing.

Source

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.

Source

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.

Source

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.

Source

pub fn get_subscription(&self) -> GetSubscription

Gets the details of a Subscription.

Source

pub fn list_subscriptions(&self) -> ListSubscriptions

Lists all subscriptions in a given project and location.

Source

pub fn list_shared_resource_subscriptions( &self, ) -> ListSharedResourceSubscriptions

Lists all subscriptions on a given Data Exchange or Listing.

Source

pub fn revoke_subscription(&self) -> RevokeSubscription

Revokes a given subscription.

Source

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.

Source

pub fn get_iam_policy(&self) -> GetIamPolicy

Gets the IAM policy.

Source

pub fn set_iam_policy(&self) -> SetIamPolicy

Sets the IAM policy.

Source

pub fn test_iam_permissions(&self) -> TestIamPermissions

Returns the permissions that a caller has.

Source

pub fn create_query_template(&self) -> CreateQueryTemplate

Creates a new QueryTemplate

Source

pub fn get_query_template(&self) -> GetQueryTemplate

Gets a QueryTemplate

Source

pub fn list_query_templates(&self) -> ListQueryTemplates

Lists all QueryTemplates in a given project and location.

Source

pub fn update_query_template(&self) -> UpdateQueryTemplate

Updates an existing QueryTemplate

Source

pub fn delete_query_template(&self) -> DeleteQueryTemplate

Deletes a query template.

Source

pub fn submit_query_template(&self) -> SubmitQueryTemplate

Submits a query template for approval.

Source

pub fn approve_query_template(&self) -> ApproveQueryTemplate

Approves a query template.

Source

pub fn get_operation(&self) -> GetOperation

Provides the Operations service functionality in this service.

Trait Implementations§

Source§

impl Clone for AnalyticsHubService

Source§

fn clone(&self) -> AnalyticsHubService

Returns a duplicate of the value. Read more
1.0.0 · Source§

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source. Read more
Source§

impl Debug for AnalyticsHubService

Source§

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter. Read more

Auto Trait Implementations§

Blanket Implementations§

Source§

impl<T> Any for T
where T: 'static + ?Sized,

Source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
Source§

impl<T> Borrow<T> for T
where T: ?Sized,

Source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
Source§

impl<T> BorrowMut<T> for T
where T: ?Sized,

Source§

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more
Source§

impl<T> CloneToUninit for T
where T: Clone,

Source§

unsafe fn clone_to_uninit(&self, dest: *mut u8)

🔬This is a nightly-only experimental API. (clone_to_uninit)
Performs copy-assignment from self to dest. Read more
Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

Source§

impl<T> Instrument for T

Source§

fn instrument(self, span: Span) -> Instrumented<Self>

Instruments this type with the provided Span, returning an Instrumented wrapper. Read more
Source§

fn in_current_span(self) -> Instrumented<Self>

Instruments this type with the current Span, returning an Instrumented wrapper. Read more
Source§

impl<T, U> Into<U> for T
where U: From<T>,

Source§

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

Source§

impl<T> PolicyExt for T
where T: ?Sized,

Source§

fn and<P, B, E>(self, other: P) -> And<T, P>
where T: Policy<B, E>, P: Policy<B, E>,

Create a new Policy that returns Action::Follow only if self and other return Action::Follow. Read more
Source§

fn or<P, B, E>(self, other: P) -> Or<T, P>
where T: Policy<B, E>, P: Policy<B, E>,

Create a new Policy that returns Action::Follow if either self or other returns Action::Follow. Read more
Source§

impl<T> ToOwned for T
where T: Clone,

Source§

type Owned = T

The resulting type after obtaining ownership.
Source§

fn to_owned(&self) -> T

Creates owned data from borrowed data, usually by cloning. Read more
Source§

fn clone_into(&self, target: &mut T)

Uses borrowed data to replace owned data, usually by cloning. Read more
Source§

impl<T, U> TryFrom<U> for T
where U: Into<T>,

Source§

type Error = Infallible

The type returned in the event of a conversion error.
Source§

fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

Performs the conversion.
Source§

impl<T, U> TryInto<U> for T
where U: TryFrom<T>,

Source§

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.
Source§

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.
Source§

impl<V, T> VZip<V> for T
where V: MultiLane<T>,

Source§

fn vzip(self) -> V

Source§

impl<T> WithSubscriber for T

Source§

fn with_subscriber<S>(self, subscriber: S) -> WithDispatch<Self>
where S: Into<Dispatch>,

Attaches the provided Subscriber to this type, returning a WithDispatch wrapper. Read more
Source§

fn with_current_subscriber(self) -> WithDispatch<Self>

Attaches the current default Subscriber to this type, returning a WithDispatch wrapper. Read more