Package types (0.4.18)

API documentation for bigquery_analyticshub_v1.types package.

Classes

BigQueryConfig

Configuration for a BigQuery subscription.

CloudStorageConfig

Configuration for a Cloud Storage subscription.

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

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.

DeadLetterPolicy

Dead lettering is done on a best effort basis. The same message might be dead lettered multiple times.

If validation on any of the fields fails at subscription creation/updation, the create/update subscription request will fail.

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.

DestinationDatasetReference

DestinationPubSubSubscription

Defines the destination Pub/Sub subscription.

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.

ExpirationPolicy

A policy that specifies the conditions for resource expiration (i.e., automatic resource deletion).

GetDataExchangeRequest

Message for getting a data exchange.

GetListingRequest

Message for getting a listing.

GetSubscriptionRequest

Message for getting a subscription.

JavaScriptUDF

User-defined JavaScript function that can transform or filter a Pub/Sub message.

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.

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

MessageTransform

All supported message transforms types.

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

OperationMetadata

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

PubSubSubscription

Defines the destination Pub/Sub subscription. If none of push_config, bigquery_config, cloud_storage_config, pubsub_export_config, or pubsublite_export_config is set, then the subscriber will pull and ack messages using API methods. At most one of these fields may be set.

Publisher

Contains details of the listing publisher.

PushConfig

Configuration for a push delivery endpoint.

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

RefreshSubscriptionRequest

Message for refreshing a subscription.

RefreshSubscriptionResponse

Message for response when you refresh a subscription.

RetryPolicy

A policy that specifies how Pub/Sub retries message delivery.

Retry delay will be exponential based on provided minimum and maximum backoffs. https://en.wikipedia.org/wiki/Exponential_backoff.

RetryPolicy will be triggered on NACKs or acknowledgement deadline exceeded events for a given message.

Retry Policy is implemented on a best effort basis. At times, the delay between consecutive deliveries may not match the configuration. That is, delay can be more or less than configured backoff.

RevokeSubscriptionRequest

Message for revoking a subscription.

RevokeSubscriptionResponse

Message for response when you revoke a subscription. Empty for now.

SharedResourceType

The underlying shared asset type shared in a listing by a publisher.

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

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.

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

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

UpdateDataExchangeRequest

Message for updating a data exchange.

UpdateListingRequest

Message for updating a Listing.