Analytics Hub v1 API - Namespace Google.Cloud.BigQuery.AnalyticsHub.V1 (1.9.0)

Classes

AnalyticsHubService

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.

AnalyticsHubService.AnalyticsHubServiceBase

Base class for server-side implementations of AnalyticsHubService

AnalyticsHubService.AnalyticsHubServiceClient

Client for AnalyticsHubService

AnalyticsHubServiceClient

AnalyticsHubService client wrapper, for convenient use.

AnalyticsHubServiceClientBuilder

Builder class for AnalyticsHubServiceClient to provide simple configuration of credentials, endpoint etc.

AnalyticsHubServiceClientImpl

AnalyticsHubService client wrapper implementation, for convenient use.

AnalyticsHubServiceSettings

Settings for AnalyticsHubServiceClient instances.

BigQueryConfig

Configuration for a BigQuery subscription.

CloudStorageConfig

Configuration for a Cloud Storage subscription.

CloudStorageConfig.Types

Container for nested types declared in the CloudStorageConfig message type.

CloudStorageConfig.Types.AvroConfig

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

CloudStorageConfig.Types.TextConfig

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

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.

DataExchangeName

Resource name for the DataExchange resource.

DataProvider

Contains details of the data provider.

DatasetName

Resource name for the Dataset resource.

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.

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.

Listing.Types

Container for nested types declared in the Listing message type.

Listing.Types.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.

Listing.Types.BigQueryDatasetSource.Types

Container for nested types declared in the BigQueryDatasetSource message type.

Listing.Types.BigQueryDatasetSource.Types.RestrictedExportPolicy

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

Listing.Types.BigQueryDatasetSource.Types.SelectedResource

Resource in this dataset that is selectively shared.

Listing.Types.CommercialInfo

Commercial info contains the information about the commercial data products associated with the listing.

Listing.Types.CommercialInfo.Types

Container for nested types declared in the CommercialInfo message type.

Listing.Types.CommercialInfo.Types.GoogleCloudMarketplaceInfo

Specifies the details of the Marketplace Data Product associated with the Listing.

Listing.Types.CommercialInfo.Types.GoogleCloudMarketplaceInfo.Types

Container for nested types declared in the GoogleCloudMarketplaceInfo message type.

Listing.Types.PubSubTopicSource

Pub/Sub topic source.

Listing.Types.RestrictedExportConfig

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

ListingName

Resource name for the Listing resource.

ManagedServiceName

Resource name for the ManagedService resource.

MessageTransform

All supported message transforms types.

OperationMetadata

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

OrderName

Resource name for the Order resource.

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.

PushConfig.Types

Container for nested types declared in the PushConfig message type.

PushConfig.Types.NoWrapper

Sets the data field as the HTTP body for delivery.

PushConfig.Types.OidcToken

Contains information needed for generating an OpenID Connect token.

PushConfig.Types.PubsubWrapper

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).

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.

RoutineName

Resource name for the Routine resource.

SharingEnvironmentConfig

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

SharingEnvironmentConfig.Types

Container for nested types declared in the SharingEnvironmentConfig message type.

SharingEnvironmentConfig.Types.DcrExchangeConfig

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

SharingEnvironmentConfig.Types.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.

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.

Subscription.Types

Container for nested types declared in the Subscription message type.

Subscription.Types.CommercialInfo

Commercial info metadata for this subscription.

Subscription.Types.CommercialInfo.Types

Container for nested types declared in the CommercialInfo message type.

Subscription.Types.CommercialInfo.Types.GoogleCloudMarketplaceInfo

Cloud Marketplace commercial metadata for this subscription.

Subscription.Types.LinkedResource

Reference to a linked resource tracked by this Subscription.

SubscriptionName

Resource name for the Subscription resource.

TableName

Resource name for the Table resource.

TopicName

Resource name for the Topic resource.

UpdateDataExchangeRequest

Message for updating a data exchange.

UpdateListingRequest

Message for updating a Listing.

Enums

CloudStorageConfig.OutputFormatOneofCase

Enum of possible cases for the "output_format" oneof.

DataExchangeName.ResourceNameType

The possible contents of DataExchangeName.

DatasetName.ResourceNameType

The possible contents of DatasetName.

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.

Listing.SourceOneofCase

Enum of possible cases for the "source" oneof.

Listing.Types.BigQueryDatasetSource.Types.SelectedResource.ResourceOneofCase

Enum of possible cases for the "resource" oneof.

Listing.Types.Category

Listing categories.

Listing.Types.CommercialInfo.Types.GoogleCloudMarketplaceInfo.Types.CommercialState

Indicates whether this commercial access is currently active.

Listing.Types.State

State of the listing.

ListingName.ResourceNameType

The possible contents of ListingName.

ManagedServiceName.ResourceNameType

The possible contents of ManagedServiceName.

MessageTransform.TransformOneofCase

Enum of possible cases for the "transform" oneof.

OrderName.ResourceNameType

The possible contents of OrderName.

PushConfig.AuthenticationMethodOneofCase

Enum of possible cases for the "authentication_method" oneof.

PushConfig.WrapperOneofCase

Enum of possible cases for the "wrapper" oneof.

RoutineName.ResourceNameType

The possible contents of RoutineName.

SharedResourceType

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

SharingEnvironmentConfig.EnvironmentOneofCase

Enum of possible cases for the "environment" oneof.

SubscribeListingRequest.DestinationOneofCase

Enum of possible cases for the "destination" oneof.

Subscription.ResourceNameOneofCase

Enum of possible cases for the "resource_name" oneof.

Subscription.Types.LinkedResource.ReferenceOneofCase

Enum of possible cases for the "reference" oneof.

Subscription.Types.State

State of the subscription.

SubscriptionName.ResourceNameType

The possible contents of SubscriptionName.

TableName.ResourceNameType

The possible contents of TableName.

TopicName.ResourceNameType

The possible contents of TopicName.