Class AnalyticsHubServiceClient (0.38.0)

GitHub RepositoryProduct Reference

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

Methods
Method Description Method Variants

ListDataExchanges

Lists all data exchanges in a given project and location.

Request object method variants only take one parameter, a request object, which must be constructed before the call.

  • listDataExchanges(ListDataExchangesRequest request)

"Flattened" method variants have converted the fields of the request object into function parameters to enable multiple ways to call the same method.

  • listDataExchanges(LocationName parent)

  • listDataExchanges(String parent)

Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service.

  • listDataExchangesPagedCallable()

  • listDataExchangesCallable()

ListOrgDataExchanges

Lists all data exchanges from projects in a given organization and location.

Request object method variants only take one parameter, a request object, which must be constructed before the call.

  • listOrgDataExchanges(ListOrgDataExchangesRequest request)

"Flattened" method variants have converted the fields of the request object into function parameters to enable multiple ways to call the same method.

  • listOrgDataExchanges(String organization)

Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service.

  • listOrgDataExchangesPagedCallable()

  • listOrgDataExchangesCallable()

GetDataExchange

Gets the details of a data exchange.

Request object method variants only take one parameter, a request object, which must be constructed before the call.

  • getDataExchange(GetDataExchangeRequest request)

"Flattened" method variants have converted the fields of the request object into function parameters to enable multiple ways to call the same method.

  • getDataExchange(DataExchangeName name)

  • getDataExchange(String name)

Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service.

  • getDataExchangeCallable()

CreateDataExchange

Creates a new data exchange.

Request object method variants only take one parameter, a request object, which must be constructed before the call.

  • createDataExchange(CreateDataExchangeRequest request)

"Flattened" method variants have converted the fields of the request object into function parameters to enable multiple ways to call the same method.

  • createDataExchange(LocationName parent, DataExchange dataExchange)

  • createDataExchange(String parent, DataExchange dataExchange)

Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service.

  • createDataExchangeCallable()

UpdateDataExchange

Updates an existing data exchange.

Request object method variants only take one parameter, a request object, which must be constructed before the call.

  • updateDataExchange(UpdateDataExchangeRequest request)

"Flattened" method variants have converted the fields of the request object into function parameters to enable multiple ways to call the same method.

  • updateDataExchange(DataExchange dataExchange, FieldMask updateMask)

Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service.

  • updateDataExchangeCallable()

DeleteDataExchange

Deletes an existing data exchange.

Request object method variants only take one parameter, a request object, which must be constructed before the call.

  • deleteDataExchange(DeleteDataExchangeRequest request)

"Flattened" method variants have converted the fields of the request object into function parameters to enable multiple ways to call the same method.

  • deleteDataExchange(DataExchangeName name)

  • deleteDataExchange(String name)

Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service.

  • deleteDataExchangeCallable()

ListListings

Lists all listings in a given project and location.

Request object method variants only take one parameter, a request object, which must be constructed before the call.

  • listListings(ListListingsRequest request)

"Flattened" method variants have converted the fields of the request object into function parameters to enable multiple ways to call the same method.

  • listListings(DataExchangeName parent)

  • listListings(String parent)

Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service.

  • listListingsPagedCallable()

  • listListingsCallable()

GetListing

Gets the details of a listing.

Request object method variants only take one parameter, a request object, which must be constructed before the call.

  • getListing(GetListingRequest request)

"Flattened" method variants have converted the fields of the request object into function parameters to enable multiple ways to call the same method.

  • getListing(ListingName name)

  • getListing(String name)

Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service.

  • getListingCallable()

CreateListing

Creates a new listing.

Request object method variants only take one parameter, a request object, which must be constructed before the call.

  • createListing(CreateListingRequest request)

"Flattened" method variants have converted the fields of the request object into function parameters to enable multiple ways to call the same method.

  • createListing(DataExchangeName parent, Listing listing)

  • createListing(String parent, Listing listing)

Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service.

  • createListingCallable()

UpdateListing

Updates an existing listing.

Request object method variants only take one parameter, a request object, which must be constructed before the call.

  • updateListing(UpdateListingRequest request)

"Flattened" method variants have converted the fields of the request object into function parameters to enable multiple ways to call the same method.

  • updateListing(Listing listing, FieldMask updateMask)

Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service.

  • updateListingCallable()

DeleteListing

Deletes a listing.

Request object method variants only take one parameter, a request object, which must be constructed before the call.

  • deleteListing(DeleteListingRequest request)

"Flattened" method variants have converted the fields of the request object into function parameters to enable multiple ways to call the same method.

  • deleteListing(ListingName name)

  • deleteListing(String name)

Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service.

  • deleteListingCallable()

SubscribeListing

Subscribes to a listing.

Currently, with Analytics Hub, you can create listings that reference only BigQuery datasets. Upon subscription to a listing for a BigQuery dataset, Analytics Hub creates a linked dataset in the subscriber's project.

Request object method variants only take one parameter, a request object, which must be constructed before the call.

  • subscribeListing(SubscribeListingRequest request)

"Flattened" method variants have converted the fields of the request object into function parameters to enable multiple ways to call the same method.

  • subscribeListing(ListingName name)

  • subscribeListing(String name)

Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service.

  • subscribeListingCallable()

SubscribeDataExchange

Creates a Subscription to a Data Exchange. This is a long-running operation as it will create one or more linked datasets.

Request object method variants only take one parameter, a request object, which must be constructed before the call.

  • subscribeDataExchangeAsync(SubscribeDataExchangeRequest request)

Methods that return long-running operations have "Async" method variants that return OperationFuture, which is used to track polling of the service.

  • subscribeDataExchangeAsync(DataExchangeName name)

  • subscribeDataExchangeAsync(String name)

Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service.

  • subscribeDataExchangeOperationCallable()

  • subscribeDataExchangeCallable()

RefreshSubscription

Refreshes a Subscription to a Data Exchange. A Data Exchange can become stale when a publisher adds or removes data. This is a long-running operation as it may create many linked datasets.

Request object method variants only take one parameter, a request object, which must be constructed before the call.

  • refreshSubscriptionAsync(RefreshSubscriptionRequest request)

Methods that return long-running operations have "Async" method variants that return OperationFuture, which is used to track polling of the service.

  • refreshSubscriptionAsync(SubscriptionName name)

  • refreshSubscriptionAsync(String name)

Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service.

  • refreshSubscriptionOperationCallable()

  • refreshSubscriptionCallable()

GetSubscription

Gets the details of a Subscription.

Request object method variants only take one parameter, a request object, which must be constructed before the call.

  • getSubscription(GetSubscriptionRequest request)

"Flattened" method variants have converted the fields of the request object into function parameters to enable multiple ways to call the same method.

  • getSubscription(SubscriptionName name)

  • getSubscription(String name)

Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service.

  • getSubscriptionCallable()

ListSubscriptions

Lists all subscriptions in a given project and location.

Request object method variants only take one parameter, a request object, which must be constructed before the call.

  • listSubscriptions(ListSubscriptionsRequest request)

"Flattened" method variants have converted the fields of the request object into function parameters to enable multiple ways to call the same method.

  • listSubscriptions(LocationName parent)

  • listSubscriptions(String parent)

Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service.

  • listSubscriptionsPagedCallable()

  • listSubscriptionsCallable()

ListSharedResourceSubscriptions

Lists all subscriptions on a given Data Exchange or Listing.

Request object method variants only take one parameter, a request object, which must be constructed before the call.

  • listSharedResourceSubscriptions(ListSharedResourceSubscriptionsRequest request)

"Flattened" method variants have converted the fields of the request object into function parameters to enable multiple ways to call the same method.

  • listSharedResourceSubscriptions(ResourceName resource)

  • listSharedResourceSubscriptions(String resource)

Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service.

  • listSharedResourceSubscriptionsPagedCallable()

  • listSharedResourceSubscriptionsCallable()

RevokeSubscription

Revokes a given subscription.

Request object method variants only take one parameter, a request object, which must be constructed before the call.

  • revokeSubscription(RevokeSubscriptionRequest request)

"Flattened" method variants have converted the fields of the request object into function parameters to enable multiple ways to call the same method.

  • revokeSubscription(SubscriptionName name)

  • revokeSubscription(String name)

Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service.

  • revokeSubscriptionCallable()

DeleteSubscription

Deletes a subscription.

Request object method variants only take one parameter, a request object, which must be constructed before the call.

  • deleteSubscriptionAsync(DeleteSubscriptionRequest request)

Methods that return long-running operations have "Async" method variants that return OperationFuture, which is used to track polling of the service.

  • deleteSubscriptionAsync(SubscriptionName name)

  • deleteSubscriptionAsync(String name)

Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service.

  • deleteSubscriptionOperationCallable()

  • deleteSubscriptionCallable()

GetIamPolicy

Gets the IAM policy.

Request object method variants only take one parameter, a request object, which must be constructed before the call.

  • getIamPolicy(GetIamPolicyRequest request)

Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service.

  • getIamPolicyCallable()

SetIamPolicy

Sets the IAM policy.

Request object method variants only take one parameter, a request object, which must be constructed before the call.

  • setIamPolicy(SetIamPolicyRequest request)

Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service.

  • setIamPolicyCallable()

TestIamPermissions

Returns the permissions that a caller has.

Request object method variants only take one parameter, a request object, which must be constructed before the call.

  • testIamPermissions(TestIamPermissionsRequest request)

Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service.

  • testIamPermissionsCallable()

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.newHttpJsonBuilder().build();
 AnalyticsHubServiceClient analyticsHubServiceClient =
     AnalyticsHubServiceClient.create(analyticsHubServiceSettings);

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

Inheritance

java.lang.Object > AnalyticsHubServiceClient

Static Methods

create()

public static final AnalyticsHubServiceClient create()

Constructs an instance of AnalyticsHubServiceClient with default settings.

Returns
Type Description
AnalyticsHubServiceClient
Exceptions
Type Description
IOException

create(AnalyticsHubServiceSettings settings)

public static final AnalyticsHubServiceClient create(AnalyticsHubServiceSettings settings)

Constructs an instance of AnalyticsHubServiceClient, using the given settings. The channels are created based on the settings passed in, or defaults for any settings that are not set.

Parameter
Name Description
settings AnalyticsHubServiceSettings
Returns
Type Description
AnalyticsHubServiceClient
Exceptions
Type Description
IOException

create(AnalyticsHubServiceStub stub)

public static final AnalyticsHubServiceClient create(AnalyticsHubServiceStub stub)

Constructs an instance of AnalyticsHubServiceClient, using the given stub for making calls. This is for advanced usage - prefer using create(AnalyticsHubServiceSettings).

Parameter
Name Description
stub AnalyticsHubServiceStub
Returns
Type Description
AnalyticsHubServiceClient

Constructors

AnalyticsHubServiceClient(AnalyticsHubServiceSettings settings)

protected AnalyticsHubServiceClient(AnalyticsHubServiceSettings settings)

Constructs an instance of AnalyticsHubServiceClient, using the given settings. This is protected so that it is easy to make a subclass, but otherwise, the static factory methods should be preferred.

Parameter
Name Description
settings AnalyticsHubServiceSettings

AnalyticsHubServiceClient(AnalyticsHubServiceStub stub)

protected AnalyticsHubServiceClient(AnalyticsHubServiceStub stub)
Parameter
Name Description
stub AnalyticsHubServiceStub

Methods

awaitTermination(long duration, TimeUnit unit)

public boolean awaitTermination(long duration, TimeUnit unit)
Parameters
Name Description
duration long
unit TimeUnit
Returns
Type Description
boolean
Exceptions
Type Description
InterruptedException

close()

public final void close()

createDataExchange(CreateDataExchangeRequest request)

public final DataExchange createDataExchange(CreateDataExchangeRequest request)

Creates a new data exchange.

Sample code:


 // 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()) {
   CreateDataExchangeRequest request =
       CreateDataExchangeRequest.newBuilder()
           .setParent(LocationName.of("[PROJECT]", "[LOCATION]").toString())
           .setDataExchangeId("dataExchangeId783243752")
           .setDataExchange(DataExchange.newBuilder().build())
           .build();
   DataExchange response = analyticsHubServiceClient.createDataExchange(request);
 }
Parameter
Name Description
request CreateDataExchangeRequest

The request object containing all of the parameters for the API call.
Returns
Type Description
DataExchange

createDataExchange(LocationName parent, DataExchange dataExchange)

public final DataExchange createDataExchange(LocationName parent, DataExchange dataExchange)

Creates a new data exchange.

Sample code:


 // 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()) {
   LocationName parent = LocationName.of("[PROJECT]", "[LOCATION]");
   DataExchange dataExchange = DataExchange.newBuilder().build();
   DataExchange response = analyticsHubServiceClient.createDataExchange(parent, dataExchange);
 }
Parameters
Name Description
parent LocationName

Required. The parent resource path of the data exchange. e.g. projects/myproject/locations/US.
dataExchange DataExchange

Required. The data exchange to create.
Returns
Type Description
DataExchange

createDataExchange(String parent, DataExchange dataExchange)

public final DataExchange createDataExchange(String parent, DataExchange dataExchange)

Creates a new data exchange.

Sample code:


 // 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()) {
   String parent = LocationName.of("[PROJECT]", "[LOCATION]").toString();
   DataExchange dataExchange = DataExchange.newBuilder().build();
   DataExchange response = analyticsHubServiceClient.createDataExchange(parent, dataExchange);
 }
Parameters
Name Description
parent String

Required. The parent resource path of the data exchange. e.g. projects/myproject/locations/US.
dataExchange DataExchange

Required. The data exchange to create.
Returns
Type Description
DataExchange

createDataExchangeCallable()

public final UnaryCallable<CreateDataExchangeRequest,DataExchange> createDataExchangeCallable()

Creates a new data exchange.

Sample code:


 // 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()) {
   CreateDataExchangeRequest request =
       CreateDataExchangeRequest.newBuilder()
           .setParent(LocationName.of("[PROJECT]", "[LOCATION]").toString())
           .setDataExchangeId("dataExchangeId783243752")
           .setDataExchange(DataExchange.newBuilder().build())
           .build();
   ApiFuture<DataExchange> future =
       analyticsHubServiceClient.createDataExchangeCallable().futureCall(request);
   // Do something.
   DataExchange response = future.get();
 }
Returns
Type Description
UnaryCallable<CreateDataExchangeRequest,DataExchange>

createListing(CreateListingRequest request)

public final Listing createListing(CreateListingRequest request)

Creates a new listing.

Sample code:


 // 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()) {
   CreateListingRequest request =
       CreateListingRequest.newBuilder()
           .setParent(
               DataExchangeName.of("[PROJECT]", "[LOCATION]", "[DATA_EXCHANGE]").toString())
           .setListingId("listingId-1215024449")
           .setListing(Listing.newBuilder().build())
           .build();
   Listing response = analyticsHubServiceClient.createListing(request);
 }
Parameter
Name Description
request CreateListingRequest

The request object containing all of the parameters for the API call.
Returns
Type Description
Listing

createListing(DataExchangeName parent, Listing listing)

public final Listing createListing(DataExchangeName parent, Listing listing)

Creates a new listing.

Sample code:


 // 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 parent = DataExchangeName.of("[PROJECT]", "[LOCATION]", "[DATA_EXCHANGE]");
   Listing listing = Listing.newBuilder().build();
   Listing response = analyticsHubServiceClient.createListing(parent, listing);
 }
Parameters
Name Description
parent DataExchangeName

Required. The parent resource path of the listing. e.g. projects/myproject/locations/US/dataExchanges/123.
listing Listing

Required. The listing to create.
Returns
Type Description
Listing

createListing(String parent, Listing listing)

public final Listing createListing(String parent, Listing listing)

Creates a new listing.

Sample code:


 // 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()) {
   String parent = DataExchangeName.of("[PROJECT]", "[LOCATION]", "[DATA_EXCHANGE]").toString();
   Listing listing = Listing.newBuilder().build();
   Listing response = analyticsHubServiceClient.createListing(parent, listing);
 }
Parameters
Name Description
parent String

Required. The parent resource path of the listing. e.g. projects/myproject/locations/US/dataExchanges/123.
listing Listing

Required. The listing to create.
Returns
Type Description
Listing

createListingCallable()

public final UnaryCallable<CreateListingRequest,Listing> createListingCallable()

Creates a new listing.

Sample code:


 // 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()) {
   CreateListingRequest request =
       CreateListingRequest.newBuilder()
           .setParent(
               DataExchangeName.of("[PROJECT]", "[LOCATION]", "[DATA_EXCHANGE]").toString())
           .setListingId("listingId-1215024449")
           .setListing(Listing.newBuilder().build())
           .build();
   ApiFuture<Listing> future =
       analyticsHubServiceClient.createListingCallable().futureCall(request);
   // Do something.
   Listing response = future.get();
 }
Returns
Type Description
UnaryCallable<CreateListingRequest,Listing>

deleteDataExchange(DataExchangeName name)

public final void deleteDataExchange(DataExchangeName name)

Deletes an existing data exchange.

Sample code:


 // 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]");
   analyticsHubServiceClient.deleteDataExchange(name);
 }
Parameter
Name Description
name DataExchangeName

Required. The full name of the data exchange resource that you want to delete. For example, projects/myproject/locations/US/dataExchanges/123.

deleteDataExchange(DeleteDataExchangeRequest request)

public final void deleteDataExchange(DeleteDataExchangeRequest request)

Deletes an existing data exchange.

Sample code:


 // 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()) {
   DeleteDataExchangeRequest request =
       DeleteDataExchangeRequest.newBuilder()
           .setName(DataExchangeName.of("[PROJECT]", "[LOCATION]", "[DATA_EXCHANGE]").toString())
           .build();
   analyticsHubServiceClient.deleteDataExchange(request);
 }
Parameter
Name Description
request DeleteDataExchangeRequest

The request object containing all of the parameters for the API call.

deleteDataExchange(String name)

public final void deleteDataExchange(String name)

Deletes an existing data exchange.

Sample code:


 // 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()) {
   String name = DataExchangeName.of("[PROJECT]", "[LOCATION]", "[DATA_EXCHANGE]").toString();
   analyticsHubServiceClient.deleteDataExchange(name);
 }
Parameter
Name Description
name String

Required. The full name of the data exchange resource that you want to delete. For example, projects/myproject/locations/US/dataExchanges/123.

deleteDataExchangeCallable()

public final UnaryCallable<DeleteDataExchangeRequest,Empty> deleteDataExchangeCallable()

Deletes an existing data exchange.

Sample code:


 // 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()) {
   DeleteDataExchangeRequest request =
       DeleteDataExchangeRequest.newBuilder()
           .setName(DataExchangeName.of("[PROJECT]", "[LOCATION]", "[DATA_EXCHANGE]").toString())
           .build();
   ApiFuture<Empty> future =
       analyticsHubServiceClient.deleteDataExchangeCallable().futureCall(request);
   // Do something.
   future.get();
 }
Returns
Type Description
UnaryCallable<DeleteDataExchangeRequest,Empty>

deleteListing(DeleteListingRequest request)

public final void deleteListing(DeleteListingRequest request)

Deletes a listing.

Sample code:


 // 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()) {
   DeleteListingRequest request =
       DeleteListingRequest.newBuilder()
           .setName(
               ListingName.of("[PROJECT]", "[LOCATION]", "[DATA_EXCHANGE]", "[LISTING]")
                   .toString())
           .build();
   analyticsHubServiceClient.deleteListing(request);
 }
Parameter
Name Description
request DeleteListingRequest

The request object containing all of the parameters for the API call.

deleteListing(ListingName name)

public final void deleteListing(ListingName name)

Deletes a listing.

Sample code:


 // 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()) {
   ListingName name = ListingName.of("[PROJECT]", "[LOCATION]", "[DATA_EXCHANGE]", "[LISTING]");
   analyticsHubServiceClient.deleteListing(name);
 }
Parameter
Name Description
name ListingName

Required. Resource name of the listing to delete. e.g. projects/myproject/locations/US/dataExchanges/123/listings/456.

deleteListing(String name)

public final void deleteListing(String name)

Deletes a listing.

Sample code:


 // 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()) {
   String name =
       ListingName.of("[PROJECT]", "[LOCATION]", "[DATA_EXCHANGE]", "[LISTING]").toString();
   analyticsHubServiceClient.deleteListing(name);
 }
Parameter
Name Description
name String

Required. Resource name of the listing to delete. e.g. projects/myproject/locations/US/dataExchanges/123/listings/456.

deleteListingCallable()

public final UnaryCallable<DeleteListingRequest,Empty> deleteListingCallable()

Deletes a listing.

Sample code:


 // 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()) {
   DeleteListingRequest request =
       DeleteListingRequest.newBuilder()
           .setName(
               ListingName.of("[PROJECT]", "[LOCATION]", "[DATA_EXCHANGE]", "[LISTING]")
                   .toString())
           .build();
   ApiFuture<Empty> future =
       analyticsHubServiceClient.deleteListingCallable().futureCall(request);
   // Do something.
   future.get();
 }
Returns
Type Description
UnaryCallable<DeleteListingRequest,Empty>

deleteSubscriptionAsync(DeleteSubscriptionRequest request)

public final OperationFuture<Empty,OperationMetadata> deleteSubscriptionAsync(DeleteSubscriptionRequest request)

Deletes a subscription.

Sample code:


 // 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()) {
   DeleteSubscriptionRequest request =
       DeleteSubscriptionRequest.newBuilder()
           .setName(SubscriptionName.of("[PROJECT]", "[LOCATION]", "[SUBSCRIPTION]").toString())
           .build();
   analyticsHubServiceClient.deleteSubscriptionAsync(request).get();
 }
Parameter
Name Description
request DeleteSubscriptionRequest

The request object containing all of the parameters for the API call.
Returns
Type Description
OperationFuture<Empty,OperationMetadata>

deleteSubscriptionAsync(SubscriptionName name)

public final OperationFuture<Empty,OperationMetadata> deleteSubscriptionAsync(SubscriptionName name)

Deletes a subscription.

Sample code:


 // 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()) {
   SubscriptionName name = SubscriptionName.of("[PROJECT]", "[LOCATION]", "[SUBSCRIPTION]");
   analyticsHubServiceClient.deleteSubscriptionAsync(name).get();
 }
Parameter
Name Description
name SubscriptionName

Required. Resource name of the subscription to delete. e.g. projects/123/locations/US/subscriptions/456
Returns
Type Description
OperationFuture<Empty,OperationMetadata>

deleteSubscriptionAsync(String name)

public final OperationFuture<Empty,OperationMetadata> deleteSubscriptionAsync(String name)

Deletes a subscription.

Sample code:


 // 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()) {
   String name = SubscriptionName.of("[PROJECT]", "[LOCATION]", "[SUBSCRIPTION]").toString();
   analyticsHubServiceClient.deleteSubscriptionAsync(name).get();
 }
Parameter
Name Description
name String

Required. Resource name of the subscription to delete. e.g. projects/123/locations/US/subscriptions/456
Returns
Type Description
OperationFuture<Empty,OperationMetadata>

deleteSubscriptionCallable()

public final UnaryCallable<DeleteSubscriptionRequest,Operation> deleteSubscriptionCallable()

Deletes a subscription.

Sample code:


 // 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()) {
   DeleteSubscriptionRequest request =
       DeleteSubscriptionRequest.newBuilder()
           .setName(SubscriptionName.of("[PROJECT]", "[LOCATION]", "[SUBSCRIPTION]").toString())
           .build();
   ApiFuture<Operation> future =
       analyticsHubServiceClient.deleteSubscriptionCallable().futureCall(request);
   // Do something.
   future.get();
 }
Returns
Type Description
UnaryCallable<DeleteSubscriptionRequest,Operation>

deleteSubscriptionOperationCallable()

public final OperationCallable<DeleteSubscriptionRequest,Empty,OperationMetadata> deleteSubscriptionOperationCallable()

Deletes a subscription.

Sample code:


 // 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()) {
   DeleteSubscriptionRequest request =
       DeleteSubscriptionRequest.newBuilder()
           .setName(SubscriptionName.of("[PROJECT]", "[LOCATION]", "[SUBSCRIPTION]").toString())
           .build();
   OperationFuture<Empty, OperationMetadata> future =
       analyticsHubServiceClient.deleteSubscriptionOperationCallable().futureCall(request);
   // Do something.
   future.get();
 }
Returns
Type Description
OperationCallable<DeleteSubscriptionRequest,Empty,OperationMetadata>

getDataExchange(DataExchangeName name)

public final DataExchange getDataExchange(DataExchangeName name)

Gets the details of a data exchange.

Sample code:


 // 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);
 }
Parameter
Name Description
name DataExchangeName

Required. The resource name of the data exchange. e.g. projects/myproject/locations/US/dataExchanges/123.
Returns
Type Description
DataExchange

getDataExchange(GetDataExchangeRequest request)

public final DataExchange getDataExchange(GetDataExchangeRequest request)

Gets the details of a data exchange.

Sample code:


 // 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()) {
   GetDataExchangeRequest request =
       GetDataExchangeRequest.newBuilder()
           .setName(DataExchangeName.of("[PROJECT]", "[LOCATION]", "[DATA_EXCHANGE]").toString())
           .build();
   DataExchange response = analyticsHubServiceClient.getDataExchange(request);
 }
Parameter
Name Description
request GetDataExchangeRequest

The request object containing all of the parameters for the API call.
Returns
Type Description
DataExchange

getDataExchange(String name)

public final DataExchange getDataExchange(String name)

Gets the details of a data exchange.

Sample code:


 // 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()) {
   String name = DataExchangeName.of("[PROJECT]", "[LOCATION]", "[DATA_EXCHANGE]").toString();
   DataExchange response = analyticsHubServiceClient.getDataExchange(name);
 }
Parameter
Name Description
name String

Required. The resource name of the data exchange. e.g. projects/myproject/locations/US/dataExchanges/123.
Returns
Type Description
DataExchange

getDataExchangeCallable()

public final UnaryCallable<GetDataExchangeRequest,DataExchange> getDataExchangeCallable()

Gets the details of a data exchange.

Sample code:


 // 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()) {
   GetDataExchangeRequest request =
       GetDataExchangeRequest.newBuilder()
           .setName(DataExchangeName.of("[PROJECT]", "[LOCATION]", "[DATA_EXCHANGE]").toString())
           .build();
   ApiFuture<DataExchange> future =
       analyticsHubServiceClient.getDataExchangeCallable().futureCall(request);
   // Do something.
   DataExchange response = future.get();
 }
Returns
Type Description
UnaryCallable<GetDataExchangeRequest,DataExchange>

getHttpJsonOperationsClient()

public final OperationsClient getHttpJsonOperationsClient()

Returns the OperationsClient that can be used to query the status of a long-running operation returned by another API method call.

Returns
Type Description
OperationsClient

getIamPolicy(GetIamPolicyRequest request)

public final Policy getIamPolicy(GetIamPolicyRequest request)

Gets the IAM policy.

Sample code:


 // 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()) {
   GetIamPolicyRequest request =
       GetIamPolicyRequest.newBuilder()
           .setResource(
               DataExchangeName.of("[PROJECT]", "[LOCATION]", "[DATA_EXCHANGE]").toString())
           .setOptions(GetPolicyOptions.newBuilder().build())
           .build();
   Policy response = analyticsHubServiceClient.getIamPolicy(request);
 }
Parameter
Name Description
request com.google.iam.v1.GetIamPolicyRequest

The request object containing all of the parameters for the API call.
Returns
Type Description
com.google.iam.v1.Policy

getIamPolicyCallable()

public final UnaryCallable<GetIamPolicyRequest,Policy> getIamPolicyCallable()

Gets the IAM policy.

Sample code:


 // 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()) {
   GetIamPolicyRequest request =
       GetIamPolicyRequest.newBuilder()
           .setResource(
               DataExchangeName.of("[PROJECT]", "[LOCATION]", "[DATA_EXCHANGE]").toString())
           .setOptions(GetPolicyOptions.newBuilder().build())
           .build();
   ApiFuture<Policy> future =
       analyticsHubServiceClient.getIamPolicyCallable().futureCall(request);
   // Do something.
   Policy response = future.get();
 }
Returns
Type Description
UnaryCallable<com.google.iam.v1.GetIamPolicyRequest,com.google.iam.v1.Policy>

getListing(GetListingRequest request)

public final Listing getListing(GetListingRequest request)

Gets the details of a listing.

Sample code:


 // 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()) {
   GetListingRequest request =
       GetListingRequest.newBuilder()
           .setName(
               ListingName.of("[PROJECT]", "[LOCATION]", "[DATA_EXCHANGE]", "[LISTING]")
                   .toString())
           .build();
   Listing response = analyticsHubServiceClient.getListing(request);
 }
Parameter
Name Description
request GetListingRequest

The request object containing all of the parameters for the API call.
Returns
Type Description
Listing

getListing(ListingName name)

public final Listing getListing(ListingName name)

Gets the details of a listing.

Sample code:


 // 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()) {
   ListingName name = ListingName.of("[PROJECT]", "[LOCATION]", "[DATA_EXCHANGE]", "[LISTING]");
   Listing response = analyticsHubServiceClient.getListing(name);
 }
Parameter
Name Description
name ListingName

Required. The resource name of the listing. e.g. projects/myproject/locations/US/dataExchanges/123/listings/456.
Returns
Type Description
Listing

getListing(String name)

public final Listing getListing(String name)

Gets the details of a listing.

Sample code:


 // 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()) {
   String name =
       ListingName.of("[PROJECT]", "[LOCATION]", "[DATA_EXCHANGE]", "[LISTING]").toString();
   Listing response = analyticsHubServiceClient.getListing(name);
 }
Parameter
Name Description
name String

Required. The resource name of the listing. e.g. projects/myproject/locations/US/dataExchanges/123/listings/456.
Returns
Type Description
Listing

getListingCallable()

public final UnaryCallable<GetListingRequest,Listing> getListingCallable()

Gets the details of a listing.

Sample code:


 // 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()) {
   GetListingRequest request =
       GetListingRequest.newBuilder()
           .setName(
               ListingName.of("[PROJECT]", "[LOCATION]", "[DATA_EXCHANGE]", "[LISTING]")
                   .toString())
           .build();
   ApiFuture<Listing> future =
       analyticsHubServiceClient.getListingCallable().futureCall(request);
   // Do something.
   Listing response = future.get();
 }
Returns
Type Description
UnaryCallable<GetListingRequest,Listing>

getOperationsClient()

public final OperationsClient getOperationsClient()

Returns the OperationsClient that can be used to query the status of a long-running operation returned by another API method call.

Returns
Type Description
OperationsClient

getSettings()

public final AnalyticsHubServiceSettings getSettings()
Returns
Type Description
AnalyticsHubServiceSettings

getStub()

public AnalyticsHubServiceStub getStub()
Returns
Type Description
AnalyticsHubServiceStub

getSubscription(GetSubscriptionRequest request)

public final Subscription getSubscription(GetSubscriptionRequest request)

Gets the details of a Subscription.

Sample code:


 // 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()) {
   GetSubscriptionRequest request =
       GetSubscriptionRequest.newBuilder()
           .setName(SubscriptionName.of("[PROJECT]", "[LOCATION]", "[SUBSCRIPTION]").toString())
           .build();
   Subscription response = analyticsHubServiceClient.getSubscription(request);
 }
Parameter
Name Description
request GetSubscriptionRequest

The request object containing all of the parameters for the API call.
Returns
Type Description
Subscription

getSubscription(SubscriptionName name)

public final Subscription getSubscription(SubscriptionName name)

Gets the details of a Subscription.

Sample code:


 // 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()) {
   SubscriptionName name = SubscriptionName.of("[PROJECT]", "[LOCATION]", "[SUBSCRIPTION]");
   Subscription response = analyticsHubServiceClient.getSubscription(name);
 }
Parameter
Name Description
name SubscriptionName

Required. Resource name of the subscription. e.g. projects/123/locations/US/subscriptions/456
Returns
Type Description
Subscription

getSubscription(String name)

public final Subscription getSubscription(String name)

Gets the details of a Subscription.

Sample code:


 // 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()) {
   String name = SubscriptionName.of("[PROJECT]", "[LOCATION]", "[SUBSCRIPTION]").toString();
   Subscription response = analyticsHubServiceClient.getSubscription(name);
 }
Parameter
Name Description
name String

Required. Resource name of the subscription. e.g. projects/123/locations/US/subscriptions/456
Returns
Type Description
Subscription

getSubscriptionCallable()

public final UnaryCallable<GetSubscriptionRequest,Subscription> getSubscriptionCallable()

Gets the details of a Subscription.

Sample code:


 // 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()) {
   GetSubscriptionRequest request =
       GetSubscriptionRequest.newBuilder()
           .setName(SubscriptionName.of("[PROJECT]", "[LOCATION]", "[SUBSCRIPTION]").toString())
           .build();
   ApiFuture<Subscription> future =
       analyticsHubServiceClient.getSubscriptionCallable().futureCall(request);
   // Do something.
   Subscription response = future.get();
 }
Returns
Type Description
UnaryCallable<GetSubscriptionRequest,Subscription>

isShutdown()

public boolean isShutdown()
Returns
Type Description
boolean

isTerminated()

public boolean isTerminated()
Returns
Type Description
boolean

listDataExchanges(ListDataExchangesRequest request)

public final AnalyticsHubServiceClient.ListDataExchangesPagedResponse listDataExchanges(ListDataExchangesRequest request)

Lists all data exchanges in a given project and location.

Sample code:


 // 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()) {
   ListDataExchangesRequest request =
       ListDataExchangesRequest.newBuilder()
           .setParent(LocationName.of("[PROJECT]", "[LOCATION]").toString())
           .setPageSize(883849137)
           .setPageToken("pageToken873572522")
           .build();
   for (DataExchange element :
       analyticsHubServiceClient.listDataExchanges(request).iterateAll()) {
     // doThingsWith(element);
   }
 }
Parameter
Name Description
request ListDataExchangesRequest

The request object containing all of the parameters for the API call.
Returns
Type Description
AnalyticsHubServiceClient.ListDataExchangesPagedResponse

listDataExchanges(LocationName parent)

public final AnalyticsHubServiceClient.ListDataExchangesPagedResponse listDataExchanges(LocationName parent)

Lists all data exchanges in a given project and location.

Sample code:


 // 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()) {
   LocationName parent = LocationName.of("[PROJECT]", "[LOCATION]");
   for (DataExchange element :
       analyticsHubServiceClient.listDataExchanges(parent).iterateAll()) {
     // doThingsWith(element);
   }
 }
Parameter
Name Description
parent LocationName

Required. The parent resource path of the data exchanges. e.g. projects/myproject/locations/US.
Returns
Type Description
AnalyticsHubServiceClient.ListDataExchangesPagedResponse

listDataExchanges(String parent)

public final AnalyticsHubServiceClient.ListDataExchangesPagedResponse listDataExchanges(String parent)

Lists all data exchanges in a given project and location.

Sample code:


 // 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()) {
   String parent = LocationName.of("[PROJECT]", "[LOCATION]").toString();
   for (DataExchange element :
       analyticsHubServiceClient.listDataExchanges(parent).iterateAll()) {
     // doThingsWith(element);
   }
 }
Parameter
Name Description
parent String

Required. The parent resource path of the data exchanges. e.g. projects/myproject/locations/US.
Returns
Type Description
AnalyticsHubServiceClient.ListDataExchangesPagedResponse

listDataExchangesCallable()

public final UnaryCallable<ListDataExchangesRequest,ListDataExchangesResponse> listDataExchangesCallable()

Lists all data exchanges in a given project and location.

Sample code:


 // 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()) {
   ListDataExchangesRequest request =
       ListDataExchangesRequest.newBuilder()
           .setParent(LocationName.of("[PROJECT]", "[LOCATION]").toString())
           .setPageSize(883849137)
           .setPageToken("pageToken873572522")
           .build();
   while (true) {
     ListDataExchangesResponse response =
         analyticsHubServiceClient.listDataExchangesCallable().call(request);
     for (DataExchange element : response.getDataExchangesList()) {
       // doThingsWith(element);
     }
     String nextPageToken = response.getNextPageToken();
     if (!Strings.isNullOrEmpty(nextPageToken)) {
       request = request.toBuilder().setPageToken(nextPageToken).build();
     } else {
       break;
     }
   }
 }
Returns
Type Description
UnaryCallable<ListDataExchangesRequest,ListDataExchangesResponse>

listDataExchangesPagedCallable()

public final UnaryCallable<ListDataExchangesRequest,AnalyticsHubServiceClient.ListDataExchangesPagedResponse> listDataExchangesPagedCallable()

Lists all data exchanges in a given project and location.

Sample code:


 // 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()) {
   ListDataExchangesRequest request =
       ListDataExchangesRequest.newBuilder()
           .setParent(LocationName.of("[PROJECT]", "[LOCATION]").toString())
           .setPageSize(883849137)
           .setPageToken("pageToken873572522")
           .build();
   ApiFuture<DataExchange> future =
       analyticsHubServiceClient.listDataExchangesPagedCallable().futureCall(request);
   // Do something.
   for (DataExchange element : future.get().iterateAll()) {
     // doThingsWith(element);
   }
 }
Returns
Type Description
UnaryCallable<ListDataExchangesRequest,ListDataExchangesPagedResponse>

listListings(DataExchangeName parent)

public final AnalyticsHubServiceClient.ListListingsPagedResponse listListings(DataExchangeName parent)

Lists all listings in a given project and location.

Sample code:


 // 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 parent = DataExchangeName.of("[PROJECT]", "[LOCATION]", "[DATA_EXCHANGE]");
   for (Listing element : analyticsHubServiceClient.listListings(parent).iterateAll()) {
     // doThingsWith(element);
   }
 }
Parameter
Name Description
parent DataExchangeName

Required. The parent resource path of the listing. e.g. projects/myproject/locations/US/dataExchanges/123.
Returns
Type Description
AnalyticsHubServiceClient.ListListingsPagedResponse

listListings(ListListingsRequest request)

public final AnalyticsHubServiceClient.ListListingsPagedResponse listListings(ListListingsRequest request)

Lists all listings in a given project and location.

Sample code:


 // 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()) {
   ListListingsRequest request =
       ListListingsRequest.newBuilder()
           .setParent(
               DataExchangeName.of("[PROJECT]", "[LOCATION]", "[DATA_EXCHANGE]").toString())
           .setPageSize(883849137)
           .setPageToken("pageToken873572522")
           .build();
   for (Listing element : analyticsHubServiceClient.listListings(request).iterateAll()) {
     // doThingsWith(element);
   }
 }
Parameter
Name Description
request ListListingsRequest

The request object containing all of the parameters for the API call.
Returns
Type Description
AnalyticsHubServiceClient.ListListingsPagedResponse

listListings(String parent)

public final AnalyticsHubServiceClient.ListListingsPagedResponse listListings(String parent)

Lists all listings in a given project and location.

Sample code:


 // 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()) {
   String parent = DataExchangeName.of("[PROJECT]", "[LOCATION]", "[DATA_EXCHANGE]").toString();
   for (Listing element : analyticsHubServiceClient.listListings(parent).iterateAll()) {
     // doThingsWith(element);
   }
 }
Parameter
Name Description
parent String

Required. The parent resource path of the listing. e.g. projects/myproject/locations/US/dataExchanges/123.
Returns
Type Description
AnalyticsHubServiceClient.ListListingsPagedResponse

listListingsCallable()

public final UnaryCallable<ListListingsRequest,ListListingsResponse> listListingsCallable()

Lists all listings in a given project and location.

Sample code:


 // 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()) {
   ListListingsRequest request =
       ListListingsRequest.newBuilder()
           .setParent(
               DataExchangeName.of("[PROJECT]", "[LOCATION]", "[DATA_EXCHANGE]").toString())
           .setPageSize(883849137)
           .setPageToken("pageToken873572522")
           .build();
   while (true) {
     ListListingsResponse response =
         analyticsHubServiceClient.listListingsCallable().call(request);
     for (Listing element : response.getListingsList()) {
       // doThingsWith(element);
     }
     String nextPageToken = response.getNextPageToken();
     if (!Strings.isNullOrEmpty(nextPageToken)) {
       request = request.toBuilder().setPageToken(nextPageToken).build();
     } else {
       break;
     }
   }
 }
Returns
Type Description
UnaryCallable<ListListingsRequest,ListListingsResponse>

listListingsPagedCallable()

public final UnaryCallable<ListListingsRequest,AnalyticsHubServiceClient.ListListingsPagedResponse> listListingsPagedCallable()

Lists all listings in a given project and location.

Sample code:


 // 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()) {
   ListListingsRequest request =
       ListListingsRequest.newBuilder()
           .setParent(
               DataExchangeName.of("[PROJECT]", "[LOCATION]", "[DATA_EXCHANGE]").toString())
           .setPageSize(883849137)
           .setPageToken("pageToken873572522")
           .build();
   ApiFuture<Listing> future =
       analyticsHubServiceClient.listListingsPagedCallable().futureCall(request);
   // Do something.
   for (Listing element : future.get().iterateAll()) {
     // doThingsWith(element);
   }
 }
Returns
Type Description
UnaryCallable<ListListingsRequest,ListListingsPagedResponse>

listOrgDataExchanges(ListOrgDataExchangesRequest request)

public final AnalyticsHubServiceClient.ListOrgDataExchangesPagedResponse listOrgDataExchanges(ListOrgDataExchangesRequest request)

Lists all data exchanges from projects in a given organization and location.

Sample code:


 // 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()) {
   ListOrgDataExchangesRequest request =
       ListOrgDataExchangesRequest.newBuilder()
           .setOrganization("organization1178922291")
           .setPageSize(883849137)
           .setPageToken("pageToken873572522")
           .build();
   for (DataExchange element :
       analyticsHubServiceClient.listOrgDataExchanges(request).iterateAll()) {
     // doThingsWith(element);
   }
 }
Parameter
Name Description
request ListOrgDataExchangesRequest

The request object containing all of the parameters for the API call.
Returns
Type Description
AnalyticsHubServiceClient.ListOrgDataExchangesPagedResponse

listOrgDataExchanges(String organization)

public final AnalyticsHubServiceClient.ListOrgDataExchangesPagedResponse listOrgDataExchanges(String organization)

Lists all data exchanges from projects in a given organization and location.

Sample code:


 // 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()) {
   String organization = "organization1178922291";
   for (DataExchange element :
       analyticsHubServiceClient.listOrgDataExchanges(organization).iterateAll()) {
     // doThingsWith(element);
   }
 }
Parameter
Name Description
organization String

Required. The organization resource path of the projects containing DataExchanges. e.g. organizations/myorg/locations/US.
Returns
Type Description
AnalyticsHubServiceClient.ListOrgDataExchangesPagedResponse

listOrgDataExchangesCallable()

public final UnaryCallable<ListOrgDataExchangesRequest,ListOrgDataExchangesResponse> listOrgDataExchangesCallable()

Lists all data exchanges from projects in a given organization and location.

Sample code:


 // 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()) {
   ListOrgDataExchangesRequest request =
       ListOrgDataExchangesRequest.newBuilder()
           .setOrganization("organization1178922291")
           .setPageSize(883849137)
           .setPageToken("pageToken873572522")
           .build();
   while (true) {
     ListOrgDataExchangesResponse response =
         analyticsHubServiceClient.listOrgDataExchangesCallable().call(request);
     for (DataExchange element : response.getDataExchangesList()) {
       // doThingsWith(element);
     }
     String nextPageToken = response.getNextPageToken();
     if (!Strings.isNullOrEmpty(nextPageToken)) {
       request = request.toBuilder().setPageToken(nextPageToken).build();
     } else {
       break;
     }
   }
 }
Returns
Type Description
UnaryCallable<ListOrgDataExchangesRequest,ListOrgDataExchangesResponse>

listOrgDataExchangesPagedCallable()

public final UnaryCallable<ListOrgDataExchangesRequest,AnalyticsHubServiceClient.ListOrgDataExchangesPagedResponse> listOrgDataExchangesPagedCallable()

Lists all data exchanges from projects in a given organization and location.

Sample code:


 // 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()) {
   ListOrgDataExchangesRequest request =
       ListOrgDataExchangesRequest.newBuilder()
           .setOrganization("organization1178922291")
           .setPageSize(883849137)
           .setPageToken("pageToken873572522")
           .build();
   ApiFuture<DataExchange> future =
       analyticsHubServiceClient.listOrgDataExchangesPagedCallable().futureCall(request);
   // Do something.
   for (DataExchange element : future.get().iterateAll()) {
     // doThingsWith(element);
   }
 }
Returns
Type Description
UnaryCallable<ListOrgDataExchangesRequest,ListOrgDataExchangesPagedResponse>

listSharedResourceSubscriptions(ResourceName resource)

public final AnalyticsHubServiceClient.ListSharedResourceSubscriptionsPagedResponse listSharedResourceSubscriptions(ResourceName resource)

Lists all subscriptions on a given Data Exchange or Listing.

Sample code:


 // 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()) {
   ResourceName resource = DataExchangeName.of("[PROJECT]", "[LOCATION]", "[DATA_EXCHANGE]");
   for (Subscription element :
       analyticsHubServiceClient.listSharedResourceSubscriptions(resource).iterateAll()) {
     // doThingsWith(element);
   }
 }
Parameter
Name Description
resource com.google.api.resourcenames.ResourceName

Required. Resource name of the requested target. This resource may be either a Listing or a DataExchange. e.g. projects/123/locations/US/dataExchanges/456 OR e.g. projects/123/locations/US/dataExchanges/456/listings/789
Returns
Type Description
AnalyticsHubServiceClient.ListSharedResourceSubscriptionsPagedResponse

listSharedResourceSubscriptions(ListSharedResourceSubscriptionsRequest request)

public final AnalyticsHubServiceClient.ListSharedResourceSubscriptionsPagedResponse listSharedResourceSubscriptions(ListSharedResourceSubscriptionsRequest request)

Lists all subscriptions on a given Data Exchange or Listing.

Sample code:


 // 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()) {
   ListSharedResourceSubscriptionsRequest request =
       ListSharedResourceSubscriptionsRequest.newBuilder()
           .setResource(
               DataExchangeName.of("[PROJECT]", "[LOCATION]", "[DATA_EXCHANGE]").toString())
           .setIncludeDeletedSubscriptions(true)
           .setPageSize(883849137)
           .setPageToken("pageToken873572522")
           .build();
   for (Subscription element :
       analyticsHubServiceClient.listSharedResourceSubscriptions(request).iterateAll()) {
     // doThingsWith(element);
   }
 }
Parameter
Name Description
request ListSharedResourceSubscriptionsRequest

The request object containing all of the parameters for the API call.
Returns
Type Description
AnalyticsHubServiceClient.ListSharedResourceSubscriptionsPagedResponse

listSharedResourceSubscriptions(String resource)

public final AnalyticsHubServiceClient.ListSharedResourceSubscriptionsPagedResponse listSharedResourceSubscriptions(String resource)

Lists all subscriptions on a given Data Exchange or Listing.

Sample code:


 // 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()) {
   String resource =
       DataExchangeName.of("[PROJECT]", "[LOCATION]", "[DATA_EXCHANGE]").toString();
   for (Subscription element :
       analyticsHubServiceClient.listSharedResourceSubscriptions(resource).iterateAll()) {
     // doThingsWith(element);
   }
 }
Parameter
Name Description
resource String

Required. Resource name of the requested target. This resource may be either a Listing or a DataExchange. e.g. projects/123/locations/US/dataExchanges/456 OR e.g. projects/123/locations/US/dataExchanges/456/listings/789
Returns
Type Description
AnalyticsHubServiceClient.ListSharedResourceSubscriptionsPagedResponse

listSharedResourceSubscriptionsCallable()

public final UnaryCallable<ListSharedResourceSubscriptionsRequest,ListSharedResourceSubscriptionsResponse> listSharedResourceSubscriptionsCallable()

Lists all subscriptions on a given Data Exchange or Listing.

Sample code:


 // 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()) {
   ListSharedResourceSubscriptionsRequest request =
       ListSharedResourceSubscriptionsRequest.newBuilder()
           .setResource(
               DataExchangeName.of("[PROJECT]", "[LOCATION]", "[DATA_EXCHANGE]").toString())
           .setIncludeDeletedSubscriptions(true)
           .setPageSize(883849137)
           .setPageToken("pageToken873572522")
           .build();
   while (true) {
     ListSharedResourceSubscriptionsResponse response =
         analyticsHubServiceClient.listSharedResourceSubscriptionsCallable().call(request);
     for (Subscription element : response.getSharedResourceSubscriptionsList()) {
       // doThingsWith(element);
     }
     String nextPageToken = response.getNextPageToken();
     if (!Strings.isNullOrEmpty(nextPageToken)) {
       request = request.toBuilder().setPageToken(nextPageToken).build();
     } else {
       break;
     }
   }
 }
Returns
Type Description
UnaryCallable<ListSharedResourceSubscriptionsRequest,ListSharedResourceSubscriptionsResponse>

listSharedResourceSubscriptionsPagedCallable()

public final UnaryCallable<ListSharedResourceSubscriptionsRequest,AnalyticsHubServiceClient.ListSharedResourceSubscriptionsPagedResponse> listSharedResourceSubscriptionsPagedCallable()

Lists all subscriptions on a given Data Exchange or Listing.

Sample code:


 // 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()) {
   ListSharedResourceSubscriptionsRequest request =
       ListSharedResourceSubscriptionsRequest.newBuilder()
           .setResource(
               DataExchangeName.of("[PROJECT]", "[LOCATION]", "[DATA_EXCHANGE]").toString())
           .setIncludeDeletedSubscriptions(true)
           .setPageSize(883849137)
           .setPageToken("pageToken873572522")
           .build();
   ApiFuture<Subscription> future =
       analyticsHubServiceClient
           .listSharedResourceSubscriptionsPagedCallable()
           .futureCall(request);
   // Do something.
   for (Subscription element : future.get().iterateAll()) {
     // doThingsWith(element);
   }
 }
Returns
Type Description
UnaryCallable<ListSharedResourceSubscriptionsRequest,ListSharedResourceSubscriptionsPagedResponse>

listSubscriptions(ListSubscriptionsRequest request)

public final AnalyticsHubServiceClient.ListSubscriptionsPagedResponse listSubscriptions(ListSubscriptionsRequest request)

Lists all subscriptions in a given project and location.

Sample code:


 // 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()) {
   ListSubscriptionsRequest request =
       ListSubscriptionsRequest.newBuilder()
           .setParent(LocationName.of("[PROJECT]", "[LOCATION]").toString())
           .setFilter("filter-1274492040")
           .setPageSize(883849137)
           .setPageToken("pageToken873572522")
           .build();
   for (Subscription element :
       analyticsHubServiceClient.listSubscriptions(request).iterateAll()) {
     // doThingsWith(element);
   }
 }
Parameter
Name Description
request ListSubscriptionsRequest

The request object containing all of the parameters for the API call.
Returns
Type Description
AnalyticsHubServiceClient.ListSubscriptionsPagedResponse

listSubscriptions(LocationName parent)

public final AnalyticsHubServiceClient.ListSubscriptionsPagedResponse listSubscriptions(LocationName parent)

Lists all subscriptions in a given project and location.

Sample code:


 // 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()) {
   LocationName parent = LocationName.of("[PROJECT]", "[LOCATION]");
   for (Subscription element :
       analyticsHubServiceClient.listSubscriptions(parent).iterateAll()) {
     // doThingsWith(element);
   }
 }
Parameter
Name Description
parent LocationName

Required. The parent resource path of the subscription. e.g. projects/myproject/locations/US
Returns
Type Description
AnalyticsHubServiceClient.ListSubscriptionsPagedResponse

listSubscriptions(String parent)

public final AnalyticsHubServiceClient.ListSubscriptionsPagedResponse listSubscriptions(String parent)

Lists all subscriptions in a given project and location.

Sample code:


 // 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()) {
   String parent = LocationName.of("[PROJECT]", "[LOCATION]").toString();
   for (Subscription element :
       analyticsHubServiceClient.listSubscriptions(parent).iterateAll()) {
     // doThingsWith(element);
   }
 }
Parameter
Name Description
parent String

Required. The parent resource path of the subscription. e.g. projects/myproject/locations/US
Returns
Type Description
AnalyticsHubServiceClient.ListSubscriptionsPagedResponse

listSubscriptionsCallable()

public final UnaryCallable<ListSubscriptionsRequest,ListSubscriptionsResponse> listSubscriptionsCallable()

Lists all subscriptions in a given project and location.

Sample code:


 // 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()) {
   ListSubscriptionsRequest request =
       ListSubscriptionsRequest.newBuilder()
           .setParent(LocationName.of("[PROJECT]", "[LOCATION]").toString())
           .setFilter("filter-1274492040")
           .setPageSize(883849137)
           .setPageToken("pageToken873572522")
           .build();
   while (true) {
     ListSubscriptionsResponse response =
         analyticsHubServiceClient.listSubscriptionsCallable().call(request);
     for (Subscription element : response.getSubscriptionsList()) {
       // doThingsWith(element);
     }
     String nextPageToken = response.getNextPageToken();
     if (!Strings.isNullOrEmpty(nextPageToken)) {
       request = request.toBuilder().setPageToken(nextPageToken).build();
     } else {
       break;
     }
   }
 }
Returns
Type Description
UnaryCallable<ListSubscriptionsRequest,ListSubscriptionsResponse>

listSubscriptionsPagedCallable()

public final UnaryCallable<ListSubscriptionsRequest,AnalyticsHubServiceClient.ListSubscriptionsPagedResponse> listSubscriptionsPagedCallable()

Lists all subscriptions in a given project and location.

Sample code:


 // 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()) {
   ListSubscriptionsRequest request =
       ListSubscriptionsRequest.newBuilder()
           .setParent(LocationName.of("[PROJECT]", "[LOCATION]").toString())
           .setFilter("filter-1274492040")
           .setPageSize(883849137)
           .setPageToken("pageToken873572522")
           .build();
   ApiFuture<Subscription> future =
       analyticsHubServiceClient.listSubscriptionsPagedCallable().futureCall(request);
   // Do something.
   for (Subscription element : future.get().iterateAll()) {
     // doThingsWith(element);
   }
 }
Returns
Type Description
UnaryCallable<ListSubscriptionsRequest,ListSubscriptionsPagedResponse>

refreshSubscriptionAsync(RefreshSubscriptionRequest request)

public final OperationFuture<RefreshSubscriptionResponse,OperationMetadata> refreshSubscriptionAsync(RefreshSubscriptionRequest request)

Refreshes a Subscription to a Data Exchange. A Data Exchange can become stale when a publisher adds or removes data. This is a long-running operation as it may create many linked datasets.

Sample code:


 // 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()) {
   RefreshSubscriptionRequest request =
       RefreshSubscriptionRequest.newBuilder()
           .setName(SubscriptionName.of("[PROJECT]", "[LOCATION]", "[SUBSCRIPTION]").toString())
           .build();
   RefreshSubscriptionResponse response =
       analyticsHubServiceClient.refreshSubscriptionAsync(request).get();
 }
Parameter
Name Description
request RefreshSubscriptionRequest

The request object containing all of the parameters for the API call.
Returns
Type Description
OperationFuture<RefreshSubscriptionResponse,OperationMetadata>

refreshSubscriptionAsync(SubscriptionName name)

public final OperationFuture<RefreshSubscriptionResponse,OperationMetadata> refreshSubscriptionAsync(SubscriptionName name)

Refreshes a Subscription to a Data Exchange. A Data Exchange can become stale when a publisher adds or removes data. This is a long-running operation as it may create many linked datasets.

Sample code:


 // 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()) {
   SubscriptionName name = SubscriptionName.of("[PROJECT]", "[LOCATION]", "[SUBSCRIPTION]");
   RefreshSubscriptionResponse response =
       analyticsHubServiceClient.refreshSubscriptionAsync(name).get();
 }
Parameter
Name Description
name SubscriptionName

Required. Resource name of the Subscription to refresh. e.g. projects/subscriberproject/locations/US/subscriptions/123
Returns
Type Description
OperationFuture<RefreshSubscriptionResponse,OperationMetadata>

refreshSubscriptionAsync(String name)

public final OperationFuture<RefreshSubscriptionResponse,OperationMetadata> refreshSubscriptionAsync(String name)

Refreshes a Subscription to a Data Exchange. A Data Exchange can become stale when a publisher adds or removes data. This is a long-running operation as it may create many linked datasets.

Sample code:


 // 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()) {
   String name = SubscriptionName.of("[PROJECT]", "[LOCATION]", "[SUBSCRIPTION]").toString();
   RefreshSubscriptionResponse response =
       analyticsHubServiceClient.refreshSubscriptionAsync(name).get();
 }
Parameter
Name Description
name String

Required. Resource name of the Subscription to refresh. e.g. projects/subscriberproject/locations/US/subscriptions/123
Returns
Type Description
OperationFuture<RefreshSubscriptionResponse,OperationMetadata>

refreshSubscriptionCallable()

public final UnaryCallable<RefreshSubscriptionRequest,Operation> refreshSubscriptionCallable()

Refreshes a Subscription to a Data Exchange. A Data Exchange can become stale when a publisher adds or removes data. This is a long-running operation as it may create many linked datasets.

Sample code:


 // 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()) {
   RefreshSubscriptionRequest request =
       RefreshSubscriptionRequest.newBuilder()
           .setName(SubscriptionName.of("[PROJECT]", "[LOCATION]", "[SUBSCRIPTION]").toString())
           .build();
   ApiFuture<Operation> future =
       analyticsHubServiceClient.refreshSubscriptionCallable().futureCall(request);
   // Do something.
   Operation response = future.get();
 }
Returns
Type Description
UnaryCallable<RefreshSubscriptionRequest,Operation>

refreshSubscriptionOperationCallable()

public final OperationCallable<RefreshSubscriptionRequest,RefreshSubscriptionResponse,OperationMetadata> refreshSubscriptionOperationCallable()

Refreshes a Subscription to a Data Exchange. A Data Exchange can become stale when a publisher adds or removes data. This is a long-running operation as it may create many linked datasets.

Sample code:


 // 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()) {
   RefreshSubscriptionRequest request =
       RefreshSubscriptionRequest.newBuilder()
           .setName(SubscriptionName.of("[PROJECT]", "[LOCATION]", "[SUBSCRIPTION]").toString())
           .build();
   OperationFuture<RefreshSubscriptionResponse, OperationMetadata> future =
       analyticsHubServiceClient.refreshSubscriptionOperationCallable().futureCall(request);
   // Do something.
   RefreshSubscriptionResponse response = future.get();
 }
Returns
Type Description
OperationCallable<RefreshSubscriptionRequest,RefreshSubscriptionResponse,OperationMetadata>

revokeSubscription(RevokeSubscriptionRequest request)

public final RevokeSubscriptionResponse revokeSubscription(RevokeSubscriptionRequest request)

Revokes a given subscription.

Sample code:


 // 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()) {
   RevokeSubscriptionRequest request =
       RevokeSubscriptionRequest.newBuilder()
           .setName(SubscriptionName.of("[PROJECT]", "[LOCATION]", "[SUBSCRIPTION]").toString())
           .build();
   RevokeSubscriptionResponse response = analyticsHubServiceClient.revokeSubscription(request);
 }
Parameter
Name Description
request RevokeSubscriptionRequest

The request object containing all of the parameters for the API call.
Returns
Type Description
RevokeSubscriptionResponse

revokeSubscription(SubscriptionName name)

public final RevokeSubscriptionResponse revokeSubscription(SubscriptionName name)

Revokes a given subscription.

Sample code:


 // 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()) {
   SubscriptionName name = SubscriptionName.of("[PROJECT]", "[LOCATION]", "[SUBSCRIPTION]");
   RevokeSubscriptionResponse response = analyticsHubServiceClient.revokeSubscription(name);
 }
Parameter
Name Description
name SubscriptionName

Required. Resource name of the subscription to revoke. e.g. projects/123/locations/US/subscriptions/456
Returns
Type Description
RevokeSubscriptionResponse

revokeSubscription(String name)

public final RevokeSubscriptionResponse revokeSubscription(String name)

Revokes a given subscription.

Sample code:


 // 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()) {
   String name = SubscriptionName.of("[PROJECT]", "[LOCATION]", "[SUBSCRIPTION]").toString();
   RevokeSubscriptionResponse response = analyticsHubServiceClient.revokeSubscription(name);
 }
Parameter
Name Description
name String

Required. Resource name of the subscription to revoke. e.g. projects/123/locations/US/subscriptions/456
Returns
Type Description
RevokeSubscriptionResponse

revokeSubscriptionCallable()

public final UnaryCallable<RevokeSubscriptionRequest,RevokeSubscriptionResponse> revokeSubscriptionCallable()

Revokes a given subscription.

Sample code:


 // 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()) {
   RevokeSubscriptionRequest request =
       RevokeSubscriptionRequest.newBuilder()
           .setName(SubscriptionName.of("[PROJECT]", "[LOCATION]", "[SUBSCRIPTION]").toString())
           .build();
   ApiFuture<RevokeSubscriptionResponse> future =
       analyticsHubServiceClient.revokeSubscriptionCallable().futureCall(request);
   // Do something.
   RevokeSubscriptionResponse response = future.get();
 }
Returns
Type Description
UnaryCallable<RevokeSubscriptionRequest,RevokeSubscriptionResponse>

setIamPolicy(SetIamPolicyRequest request)

public final Policy setIamPolicy(SetIamPolicyRequest request)

Sets the IAM policy.

Sample code:


 // 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()) {
   SetIamPolicyRequest request =
       SetIamPolicyRequest.newBuilder()
           .setResource(
               DataExchangeName.of("[PROJECT]", "[LOCATION]", "[DATA_EXCHANGE]").toString())
           .setPolicy(Policy.newBuilder().build())
           .setUpdateMask(FieldMask.newBuilder().build())
           .build();
   Policy response = analyticsHubServiceClient.setIamPolicy(request);
 }
Parameter
Name Description
request com.google.iam.v1.SetIamPolicyRequest

The request object containing all of the parameters for the API call.
Returns
Type Description
com.google.iam.v1.Policy

setIamPolicyCallable()

public final UnaryCallable<SetIamPolicyRequest,Policy> setIamPolicyCallable()

Sets the IAM policy.

Sample code:


 // 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()) {
   SetIamPolicyRequest request =
       SetIamPolicyRequest.newBuilder()
           .setResource(
               DataExchangeName.of("[PROJECT]", "[LOCATION]", "[DATA_EXCHANGE]").toString())
           .setPolicy(Policy.newBuilder().build())
           .setUpdateMask(FieldMask.newBuilder().build())
           .build();
   ApiFuture<Policy> future =
       analyticsHubServiceClient.setIamPolicyCallable().futureCall(request);
   // Do something.
   Policy response = future.get();
 }
Returns
Type Description
UnaryCallable<com.google.iam.v1.SetIamPolicyRequest,com.google.iam.v1.Policy>

shutdown()

public void shutdown()

shutdownNow()

public void shutdownNow()

subscribeDataExchangeAsync(DataExchangeName name)

public final OperationFuture<SubscribeDataExchangeResponse,OperationMetadata> subscribeDataExchangeAsync(DataExchangeName name)

Creates a Subscription to a Data Exchange. This is a long-running operation as it will create one or more linked datasets.

Sample code:


 // 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]");
   SubscribeDataExchangeResponse response =
       analyticsHubServiceClient.subscribeDataExchangeAsync(name).get();
 }
Parameter
Name Description
name DataExchangeName

Required. Resource name of the Data Exchange. e.g. projects/publisherproject/locations/US/dataExchanges/123
Returns
Type Description
OperationFuture<SubscribeDataExchangeResponse,OperationMetadata>

subscribeDataExchangeAsync(SubscribeDataExchangeRequest request)

public final OperationFuture<SubscribeDataExchangeResponse,OperationMetadata> subscribeDataExchangeAsync(SubscribeDataExchangeRequest request)

Creates a Subscription to a Data Exchange. This is a long-running operation as it will create one or more linked datasets.

Sample code:


 // 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()) {
   SubscribeDataExchangeRequest request =
       SubscribeDataExchangeRequest.newBuilder()
           .setName(DataExchangeName.of("[PROJECT]", "[LOCATION]", "[DATA_EXCHANGE]").toString())
           .setDestination(LocationName.of("[PROJECT]", "[LOCATION]").toString())
           .setSubscription("subscription341203229")
           .setSubscriberContact("subscriberContact-847205736")
           .build();
   SubscribeDataExchangeResponse response =
       analyticsHubServiceClient.subscribeDataExchangeAsync(request).get();
 }
Parameter
Name Description
request SubscribeDataExchangeRequest

The request object containing all of the parameters for the API call.
Returns
Type Description
OperationFuture<SubscribeDataExchangeResponse,OperationMetadata>

subscribeDataExchangeAsync(String name)

public final OperationFuture<SubscribeDataExchangeResponse,OperationMetadata> subscribeDataExchangeAsync(String name)

Creates a Subscription to a Data Exchange. This is a long-running operation as it will create one or more linked datasets.

Sample code:


 // 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()) {
   String name = DataExchangeName.of("[PROJECT]", "[LOCATION]", "[DATA_EXCHANGE]").toString();
   SubscribeDataExchangeResponse response =
       analyticsHubServiceClient.subscribeDataExchangeAsync(name).get();
 }
Parameter
Name Description
name String

Required. Resource name of the Data Exchange. e.g. projects/publisherproject/locations/US/dataExchanges/123
Returns
Type Description
OperationFuture<SubscribeDataExchangeResponse,OperationMetadata>

subscribeDataExchangeCallable()

public final UnaryCallable<SubscribeDataExchangeRequest,Operation> subscribeDataExchangeCallable()

Creates a Subscription to a Data Exchange. This is a long-running operation as it will create one or more linked datasets.

Sample code:


 // 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()) {
   SubscribeDataExchangeRequest request =
       SubscribeDataExchangeRequest.newBuilder()
           .setName(DataExchangeName.of("[PROJECT]", "[LOCATION]", "[DATA_EXCHANGE]").toString())
           .setDestination(LocationName.of("[PROJECT]", "[LOCATION]").toString())
           .setSubscription("subscription341203229")
           .setSubscriberContact("subscriberContact-847205736")
           .build();
   ApiFuture<Operation> future =
       analyticsHubServiceClient.subscribeDataExchangeCallable().futureCall(request);
   // Do something.
   Operation response = future.get();
 }
Returns
Type Description
UnaryCallable<SubscribeDataExchangeRequest,Operation>

subscribeDataExchangeOperationCallable()

public final OperationCallable<SubscribeDataExchangeRequest,SubscribeDataExchangeResponse,OperationMetadata> subscribeDataExchangeOperationCallable()

Creates a Subscription to a Data Exchange. This is a long-running operation as it will create one or more linked datasets.

Sample code:


 // 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()) {
   SubscribeDataExchangeRequest request =
       SubscribeDataExchangeRequest.newBuilder()
           .setName(DataExchangeName.of("[PROJECT]", "[LOCATION]", "[DATA_EXCHANGE]").toString())
           .setDestination(LocationName.of("[PROJECT]", "[LOCATION]").toString())
           .setSubscription("subscription341203229")
           .setSubscriberContact("subscriberContact-847205736")
           .build();
   OperationFuture<SubscribeDataExchangeResponse, OperationMetadata> future =
       analyticsHubServiceClient.subscribeDataExchangeOperationCallable().futureCall(request);
   // Do something.
   SubscribeDataExchangeResponse response = future.get();
 }
Returns
Type Description
OperationCallable<SubscribeDataExchangeRequest,SubscribeDataExchangeResponse,OperationMetadata>

subscribeListing(ListingName name)

public final SubscribeListingResponse subscribeListing(ListingName name)

Subscribes to a listing.

Currently, with Analytics Hub, you can create listings that reference only BigQuery datasets. Upon subscription to a listing for a BigQuery dataset, Analytics Hub creates a linked dataset in the subscriber's project.

Sample code:


 // 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()) {
   ListingName name = ListingName.of("[PROJECT]", "[LOCATION]", "[DATA_EXCHANGE]", "[LISTING]");
   SubscribeListingResponse response = analyticsHubServiceClient.subscribeListing(name);
 }
Parameter
Name Description
name ListingName

Required. Resource name of the listing that you want to subscribe to. e.g. projects/myproject/locations/US/dataExchanges/123/listings/456.
Returns
Type Description
SubscribeListingResponse

subscribeListing(SubscribeListingRequest request)

public final SubscribeListingResponse subscribeListing(SubscribeListingRequest request)

Subscribes to a listing.

Currently, with Analytics Hub, you can create listings that reference only BigQuery datasets. Upon subscription to a listing for a BigQuery dataset, Analytics Hub creates a linked dataset in the subscriber's project.

Sample code:


 // 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()) {
   SubscribeListingRequest request =
       SubscribeListingRequest.newBuilder()
           .setName(
               ListingName.of("[PROJECT]", "[LOCATION]", "[DATA_EXCHANGE]", "[LISTING]")
                   .toString())
           .build();
   SubscribeListingResponse response = analyticsHubServiceClient.subscribeListing(request);
 }
Parameter
Name Description
request SubscribeListingRequest

The request object containing all of the parameters for the API call.
Returns
Type Description
SubscribeListingResponse

subscribeListing(String name)

public final SubscribeListingResponse subscribeListing(String name)

Subscribes to a listing.

Currently, with Analytics Hub, you can create listings that reference only BigQuery datasets. Upon subscription to a listing for a BigQuery dataset, Analytics Hub creates a linked dataset in the subscriber's project.

Sample code:


 // 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()) {
   String name =
       ListingName.of("[PROJECT]", "[LOCATION]", "[DATA_EXCHANGE]", "[LISTING]").toString();
   SubscribeListingResponse response = analyticsHubServiceClient.subscribeListing(name);
 }
Parameter
Name Description
name String

Required. Resource name of the listing that you want to subscribe to. e.g. projects/myproject/locations/US/dataExchanges/123/listings/456.
Returns
Type Description
SubscribeListingResponse

subscribeListingCallable()

public final UnaryCallable<SubscribeListingRequest,SubscribeListingResponse> subscribeListingCallable()

Subscribes to a listing.

Currently, with Analytics Hub, you can create listings that reference only BigQuery datasets. Upon subscription to a listing for a BigQuery dataset, Analytics Hub creates a linked dataset in the subscriber's project.

Sample code:


 // 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()) {
   SubscribeListingRequest request =
       SubscribeListingRequest.newBuilder()
           .setName(
               ListingName.of("[PROJECT]", "[LOCATION]", "[DATA_EXCHANGE]", "[LISTING]")
                   .toString())
           .build();
   ApiFuture<SubscribeListingResponse> future =
       analyticsHubServiceClient.subscribeListingCallable().futureCall(request);
   // Do something.
   SubscribeListingResponse response = future.get();
 }
Returns
Type Description
UnaryCallable<SubscribeListingRequest,SubscribeListingResponse>

testIamPermissions(TestIamPermissionsRequest request)

public final TestIamPermissionsResponse testIamPermissions(TestIamPermissionsRequest request)

Returns the permissions that a caller has.

Sample code:


 // 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()) {
   TestIamPermissionsRequest request =
       TestIamPermissionsRequest.newBuilder()
           .setResource(
               DataExchangeName.of("[PROJECT]", "[LOCATION]", "[DATA_EXCHANGE]").toString())
           .addAllPermissions(new ArrayList<String>())
           .build();
   TestIamPermissionsResponse response = analyticsHubServiceClient.testIamPermissions(request);
 }
Parameter
Name Description
request com.google.iam.v1.TestIamPermissionsRequest

The request object containing all of the parameters for the API call.
Returns
Type Description
com.google.iam.v1.TestIamPermissionsResponse

testIamPermissionsCallable()

public final UnaryCallable<TestIamPermissionsRequest,TestIamPermissionsResponse> testIamPermissionsCallable()

Returns the permissions that a caller has.

Sample code:


 // 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()) {
   TestIamPermissionsRequest request =
       TestIamPermissionsRequest.newBuilder()
           .setResource(
               DataExchangeName.of("[PROJECT]", "[LOCATION]", "[DATA_EXCHANGE]").toString())
           .addAllPermissions(new ArrayList<String>())
           .build();
   ApiFuture<TestIamPermissionsResponse> future =
       analyticsHubServiceClient.testIamPermissionsCallable().futureCall(request);
   // Do something.
   TestIamPermissionsResponse response = future.get();
 }
Returns
Type Description
UnaryCallable<com.google.iam.v1.TestIamPermissionsRequest,com.google.iam.v1.TestIamPermissionsResponse>

updateDataExchange(DataExchange dataExchange, FieldMask updateMask)

public final DataExchange updateDataExchange(DataExchange dataExchange, FieldMask updateMask)

Updates an existing data exchange.

Sample code:


 // 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()) {
   DataExchange dataExchange = DataExchange.newBuilder().build();
   FieldMask updateMask = FieldMask.newBuilder().build();
   DataExchange response =
       analyticsHubServiceClient.updateDataExchange(dataExchange, updateMask);
 }
Parameters
Name Description
dataExchange DataExchange

Required. The data exchange to update.
updateMask FieldMask

Required. Field mask specifies the fields to update in the data exchange resource. The fields specified in the updateMask are relative to the resource and are not a full request.
Returns
Type Description
DataExchange

updateDataExchange(UpdateDataExchangeRequest request)

public final DataExchange updateDataExchange(UpdateDataExchangeRequest request)

Updates an existing data exchange.

Sample code:


 // 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()) {
   UpdateDataExchangeRequest request =
       UpdateDataExchangeRequest.newBuilder()
           .setUpdateMask(FieldMask.newBuilder().build())
           .setDataExchange(DataExchange.newBuilder().build())
           .build();
   DataExchange response = analyticsHubServiceClient.updateDataExchange(request);
 }
Parameter
Name Description
request UpdateDataExchangeRequest

The request object containing all of the parameters for the API call.
Returns
Type Description
DataExchange

updateDataExchangeCallable()

public final UnaryCallable<UpdateDataExchangeRequest,DataExchange> updateDataExchangeCallable()

Updates an existing data exchange.

Sample code:


 // 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()) {
   UpdateDataExchangeRequest request =
       UpdateDataExchangeRequest.newBuilder()
           .setUpdateMask(FieldMask.newBuilder().build())
           .setDataExchange(DataExchange.newBuilder().build())
           .build();
   ApiFuture<DataExchange> future =
       analyticsHubServiceClient.updateDataExchangeCallable().futureCall(request);
   // Do something.
   DataExchange response = future.get();
 }
Returns
Type Description
UnaryCallable<UpdateDataExchangeRequest,DataExchange>

updateListing(Listing listing, FieldMask updateMask)

public final Listing updateListing(Listing listing, FieldMask updateMask)

Updates an existing listing.

Sample code:


 // 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()) {
   Listing listing = Listing.newBuilder().build();
   FieldMask updateMask = FieldMask.newBuilder().build();
   Listing response = analyticsHubServiceClient.updateListing(listing, updateMask);
 }
Parameters
Name Description
listing Listing

Required. The listing to update.
updateMask FieldMask

Required. Field mask specifies the fields to update in the listing resource. The fields specified in the updateMask are relative to the resource and are not a full request.
Returns
Type Description
Listing

updateListing(UpdateListingRequest request)

public final Listing updateListing(UpdateListingRequest request)

Updates an existing listing.

Sample code:


 // 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()) {
   UpdateListingRequest request =
       UpdateListingRequest.newBuilder()
           .setUpdateMask(FieldMask.newBuilder().build())
           .setListing(Listing.newBuilder().build())
           .build();
   Listing response = analyticsHubServiceClient.updateListing(request);
 }
Parameter
Name Description
request UpdateListingRequest

The request object containing all of the parameters for the API call.
Returns
Type Description
Listing

updateListingCallable()

public final UnaryCallable<UpdateListingRequest,Listing> updateListingCallable()

Updates an existing listing.

Sample code:


 // 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()) {
   UpdateListingRequest request =
       UpdateListingRequest.newBuilder()
           .setUpdateMask(FieldMask.newBuilder().build())
           .setListing(Listing.newBuilder().build())
           .build();
   ApiFuture<Listing> future =
       analyticsHubServiceClient.updateListingCallable().futureCall(request);
   // Do something.
   Listing response = future.get();
 }
Returns
Type Description
UnaryCallable<UpdateListingRequest,Listing>