Package com.google.cloud.bigquery.dataexchange.v1beta1 (0.1.0)

Service Description: The AnalyticsHubService API facilitates data sharing within and across organizations. It allows data providers to publish Listings --- a discoverable and searchable SKU representing a dataset. Data consumers can subscribe to Listings. Upon subscription, AnalyticsHub provisions a "Linked Datasets" surfacing the data in the consumer's project.

This class provides the ability to make remote calls to the backing service through method calls that map to API methods. Sample code to get started:

 // This snippet has been automatically generated for illustrative purposes only.
 // It may require modifications to work in your environment.
 try (AnalyticsHubServiceClient analyticsHubServiceClient = AnalyticsHubServiceClient.create()) {
   DataExchangeName name = DataExchangeName.of("[PROJECT]", "[LOCATION]", "[DATA_EXCHANGE]");
   DataExchange response = analyticsHubServiceClient.getDataExchange(name);
 }
 

Note: close() needs to be called on the AnalyticsHubServiceClient object to clean up resources such as threads. In the example above, try-with-resources is used, which automatically calls close().

The surface of this class includes several types of Java methods for each of the API's methods:

1. A "flattened" method. With this type of method, the fields of the request type have been converted into function parameters. It may be the case that not all fields are available as parameters, and not every API method will have a flattened method entry point.
2. A "request object" method. This type of method only takes one parameter, a request object, which must be constructed before the call. Not every API method will have a request object method.
3. A "callable" method. This type of method takes no parameters and returns an immutable API callable object, which can be used to initiate calls to the service.

See the individual methods for example code.

Many parameters require resource names to be formatted in a particular way. To assist with these names, this class includes a format method for each type of name, and additionally a parse method to extract the individual identifiers contained within names that are returned.

This class can be customized by passing in a custom instance of AnalyticsHubServiceSettings to create(). For example:

To customize credentials:

 // This snippet has been automatically generated for illustrative purposes only.
 // It may require modifications to work in your environment.
 AnalyticsHubServiceSettings analyticsHubServiceSettings =
     AnalyticsHubServiceSettings.newBuilder()
         .setCredentialsProvider(FixedCredentialsProvider.create(myCredentials))
         .build();
 AnalyticsHubServiceClient analyticsHubServiceClient =
     AnalyticsHubServiceClient.create(analyticsHubServiceSettings);
 

To customize the endpoint:

 // This snippet has been automatically generated for illustrative purposes only.
 // It may require modifications to work in your environment.
 AnalyticsHubServiceSettings analyticsHubServiceSettings =
     AnalyticsHubServiceSettings.newBuilder().setEndpoint(myEndpoint).build();
 AnalyticsHubServiceClient analyticsHubServiceClient =
     AnalyticsHubServiceClient.create(analyticsHubServiceSettings);
 

Please refer to the GitHub repository's samples for more quickstart code snippets.

The AnalyticsHubService API facilitates data sharing within and across organizations. It allows data providers to publish Listings --- a discoverable and searchable SKU representing a dataset. Data consumers can subscribe to Listings. Upon subscription, AnalyticsHub provisions a "Linked Datasets" surfacing the data in the consumer's project.

The AnalyticsHubService API facilitates data sharing within and across organizations. It allows data providers to publish Listings --- a discoverable and searchable SKU representing a dataset. Data consumers can subscribe to Listings. Upon subscription, AnalyticsHub provisions a "Linked Datasets" surfacing the data in the consumer's project.

The AnalyticsHubService API facilitates data sharing within and across organizations. It allows data providers to publish Listings --- a discoverable and searchable SKU representing a dataset. Data consumers can subscribe to Listings. Upon subscription, AnalyticsHub provisions a "Linked Datasets" surfacing the data in the consumer's project.

The AnalyticsHubService API facilitates data sharing within and across organizations. It allows data providers to publish Listings --- a discoverable and searchable SKU representing a dataset. Data consumers can subscribe to Listings. Upon subscription, AnalyticsHub provisions a "Linked Datasets" surfacing the data in the consumer's project.

The AnalyticsHubService API facilitates data sharing within and across organizations. It allows data providers to publish Listings --- a discoverable and searchable SKU representing a dataset. Data consumers can subscribe to Listings. Upon subscription, AnalyticsHub provisions a "Linked Datasets" surfacing the data in the consumer's project.

Settings class to configure an instance of AnalyticsHubServiceClient.

The default instance has everything set to sensible defaults:

• The default service address (analyticshub.googleapis.com) and default port (443) are used.
• Credentials are acquired automatically through Application Default Credentials.
• Retries are configured for idempotent methods but not for non-idempotent methods.

The builder of this class is recursive, so contained classes are themselves builders. When build() is called, the tree of builders is called to create the complete settings object.

For example, to set the total timeout of getDataExchange to 30 seconds:

 // This snippet has been automatically generated for illustrative purposes only.
 // It may require modifications to work in your environment.
 AnalyticsHubServiceSettings.Builder analyticsHubServiceSettingsBuilder =
     AnalyticsHubServiceSettings.newBuilder();
 analyticsHubServiceSettingsBuilder
     .getDataExchangeSettings()
     .setRetrySettings(
         analyticsHubServiceSettingsBuilder
             .getDataExchangeSettings()
             .getRetrySettings()
             .toBuilder()
             .setTotalTimeout(Duration.ofSeconds(30))
             .build());
 AnalyticsHubServiceSettings analyticsHubServiceSettings =
     analyticsHubServiceSettingsBuilder.build();
 

Builder for AnalyticsHubServiceSettings.

Message for creating a DataExchange.

Protobuf type google.cloud.bigquery.dataexchange.v1beta1.CreateDataExchangeRequest

Message for creating a DataExchange.

Protobuf type google.cloud.bigquery.dataexchange.v1beta1.CreateDataExchangeRequest

Message for creating a Listing.

Protobuf type google.cloud.bigquery.dataexchange.v1beta1.CreateListingRequest

Message for creating a Listing.

Protobuf type google.cloud.bigquery.dataexchange.v1beta1.CreateListingRequest

A data exchange is a container that enables data sharing. It contains a set of listings of the data sources along with descriptive information of the data exchange.

Protobuf type google.cloud.bigquery.dataexchange.v1beta1.DataExchange

A data exchange is a container that enables data sharing. It contains a set of listings of the data sources along with descriptive information of the data exchange.

Protobuf type google.cloud.bigquery.dataexchange.v1beta1.DataExchange

Builder for projects/{project}/locations/{location}/dataExchanges/{data_exchange}.

Contains details of the Data Provider.

Protobuf type google.cloud.bigquery.dataexchange.v1beta1.DataProvider

Contains details of the Data Provider.

Protobuf type google.cloud.bigquery.dataexchange.v1beta1.DataProvider

Message for deleting a DataExchange.

Protobuf type google.cloud.bigquery.dataexchange.v1beta1.DeleteDataExchangeRequest

Message for deleting a DataExchange.

Protobuf type google.cloud.bigquery.dataexchange.v1beta1.DeleteDataExchangeRequest

Message for deleting a Listing.

Protobuf type google.cloud.bigquery.dataexchange.v1beta1.DeleteListingRequest

Message for deleting a Listing.

Protobuf type google.cloud.bigquery.dataexchange.v1beta1.DeleteListingRequest

Defines the Destination BigQuery Dataset.

Protobuf type google.cloud.bigquery.dataexchange.v1beta1.DestinationDataset

Defines the Destination BigQuery Dataset.

Protobuf type google.cloud.bigquery.dataexchange.v1beta1.DestinationDataset

Defines the Destination BigQuery Dataset Reference.

Protobuf type google.cloud.bigquery.dataexchange.v1beta1.DestinationDatasetReference

Defines the Destination BigQuery Dataset Reference.

Protobuf type google.cloud.bigquery.dataexchange.v1beta1.DestinationDatasetReference

Message for getting a DataExchange.

Protobuf type google.cloud.bigquery.dataexchange.v1beta1.GetDataExchangeRequest

Message for getting a DataExchange.

Protobuf type google.cloud.bigquery.dataexchange.v1beta1.GetDataExchangeRequest

Message for getting a Listing.

Protobuf type google.cloud.bigquery.dataexchange.v1beta1.GetListingRequest

Message for getting a Listing.

Protobuf type google.cloud.bigquery.dataexchange.v1beta1.GetListingRequest

Message for requesting list of DataExchanges.

Protobuf type google.cloud.bigquery.dataexchange.v1beta1.ListDataExchangesRequest

Message for requesting list of DataExchanges.

Protobuf type google.cloud.bigquery.dataexchange.v1beta1.ListDataExchangesRequest

Message for response to listing DataExchanges.

Protobuf type google.cloud.bigquery.dataexchange.v1beta1.ListDataExchangesResponse

Message for response to listing DataExchanges.

Protobuf type google.cloud.bigquery.dataexchange.v1beta1.ListDataExchangesResponse

Message for requesting list of Listings.

Protobuf type google.cloud.bigquery.dataexchange.v1beta1.ListListingsRequest

Message for requesting list of Listings.

Protobuf type google.cloud.bigquery.dataexchange.v1beta1.ListListingsRequest

Message for response to listing Listings.

Protobuf type google.cloud.bigquery.dataexchange.v1beta1.ListListingsResponse

Message for response to listing Listings.

Protobuf type google.cloud.bigquery.dataexchange.v1beta1.ListListingsResponse

Message for requesting list of DataExchanges from projects in an organization and location.

Protobuf type google.cloud.bigquery.dataexchange.v1beta1.ListOrgDataExchangesRequest

Message for requesting list of DataExchanges from projects in an organization and location.

Protobuf type google.cloud.bigquery.dataexchange.v1beta1.ListOrgDataExchangesRequest

Message for response to listing DataExchanges in an organization and location.

Protobuf type google.cloud.bigquery.dataexchange.v1beta1.ListOrgDataExchangesResponse

Message for response to listing DataExchanges in an organization and location.

Protobuf type google.cloud.bigquery.dataexchange.v1beta1.ListOrgDataExchangesResponse

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.

Protobuf type google.cloud.bigquery.dataexchange.v1beta1.Listing

A reference to a Shared dataset. It's an existing BigQuery dataset with a collection of objects, such as tables and views, that you want to share with subscribers. Upon subscription to a Listing, Data Exchange 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.

Protobuf type google.cloud.bigquery.dataexchange.v1beta1.Listing.BigQueryDatasetSource

A reference to a Shared dataset. It's an existing BigQuery dataset with a collection of objects, such as tables and views, that you want to share with subscribers. Upon subscription to a Listing, Data Exchange 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.

Protobuf type google.cloud.bigquery.dataexchange.v1beta1.Listing.BigQueryDatasetSource

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.

Protobuf type google.cloud.bigquery.dataexchange.v1beta1.Listing

Builder for projects/{project}/locations/{location}/dataExchanges/{data_exchange}/listings/{listing}.

Builder for projects/{project}/locations/{location}.

Contains details of the Publisher.

Protobuf type google.cloud.bigquery.dataexchange.v1beta1.Publisher

Contains details of the Publisher.

Protobuf type google.cloud.bigquery.dataexchange.v1beta1.Publisher

Message for subscribing a Listing.

Protobuf type google.cloud.bigquery.dataexchange.v1beta1.SubscribeListingRequest

Message for subscribing a Listing.

Protobuf type google.cloud.bigquery.dataexchange.v1beta1.SubscribeListingRequest

Message for response to subscribing a Listing. Empty for now.

Protobuf type google.cloud.bigquery.dataexchange.v1beta1.SubscribeListingResponse

Message for response to subscribing a Listing. Empty for now.

Protobuf type google.cloud.bigquery.dataexchange.v1beta1.SubscribeListingResponse

Message for updating a DataExchange.

Protobuf type google.cloud.bigquery.dataexchange.v1beta1.UpdateDataExchangeRequest

Message for updating a DataExchange.

Protobuf type google.cloud.bigquery.dataexchange.v1beta1.UpdateDataExchangeRequest

Message for updating a Listing.

Protobuf type google.cloud.bigquery.dataexchange.v1beta1.UpdateListingRequest

Message for updating a Listing.

Protobuf type google.cloud.bigquery.dataexchange.v1beta1.UpdateListingRequest

State of the Listing

Protobuf enum google.cloud.bigquery.dataexchange.v1beta1.Listing.State