- 0.48.0 (latest)
- 0.46.0
- 0.45.0
- 0.44.0
- 0.43.0
- 0.42.0
- 0.41.0
- 0.40.0
- 0.39.0
- 0.38.0
- 0.37.0
- 0.36.0
- 0.34.0
- 0.33.0
- 0.32.0
- 0.31.0
- 0.30.0
- 0.29.0
- 0.28.0
- 0.27.0
- 0.26.0
- 0.25.0
- 0.24.0
- 0.21.0
- 0.20.0
- 0.19.0
- 0.18.0
- 0.17.0
- 0.16.0
- 0.15.0
- 0.14.0
- 0.13.0
- 0.12.0
- 0.11.0
- 0.10.0
- 0.9.0
- 0.8.0
- 0.7.0
- 0.6.0
- 0.5.0
- 0.4.0
- 0.3.0
- 0.2.0
- 0.1.0
A client to Analytics Hub API
The interfaces provided are listed below, along with usage samples.
AnalyticsHubServiceClient
Service Description: 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.
Sample for AnalyticsHubServiceClient:
// This snippet has been automatically generated and should be regarded as a code template only.
// It will require modifications to work:
// - It may require correct/in-range values for request initialization.
// - It may require specifying regional endpoints when creating the service client as shown in
// https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
try (AnalyticsHubServiceClient analyticsHubServiceClient = AnalyticsHubServiceClient.create()) {
DataExchangeName name = DataExchangeName.of("[PROJECT]", "[LOCATION]", "[DATA_EXCHANGE]");
DataExchange response = analyticsHubServiceClient.getDataExchange(name);
}
Classes
AnalyticsHubProto
AnalyticsHubServiceClient
Service Description: 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.
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 and should be regarded as a code template only.
// It will require modifications to work:
// - It may require correct/in-range values for request initialization.
// - It may require specifying regional endpoints when creating the service client as shown in
// https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
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:
- 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.
- 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.
- 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 and should be regarded as a code template only.
// It will require modifications to work:
// - It may require correct/in-range values for request initialization.
// - It may require specifying regional endpoints when creating the service client as shown in
// https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
AnalyticsHubServiceSettings analyticsHubServiceSettings =
AnalyticsHubServiceSettings.newBuilder()
.setCredentialsProvider(FixedCredentialsProvider.create(myCredentials))
.build();
AnalyticsHubServiceClient analyticsHubServiceClient =
AnalyticsHubServiceClient.create(analyticsHubServiceSettings);
To customize the endpoint:
// This snippet has been automatically generated and should be regarded as a code template only.
// It will require modifications to work:
// - It may require correct/in-range values for request initialization.
// - It may require specifying regional endpoints when creating the service client as shown in
// https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
AnalyticsHubServiceSettings analyticsHubServiceSettings =
AnalyticsHubServiceSettings.newBuilder().setEndpoint(myEndpoint).build();
AnalyticsHubServiceClient analyticsHubServiceClient =
AnalyticsHubServiceClient.create(analyticsHubServiceSettings);
To use REST (HTTP1.1/JSON) transport (instead of gRPC) for sending and receiving requests over the wire:
// This snippet has been automatically generated and should be regarded as a code template only.
// It will require modifications to work:
// - It may require correct/in-range values for request initialization.
// - It may require specifying regional endpoints when creating the service client as shown in
// https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
AnalyticsHubServiceSettings analyticsHubServiceSettings =
AnalyticsHubServiceSettings.newBuilder()
.setTransportChannelProvider(
AnalyticsHubServiceSettings.defaultHttpJsonTransportProviderBuilder().build())
.build();
AnalyticsHubServiceClient analyticsHubServiceClient =
AnalyticsHubServiceClient.create(analyticsHubServiceSettings);
Please refer to the GitHub repository's samples for more quickstart code snippets.
AnalyticsHubServiceClient.ListDataExchangesFixedSizeCollection
AnalyticsHubServiceClient.ListDataExchangesPage
AnalyticsHubServiceClient.ListDataExchangesPagedResponse
AnalyticsHubServiceClient.ListListingsFixedSizeCollection
AnalyticsHubServiceClient.ListListingsPage
AnalyticsHubServiceClient.ListListingsPagedResponse
AnalyticsHubServiceClient.ListOrgDataExchangesFixedSizeCollection
AnalyticsHubServiceClient.ListOrgDataExchangesPage
AnalyticsHubServiceClient.ListOrgDataExchangesPagedResponse
AnalyticsHubServiceGrpc
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.
AnalyticsHubServiceGrpc.AnalyticsHubServiceBlockingStub
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.
AnalyticsHubServiceGrpc.AnalyticsHubServiceFutureStub
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.
AnalyticsHubServiceGrpc.AnalyticsHubServiceImplBase
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.
AnalyticsHubServiceGrpc.AnalyticsHubServiceStub
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.
AnalyticsHubServiceSettings
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 and should be regarded as a code template only.
// It will require modifications to work:
// - It may require correct/in-range values for request initialization.
// - It may require specifying regional endpoints when creating the service client as shown in
// https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
AnalyticsHubServiceSettings.Builder analyticsHubServiceSettingsBuilder =
AnalyticsHubServiceSettings.newBuilder();
analyticsHubServiceSettingsBuilder
.getDataExchangeSettings()
.setRetrySettings(
analyticsHubServiceSettingsBuilder
.getDataExchangeSettings()
.getRetrySettings()
.toBuilder()
.setTotalTimeout(Duration.ofSeconds(30))
.build());
AnalyticsHubServiceSettings analyticsHubServiceSettings =
analyticsHubServiceSettingsBuilder.build();
AnalyticsHubServiceSettings.Builder
Builder for AnalyticsHubServiceSettings.
CreateDataExchangeRequest
Message for creating a data exchange.
Protobuf type google.cloud.bigquery.analyticshub.v1.CreateDataExchangeRequest
CreateDataExchangeRequest.Builder
Message for creating a data exchange.
Protobuf type google.cloud.bigquery.analyticshub.v1.CreateDataExchangeRequest
CreateListingRequest
Message for creating a listing.
Protobuf type google.cloud.bigquery.analyticshub.v1.CreateListingRequest
CreateListingRequest.Builder
Message for creating a listing.
Protobuf type google.cloud.bigquery.analyticshub.v1.CreateListingRequest
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.
Protobuf type google.cloud.bigquery.analyticshub.v1.DataExchange
DataExchange.Builder
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.
Protobuf type google.cloud.bigquery.analyticshub.v1.DataExchange
DataExchangeName
DataExchangeName.Builder
Builder for projects/{project}/locations/{location}/dataExchanges/{data_exchange}.
DataProvider
Contains details of the data provider.
Protobuf type google.cloud.bigquery.analyticshub.v1.DataProvider
DataProvider.Builder
Contains details of the data provider.
Protobuf type google.cloud.bigquery.analyticshub.v1.DataProvider
DeleteDataExchangeRequest
Message for deleting a data exchange.
Protobuf type google.cloud.bigquery.analyticshub.v1.DeleteDataExchangeRequest
DeleteDataExchangeRequest.Builder
Message for deleting a data exchange.
Protobuf type google.cloud.bigquery.analyticshub.v1.DeleteDataExchangeRequest
DeleteListingRequest
Message for deleting a listing.
Protobuf type google.cloud.bigquery.analyticshub.v1.DeleteListingRequest
DeleteListingRequest.Builder
Message for deleting a listing.
Protobuf type google.cloud.bigquery.analyticshub.v1.DeleteListingRequest
DestinationDataset
Defines the destination bigquery dataset.
Protobuf type google.cloud.bigquery.analyticshub.v1.DestinationDataset
DestinationDataset.Builder
Defines the destination bigquery dataset.
Protobuf type google.cloud.bigquery.analyticshub.v1.DestinationDataset
DestinationDatasetReference
Contains the reference that identifies a destination bigquery dataset.
Protobuf type google.cloud.bigquery.analyticshub.v1.DestinationDatasetReference
DestinationDatasetReference.Builder
Contains the reference that identifies a destination bigquery dataset.
Protobuf type google.cloud.bigquery.analyticshub.v1.DestinationDatasetReference
GetDataExchangeRequest
Message for getting a data exchange.
Protobuf type google.cloud.bigquery.analyticshub.v1.GetDataExchangeRequest
GetDataExchangeRequest.Builder
Message for getting a data exchange.
Protobuf type google.cloud.bigquery.analyticshub.v1.GetDataExchangeRequest
GetListingRequest
Message for getting a listing.
Protobuf type google.cloud.bigquery.analyticshub.v1.GetListingRequest
GetListingRequest.Builder
Message for getting a listing.
Protobuf type google.cloud.bigquery.analyticshub.v1.GetListingRequest
ListDataExchangesRequest
Message for requesting the list of data exchanges.
Protobuf type google.cloud.bigquery.analyticshub.v1.ListDataExchangesRequest
ListDataExchangesRequest.Builder
Message for requesting the list of data exchanges.
Protobuf type google.cloud.bigquery.analyticshub.v1.ListDataExchangesRequest
ListDataExchangesResponse
Message for response to the list of data exchanges.
Protobuf type google.cloud.bigquery.analyticshub.v1.ListDataExchangesResponse
ListDataExchangesResponse.Builder
Message for response to the list of data exchanges.
Protobuf type google.cloud.bigquery.analyticshub.v1.ListDataExchangesResponse
ListListingsRequest
Message for requesting the list of listings.
Protobuf type google.cloud.bigquery.analyticshub.v1.ListListingsRequest
ListListingsRequest.Builder
Message for requesting the list of listings.
Protobuf type google.cloud.bigquery.analyticshub.v1.ListListingsRequest
ListListingsResponse
Message for response to the list of Listings.
Protobuf type google.cloud.bigquery.analyticshub.v1.ListListingsResponse
ListListingsResponse.Builder
Message for response to the list of Listings.
Protobuf type google.cloud.bigquery.analyticshub.v1.ListListingsResponse
ListOrgDataExchangesRequest
Message for requesting the list of data exchanges from projects in an organization and location.
Protobuf type google.cloud.bigquery.analyticshub.v1.ListOrgDataExchangesRequest
ListOrgDataExchangesRequest.Builder
Message for requesting the list of data exchanges from projects in an organization and location.
Protobuf type google.cloud.bigquery.analyticshub.v1.ListOrgDataExchangesRequest
ListOrgDataExchangesResponse
Message for response to listing data exchanges in an organization and location.
Protobuf type google.cloud.bigquery.analyticshub.v1.ListOrgDataExchangesResponse
ListOrgDataExchangesResponse.Builder
Message for response to listing data exchanges in an organization and location.
Protobuf type google.cloud.bigquery.analyticshub.v1.ListOrgDataExchangesResponse
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.
Protobuf type google.cloud.bigquery.analyticshub.v1.Listing
Listing.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.
Protobuf type google.cloud.bigquery.analyticshub.v1.Listing.BigQueryDatasetSource
Listing.BigQueryDatasetSource.Builder
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.
Protobuf type google.cloud.bigquery.analyticshub.v1.Listing.BigQueryDatasetSource
Listing.Builder
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.analyticshub.v1.Listing
ListingName
ListingName.Builder
Builder for projects/{project}/locations/{location}/dataExchanges/{data_exchange}/listings/{listing}.
LocationName
LocationName.Builder
Builder for projects/{project}/locations/{location}.
Publisher
Contains details of the listing publisher.
Protobuf type google.cloud.bigquery.analyticshub.v1.Publisher
Publisher.Builder
Contains details of the listing publisher.
Protobuf type google.cloud.bigquery.analyticshub.v1.Publisher
SubscribeListingRequest
Message for subscribing to a listing.
Protobuf type google.cloud.bigquery.analyticshub.v1.SubscribeListingRequest
SubscribeListingRequest.Builder
Message for subscribing to a listing.
Protobuf type google.cloud.bigquery.analyticshub.v1.SubscribeListingRequest
SubscribeListingResponse
Message for response when you subscribe to a listing.
Protobuf type google.cloud.bigquery.analyticshub.v1.SubscribeListingResponse
SubscribeListingResponse.Builder
Message for response when you subscribe to a listing.
Protobuf type google.cloud.bigquery.analyticshub.v1.SubscribeListingResponse
UpdateDataExchangeRequest
Message for updating a data exchange.
Protobuf type google.cloud.bigquery.analyticshub.v1.UpdateDataExchangeRequest
UpdateDataExchangeRequest.Builder
Message for updating a data exchange.
Protobuf type google.cloud.bigquery.analyticshub.v1.UpdateDataExchangeRequest
UpdateListingRequest
Message for updating a Listing.
Protobuf type google.cloud.bigquery.analyticshub.v1.UpdateListingRequest
UpdateListingRequest.Builder
Message for updating a Listing.
Protobuf type google.cloud.bigquery.analyticshub.v1.UpdateListingRequest
Interfaces
CreateDataExchangeRequestOrBuilder
CreateListingRequestOrBuilder
DataExchangeOrBuilder
DataProviderOrBuilder
DeleteDataExchangeRequestOrBuilder
DeleteListingRequestOrBuilder
DestinationDatasetOrBuilder
DestinationDatasetReferenceOrBuilder
GetDataExchangeRequestOrBuilder
GetListingRequestOrBuilder
ListDataExchangesRequestOrBuilder
ListDataExchangesResponseOrBuilder
ListListingsRequestOrBuilder
ListListingsResponseOrBuilder
ListOrgDataExchangesRequestOrBuilder
ListOrgDataExchangesResponseOrBuilder
Listing.BigQueryDatasetSourceOrBuilder
ListingOrBuilder
PublisherOrBuilder
SubscribeListingRequestOrBuilder
SubscribeListingResponseOrBuilder
UpdateDataExchangeRequestOrBuilder
UpdateListingRequestOrBuilder
Enums
Listing.Category
Listing categories.
Protobuf enum google.cloud.bigquery.analyticshub.v1.Listing.Category
Listing.SourceCase
Listing.State
State of the listing.
Protobuf enum google.cloud.bigquery.analyticshub.v1.Listing.State