package google.cloud.bigquery.analyticshub.v1

Mouse Melon logoGet desktop application:
View/edit binary Protocol Buffers messages

service AnalyticsHubService

analyticshub.proto:70

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.

message BigQueryConfig

pubsub.proto:325

Configuration for a BigQuery subscription.

Used in: PubSubSubscription

message CloudStorageConfig

pubsub.proto:364

Configuration for a Cloud Storage subscription.

Used in: PubSubSubscription

message CloudStorageConfig.AvroConfig

pubsub.proto:372

Configuration for writing message data in Avro format. Message payloads and metadata will be written to files as an Avro binary.

Used in: CloudStorageConfig

message CloudStorageConfig.TextConfig

pubsub.proto:368

Configuration for writing message data in text format. Message payloads will be written to files as raw text, separated by a newline.

Used in: CloudStorageConfig

(message has no fields)

message DataExchange

analyticshub.proto:349

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.

Used as response type in: AnalyticsHubService.CreateDataExchange, AnalyticsHubService.GetDataExchange, AnalyticsHubService.UpdateDataExchange

Used as field type in: CreateDataExchangeRequest, ListDataExchangesResponse, ListOrgDataExchangesResponse, UpdateDataExchangeRequest

message DataProvider

analyticshub.proto:442

Contains details of the data provider.

Used in: Listing

message DeadLetterPolicy

pubsub.proto:196

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.

Used in: PubSubSubscription

message DestinationDataset

analyticshub.proto:472

Defines the destination bigquery dataset.

Used in: SubscribeDataExchangeRequest, SubscribeListingRequest

message DestinationDatasetReference

analyticshub.proto:461

Used in: DestinationDataset

message DestinationPubSubSubscription

analyticshub.proto:499

Defines the destination Pub/Sub subscription.

Used in: SubscribeListingRequest

enum DiscoveryType

analyticshub.proto:321

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.

Used in: DataExchange, Listing

message ExpirationPolicy

pubsub.proto:226

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

Used in: PubSubSubscription

message JavaScriptUDF

pubsub.proto:466

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

Used in: MessageTransform

message Listing

analyticshub.proto:509

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.

Used as response type in: AnalyticsHubService.CreateListing, AnalyticsHubService.GetListing, AnalyticsHubService.UpdateListing

Used as field type in: CreateListingRequest, ListListingsResponse, UpdateListingRequest

message Listing.BigQueryDatasetSource

analyticshub.proto:522

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.

Used in: Listing

message Listing.BigQueryDatasetSource.RestrictedExportPolicy

analyticshub.proto:541

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

Used in: BigQueryDatasetSource

message Listing.BigQueryDatasetSource.SelectedResource

analyticshub.proto:524

Resource in this dataset that is selectively shared.

Used in: BigQueryDatasetSource

enum Listing.Category

analyticshub.proto:620

Listing categories.

Used in: Listing

message Listing.PubSubTopicSource

analyticshub.proto:578

Pub/Sub topic source.

Used in: Listing

message Listing.RestrictedExportConfig

analyticshub.proto:595

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

Used in: Listing

enum Listing.State

analyticshub.proto:610

State of the listing.

Used in: Listing

message MessageTransform

pubsub.proto:447

All supported message transforms types.

Used in: PubSubSubscription

message OperationMetadata

analyticshub.proto:1240

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

message PubSubSubscription

pubsub.proto:36

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.

Used in: DestinationPubSubSubscription

message Publisher

analyticshub.proto:452

Contains details of the listing publisher.

Used in: Listing

message PushConfig

pubsub.proto:237

Configuration for a push delivery endpoint.

Used in: PubSubSubscription

message PushConfig.NoWrapper

pubsub.proto:265

Sets the `data` field as the HTTP body for delivery.

Used in: PushConfig

message PushConfig.OidcToken

pubsub.proto:241

Contains information needed for generating an [OpenID Connect token](https://developers.google.com/identity/protocols/OpenIDConnect).

Used in: PushConfig

message PushConfig.PubsubWrapper

pubsub.proto:262

The payload to the push endpoint is in the form of the JSON representation of a PubsubMessage (https://cloud.google.com/pubsub/docs/reference/rpc/google.pubsub.v1#pubsubmessage).

Used in: PushConfig

(message has no fields)

message RefreshSubscriptionResponse

analyticshub.proto:1119

Message for response when you refresh a subscription.

message RetryPolicy

pubsub.proto:178

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.

Used in: PubSubSubscription

enum SharedResourceType

analyticshub.proto:335

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

Used in: Listing, Subscription

message SharingEnvironmentConfig

analyticshub.proto:408

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

Used in: DataExchange

message SharingEnvironmentConfig.DcrExchangeConfig

analyticshub.proto:413

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

Used in: SharingEnvironmentConfig

message SharingEnvironmentConfig.DefaultExchangeConfig

analyticshub.proto:410

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

Used in: SharingEnvironmentConfig

(message has no fields)

message SubscribeDataExchangeResponse

analyticshub.proto:1101

Message for response when you subscribe to a Data Exchange.

message Subscription

analyticshub.proto:741

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

Used as response type in: AnalyticsHubService.GetSubscription

Used as field type in: ListSharedResourceSubscriptionsResponse, ListSubscriptionsResponse, RefreshSubscriptionResponse, SubscribeDataExchangeResponse, SubscribeListingResponse

message Subscription.LinkedResource

analyticshub.proto:748

Reference to a linked resource tracked by this Subscription.

Used in: Subscription

enum Subscription.State

analyticshub.proto:765

State of the subscription.

Used in: Subscription