Package Classes (0.4.12)

Summary of entries of Classes for analyticshub.

Classes

AnalyticsHubServiceAsyncClient

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.

AnalyticsHubServiceClient

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.

ListDataExchangesAsyncPager

A pager for iterating through list_data_exchanges requests.

This class thinly wraps an initial ListDataExchangesResponse object, and provides an __aiter__ method to iterate through its data_exchanges field.

If there are more pages, the __aiter__ method will make additional ListDataExchanges requests and continue to iterate through the data_exchanges field on the corresponding responses.

All the usual ListDataExchangesResponse attributes are available on the pager. If multiple requests are made, only the most recent response is retained, and thus used for attribute lookup.

ListDataExchangesPager

A pager for iterating through list_data_exchanges requests.

This class thinly wraps an initial ListDataExchangesResponse object, and provides an __iter__ method to iterate through its data_exchanges field.

If there are more pages, the __iter__ method will make additional ListDataExchanges requests and continue to iterate through the data_exchanges field on the corresponding responses.

All the usual ListDataExchangesResponse attributes are available on the pager. If multiple requests are made, only the most recent response is retained, and thus used for attribute lookup.

ListListingsAsyncPager

A pager for iterating through list_listings requests.

This class thinly wraps an initial ListListingsResponse object, and provides an __aiter__ method to iterate through its listings field.

If there are more pages, the __aiter__ method will make additional ListListings requests and continue to iterate through the listings field on the corresponding responses.

All the usual ListListingsResponse attributes are available on the pager. If multiple requests are made, only the most recent response is retained, and thus used for attribute lookup.

ListListingsPager

A pager for iterating through list_listings requests.

This class thinly wraps an initial ListListingsResponse object, and provides an __iter__ method to iterate through its listings field.

If there are more pages, the __iter__ method will make additional ListListings requests and continue to iterate through the listings field on the corresponding responses.

All the usual ListListingsResponse attributes are available on the pager. If multiple requests are made, only the most recent response is retained, and thus used for attribute lookup.

ListOrgDataExchangesAsyncPager

A pager for iterating through list_org_data_exchanges requests.

This class thinly wraps an initial ListOrgDataExchangesResponse object, and provides an __aiter__ method to iterate through its data_exchanges field.

If there are more pages, the __aiter__ method will make additional ListOrgDataExchanges requests and continue to iterate through the data_exchanges field on the corresponding responses.

All the usual ListOrgDataExchangesResponse attributes are available on the pager. If multiple requests are made, only the most recent response is retained, and thus used for attribute lookup.

ListOrgDataExchangesPager

A pager for iterating through list_org_data_exchanges requests.

This class thinly wraps an initial ListOrgDataExchangesResponse object, and provides an __iter__ method to iterate through its data_exchanges field.

If there are more pages, the __iter__ method will make additional ListOrgDataExchanges requests and continue to iterate through the data_exchanges field on the corresponding responses.

All the usual ListOrgDataExchangesResponse attributes are available on the pager. If multiple requests are made, only the most recent response is retained, and thus used for attribute lookup.

ListSharedResourceSubscriptionsAsyncPager

A pager for iterating through list_shared_resource_subscriptions requests.

This class thinly wraps an initial ListSharedResourceSubscriptionsResponse object, and provides an __aiter__ method to iterate through its shared_resource_subscriptions field.

If there are more pages, the __aiter__ method will make additional ListSharedResourceSubscriptions requests and continue to iterate through the shared_resource_subscriptions field on the corresponding responses.

All the usual ListSharedResourceSubscriptionsResponse attributes are available on the pager. If multiple requests are made, only the most recent response is retained, and thus used for attribute lookup.

ListSharedResourceSubscriptionsPager

A pager for iterating through list_shared_resource_subscriptions requests.

This class thinly wraps an initial ListSharedResourceSubscriptionsResponse object, and provides an __iter__ method to iterate through its shared_resource_subscriptions field.

If there are more pages, the __iter__ method will make additional ListSharedResourceSubscriptions requests and continue to iterate through the shared_resource_subscriptions field on the corresponding responses.

All the usual ListSharedResourceSubscriptionsResponse attributes are available on the pager. If multiple requests are made, only the most recent response is retained, and thus used for attribute lookup.

ListSubscriptionsAsyncPager

A pager for iterating through list_subscriptions requests.

This class thinly wraps an initial ListSubscriptionsResponse object, and provides an __aiter__ method to iterate through its subscriptions field.

If there are more pages, the __aiter__ method will make additional ListSubscriptions requests and continue to iterate through the subscriptions field on the corresponding responses.

All the usual ListSubscriptionsResponse attributes are available on the pager. If multiple requests are made, only the most recent response is retained, and thus used for attribute lookup.

ListSubscriptionsPager

A pager for iterating through list_subscriptions requests.

This class thinly wraps an initial ListSubscriptionsResponse object, and provides an __iter__ method to iterate through its subscriptions field.

If there are more pages, the __iter__ method will make additional ListSubscriptions requests and continue to iterate through the subscriptions field on the corresponding responses.

All the usual ListSubscriptionsResponse attributes are available on the pager. If multiple requests are made, only the most recent response is retained, and thus used for attribute lookup.

CreateDataExchangeRequest

Message for creating a data exchange.

CreateListingRequest

Message for creating a listing.

DataExchange

A data exchange is a container that lets you share data. Along with the descriptive information about the data exchange, it contains listings that reference shared datasets.

.. _oneof: https://proto-plus-python.readthedocs.io/en/stable/fields.html#oneofs-mutually-exclusive-fields

DataProvider

Contains details of the data provider.

DeleteDataExchangeRequest

Message for deleting a data exchange.

DeleteListingRequest

Message for deleting a listing.

DeleteSubscriptionRequest

Message for deleting a subscription.

DestinationDataset

Defines the destination bigquery dataset.

LabelsEntry

The abstract base class for a message.

DestinationDatasetReference

Contains the reference that identifies a destination bigquery dataset.

DiscoveryType

Specifies the type of discovery on the discovery page. Note that this does not control the visibility of the exchange/listing which is defined by IAM permission.

GetDataExchangeRequest

Message for getting a data exchange.

GetListingRequest

Message for getting a listing.

GetSubscriptionRequest

Message for getting a subscription.

ListDataExchangesRequest

Message for requesting the list of data exchanges.

ListDataExchangesResponse

Message for response to the list of data exchanges.

ListListingsRequest

Message for requesting the list of listings.

ListListingsResponse

Message for response to the list of Listings.

ListOrgDataExchangesRequest

Message for requesting the list of data exchanges from projects in an organization and location.

ListOrgDataExchangesResponse

Message for response to listing data exchanges in an organization and location.

ListSharedResourceSubscriptionsRequest

Message for listing subscriptions of a shared resource.

ListSharedResourceSubscriptionsResponse

Message for response to the listing of shared resource subscriptions.

ListSubscriptionsRequest

Message for listing subscriptions.

ListSubscriptionsResponse

Message for response to the listing of subscriptions.

Listing

A listing is what gets published into a data exchange that a subscriber can subscribe to. It contains a reference to the data source along with descriptive information that will help subscribers find and subscribe the data.

.. _oneof: https://proto-plus-python.readthedocs.io/en/stable/fields.html#oneofs-mutually-exclusive-fields

BigQueryDatasetSource

A reference to a shared dataset. It is an existing BigQuery dataset with a collection of objects such as tables and views that you want to share with subscribers. When subscriber's subscribe to a listing, Analytics Hub creates a linked dataset in the subscriber's project. A Linked dataset is an opaque, read-only BigQuery dataset that serves as a symbolic link to a shared dataset.

RestrictedExportPolicy

Restricted export policy used to configure restricted export on linked dataset.

SelectedResource

Resource in this dataset that are selectively shared.

.. _oneof: https://proto-plus-python.readthedocs.io/en/stable/fields.html#oneofs-mutually-exclusive-fields

Category

Listing categories.

RestrictedExportConfig

Restricted export config, used to configure restricted export on linked dataset.

State

State of the listing.

OperationMetadata

Represents the metadata of a long-running operation in Analytics Hub.

Publisher

Contains details of the listing publisher.

RefreshSubscriptionRequest

Message for refreshing a subscription.

RefreshSubscriptionResponse

Message for response when you refresh a subscription.

RevokeSubscriptionRequest

Message for revoking a subscription.

RevokeSubscriptionResponse

Message for response when you revoke a subscription.

SharingEnvironmentConfig

Sharing environment is a behavior model for sharing data within a data exchange. This option is configurable for a data exchange.

This message has oneof_ fields (mutually exclusive fields). For each oneof, at most one member field can be set at the same time. Setting any member of the oneof automatically clears all other members.

.. _oneof: https://proto-plus-python.readthedocs.io/en/stable/fields.html#oneofs-mutually-exclusive-fields

DcrExchangeConfig

Data Clean Room (DCR), used for privacy-safe and secured data sharing.

.. _oneof: https://proto-plus-python.readthedocs.io/en/stable/fields.html#oneofs-mutually-exclusive-fields

DefaultExchangeConfig

Default Analytics Hub data exchange, used for secured data sharing.

SubscribeDataExchangeRequest

Message for subscribing to a Data Exchange.

SubscribeDataExchangeResponse

Message for response when you subscribe to a Data Exchange.

SubscribeListingRequest

Message for subscribing to a listing.

.. _oneof: https://proto-plus-python.readthedocs.io/en/stable/fields.html#oneofs-mutually-exclusive-fields

SubscribeListingResponse

Message for response when you subscribe to a listing.

Subscription

A subscription represents a subscribers' access to a particular set of published data. It contains references to associated listings, data exchanges, and linked datasets.

This message has oneof_ fields (mutually exclusive fields). For each oneof, at most one member field can be set at the same time. Setting any member of the oneof automatically clears all other members.

.. _oneof: https://proto-plus-python.readthedocs.io/en/stable/fields.html#oneofs-mutually-exclusive-fields

LinkedDatasetMapEntry

The abstract base class for a message.

LinkedResource

Reference to a linked resource tracked by this Subscription.

.. _oneof: https://proto-plus-python.readthedocs.io/en/stable/fields.html#oneofs-mutually-exclusive-fields

State

State of the subscription.

UpdateDataExchangeRequest

Message for updating a data exchange.

UpdateListingRequest

Message for updating a Listing.

Modules

pagers

API documentation for bigquery_analyticshub_v1.services.analytics_hub_service.pagers module.