com.google.cloud.bigquery.analyticshub.v1

Class AnalyticsHubServiceClient

java.lang.Object

com.google.cloud.bigquery.analyticshub.v1.AnalyticsHubServiceClient

All Implemented Interfaces:

com.google.api.gax.core.BackgroundResource, AutoCloseable

@Generated(value="by gapic-generator-java")
public class AnalyticsHubServiceClient
extends Object
implements com.google.api.gax.core.BackgroundResource

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 Clean Room. This is a long-running operation as it will create one or more linked datasets. Throws a Bad Request error if the Data Exchange does not contain any listings.	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.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	AnalyticsHubServiceClient.ListDataExchangesFixedSizeCollection
static class	AnalyticsHubServiceClient.ListDataExchangesPage
static class	AnalyticsHubServiceClient.ListDataExchangesPagedResponse
static class	AnalyticsHubServiceClient.ListListingsFixedSizeCollection
static class	AnalyticsHubServiceClient.ListListingsPage
static class	AnalyticsHubServiceClient.ListListingsPagedResponse
static class	AnalyticsHubServiceClient.ListOrgDataExchangesFixedSizeCollection
static class	AnalyticsHubServiceClient.ListOrgDataExchangesPage
static class	AnalyticsHubServiceClient.ListOrgDataExchangesPagedResponse
static class	AnalyticsHubServiceClient.ListSharedResourceSubscriptionsFixedSizeCollection
static class	AnalyticsHubServiceClient.ListSharedResourceSubscriptionsPage
static class	AnalyticsHubServiceClient.ListSharedResourceSubscriptionsPagedResponse
static class	AnalyticsHubServiceClient.ListSubscriptionsFixedSizeCollection
static class	AnalyticsHubServiceClient.ListSubscriptionsPage
static class	AnalyticsHubServiceClient.ListSubscriptionsPagedResponse

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	AnalyticsHubServiceClient(AnalyticsHubServiceSettings settings) Constructs an instance of AnalyticsHubServiceClient, using the given settings.
protected	AnalyticsHubServiceClient(AnalyticsHubServiceStub stub)

Method Summary

Modifier and Type	Method and Description
boolean	awaitTermination(long duration, TimeUnit unit)
void	close()
static AnalyticsHubServiceClient	create() Constructs an instance of AnalyticsHubServiceClient with default settings.
static AnalyticsHubServiceClient	create(AnalyticsHubServiceSettings settings) Constructs an instance of AnalyticsHubServiceClient, using the given settings.
static AnalyticsHubServiceClient	create(AnalyticsHubServiceStub stub) Constructs an instance of AnalyticsHubServiceClient, using the given stub for making calls.
DataExchange	createDataExchange(CreateDataExchangeRequest request) Creates a new data exchange.
DataExchange	createDataExchange(LocationName parent, DataExchange dataExchange) Creates a new data exchange.
DataExchange	createDataExchange(String parent, DataExchange dataExchange) Creates a new data exchange.
com.google.api.gax.rpc.UnaryCallable<CreateDataExchangeRequest,DataExchange>	createDataExchangeCallable() Creates a new data exchange.
Listing	createListing(CreateListingRequest request) Creates a new listing.
Listing	createListing(DataExchangeName parent, Listing listing) Creates a new listing.
Listing	createListing(String parent, Listing listing) Creates a new listing.
com.google.api.gax.rpc.UnaryCallable<CreateListingRequest,Listing>	createListingCallable() Creates a new listing.
void	deleteDataExchange(DataExchangeName name) Deletes an existing data exchange.
void	deleteDataExchange(DeleteDataExchangeRequest request) Deletes an existing data exchange.
void	deleteDataExchange(String name) Deletes an existing data exchange.
com.google.api.gax.rpc.UnaryCallable<DeleteDataExchangeRequest,com.google.protobuf.Empty>	deleteDataExchangeCallable() Deletes an existing data exchange.
void	deleteListing(DeleteListingRequest request) Deletes a listing.
void	deleteListing(ListingName name) Deletes a listing.
void	deleteListing(String name) Deletes a listing.
com.google.api.gax.rpc.UnaryCallable<DeleteListingRequest,com.google.protobuf.Empty>	deleteListingCallable() Deletes a listing.
com.google.api.gax.longrunning.OperationFuture<com.google.protobuf.Empty,OperationMetadata>	deleteSubscriptionAsync(DeleteSubscriptionRequest request) Deletes a subscription.
com.google.api.gax.longrunning.OperationFuture<com.google.protobuf.Empty,OperationMetadata>	deleteSubscriptionAsync(String name) Deletes a subscription.
com.google.api.gax.longrunning.OperationFuture<com.google.protobuf.Empty,OperationMetadata>	deleteSubscriptionAsync(SubscriptionName name) Deletes a subscription.
com.google.api.gax.rpc.UnaryCallable<DeleteSubscriptionRequest,com.google.longrunning.Operation>	deleteSubscriptionCallable() Deletes a subscription.
com.google.api.gax.rpc.OperationCallable<DeleteSubscriptionRequest,com.google.protobuf.Empty,OperationMetadata>	deleteSubscriptionOperationCallable() Deletes a subscription.
DataExchange	getDataExchange(DataExchangeName name) Gets the details of a data exchange.
DataExchange	getDataExchange(GetDataExchangeRequest request) Gets the details of a data exchange.
DataExchange	getDataExchange(String name) Gets the details of a data exchange.
com.google.api.gax.rpc.UnaryCallable<GetDataExchangeRequest,DataExchange>	getDataExchangeCallable() Gets the details of a data exchange.
com.google.api.gax.httpjson.longrunning.OperationsClient	getHttpJsonOperationsClient() Returns the OperationsClient that can be used to query the status of a long-running operation returned by another API method call.
com.google.iam.v1.Policy	getIamPolicy(com.google.iam.v1.GetIamPolicyRequest request) Gets the IAM policy.
com.google.api.gax.rpc.UnaryCallable<com.google.iam.v1.GetIamPolicyRequest,com.google.iam.v1.Policy>	getIamPolicyCallable() Gets the IAM policy.
Listing	getListing(GetListingRequest request) Gets the details of a listing.
Listing	getListing(ListingName name) Gets the details of a listing.
Listing	getListing(String name) Gets the details of a listing.
com.google.api.gax.rpc.UnaryCallable<GetListingRequest,Listing>	getListingCallable() Gets the details of a listing.
com.google.longrunning.OperationsClient	getOperationsClient() Returns the OperationsClient that can be used to query the status of a long-running operation returned by another API method call.
AnalyticsHubServiceSettings	getSettings()
AnalyticsHubServiceStub	getStub()
Subscription	getSubscription(GetSubscriptionRequest request) Gets the details of a Subscription.
Subscription	getSubscription(String name) Gets the details of a Subscription.
Subscription	getSubscription(SubscriptionName name) Gets the details of a Subscription.
com.google.api.gax.rpc.UnaryCallable<GetSubscriptionRequest,Subscription>	getSubscriptionCallable() Gets the details of a Subscription.
boolean	isShutdown()
boolean	isTerminated()
AnalyticsHubServiceClient.ListDataExchangesPagedResponse	listDataExchanges(ListDataExchangesRequest request) Lists all data exchanges in a given project and location.
AnalyticsHubServiceClient.ListDataExchangesPagedResponse	listDataExchanges(LocationName parent) Lists all data exchanges in a given project and location.
AnalyticsHubServiceClient.ListDataExchangesPagedResponse	listDataExchanges(String parent) Lists all data exchanges in a given project and location.
com.google.api.gax.rpc.UnaryCallable<ListDataExchangesRequest,ListDataExchangesResponse>	listDataExchangesCallable() Lists all data exchanges in a given project and location.
com.google.api.gax.rpc.UnaryCallable<ListDataExchangesRequest,AnalyticsHubServiceClient.ListDataExchangesPagedResponse>	listDataExchangesPagedCallable() Lists all data exchanges in a given project and location.
AnalyticsHubServiceClient.ListListingsPagedResponse	listListings(DataExchangeName parent) Lists all listings in a given project and location.
AnalyticsHubServiceClient.ListListingsPagedResponse	listListings(ListListingsRequest request) Lists all listings in a given project and location.
AnalyticsHubServiceClient.ListListingsPagedResponse	listListings(String parent) Lists all listings in a given project and location.
com.google.api.gax.rpc.UnaryCallable<ListListingsRequest,ListListingsResponse>	listListingsCallable() Lists all listings in a given project and location.
com.google.api.gax.rpc.UnaryCallable<ListListingsRequest,AnalyticsHubServiceClient.ListListingsPagedResponse>	listListingsPagedCallable() Lists all listings in a given project and location.
AnalyticsHubServiceClient.ListOrgDataExchangesPagedResponse	listOrgDataExchanges(ListOrgDataExchangesRequest request) Lists all data exchanges from projects in a given organization and location.
AnalyticsHubServiceClient.ListOrgDataExchangesPagedResponse	listOrgDataExchanges(String organization) Lists all data exchanges from projects in a given organization and location.
com.google.api.gax.rpc.UnaryCallable<ListOrgDataExchangesRequest,ListOrgDataExchangesResponse>	listOrgDataExchangesCallable() Lists all data exchanges from projects in a given organization and location.
com.google.api.gax.rpc.UnaryCallable<ListOrgDataExchangesRequest,AnalyticsHubServiceClient.ListOrgDataExchangesPagedResponse>	listOrgDataExchangesPagedCallable() Lists all data exchanges from projects in a given organization and location.
AnalyticsHubServiceClient.ListSharedResourceSubscriptionsPagedResponse	listSharedResourceSubscriptions(ListSharedResourceSubscriptionsRequest request) Lists all subscriptions on a given Data Exchange or Listing.
AnalyticsHubServiceClient.ListSharedResourceSubscriptionsPagedResponse	listSharedResourceSubscriptions(com.google.api.resourcenames.ResourceName resource) Lists all subscriptions on a given Data Exchange or Listing.
AnalyticsHubServiceClient.ListSharedResourceSubscriptionsPagedResponse	listSharedResourceSubscriptions(String resource) Lists all subscriptions on a given Data Exchange or Listing.
com.google.api.gax.rpc.UnaryCallable<ListSharedResourceSubscriptionsRequest,ListSharedResourceSubscriptionsResponse>	listSharedResourceSubscriptionsCallable() Lists all subscriptions on a given Data Exchange or Listing.
com.google.api.gax.rpc.UnaryCallable<ListSharedResourceSubscriptionsRequest,AnalyticsHubServiceClient.ListSharedResourceSubscriptionsPagedResponse>	listSharedResourceSubscriptionsPagedCallable() Lists all subscriptions on a given Data Exchange or Listing.
AnalyticsHubServiceClient.ListSubscriptionsPagedResponse	listSubscriptions(ListSubscriptionsRequest request) Lists all subscriptions in a given project and location.
AnalyticsHubServiceClient.ListSubscriptionsPagedResponse	listSubscriptions(LocationName parent) Lists all subscriptions in a given project and location.
AnalyticsHubServiceClient.ListSubscriptionsPagedResponse	listSubscriptions(String parent) Lists all subscriptions in a given project and location.
com.google.api.gax.rpc.UnaryCallable<ListSubscriptionsRequest,ListSubscriptionsResponse>	listSubscriptionsCallable() Lists all subscriptions in a given project and location.
com.google.api.gax.rpc.UnaryCallable<ListSubscriptionsRequest,AnalyticsHubServiceClient.ListSubscriptionsPagedResponse>	listSubscriptionsPagedCallable() Lists all subscriptions in a given project and location.
com.google.api.gax.longrunning.OperationFuture<RefreshSubscriptionResponse,OperationMetadata>	refreshSubscriptionAsync(RefreshSubscriptionRequest request) Refreshes a Subscription to a Data Exchange.
com.google.api.gax.longrunning.OperationFuture<RefreshSubscriptionResponse,OperationMetadata>	refreshSubscriptionAsync(String name) Refreshes a Subscription to a Data Exchange.
com.google.api.gax.longrunning.OperationFuture<RefreshSubscriptionResponse,OperationMetadata>	refreshSubscriptionAsync(SubscriptionName name) Refreshes a Subscription to a Data Exchange.
com.google.api.gax.rpc.UnaryCallable<RefreshSubscriptionRequest,com.google.longrunning.Operation>	refreshSubscriptionCallable() Refreshes a Subscription to a Data Exchange.
com.google.api.gax.rpc.OperationCallable<RefreshSubscriptionRequest,RefreshSubscriptionResponse,OperationMetadata>	refreshSubscriptionOperationCallable() Refreshes a Subscription to a Data Exchange.
RevokeSubscriptionResponse	revokeSubscription(RevokeSubscriptionRequest request) Revokes a given subscription.
RevokeSubscriptionResponse	revokeSubscription(String name) Revokes a given subscription.
RevokeSubscriptionResponse	revokeSubscription(SubscriptionName name) Revokes a given subscription.
com.google.api.gax.rpc.UnaryCallable<RevokeSubscriptionRequest,RevokeSubscriptionResponse>	revokeSubscriptionCallable() Revokes a given subscription.
com.google.iam.v1.Policy	setIamPolicy(com.google.iam.v1.SetIamPolicyRequest request) Sets the IAM policy.
com.google.api.gax.rpc.UnaryCallable<com.google.iam.v1.SetIamPolicyRequest,com.google.iam.v1.Policy>	setIamPolicyCallable() Sets the IAM policy.
void	shutdown()
void	shutdownNow()
com.google.api.gax.longrunning.OperationFuture<SubscribeDataExchangeResponse,OperationMetadata>	subscribeDataExchangeAsync(DataExchangeName name) Creates a Subscription to a Data Clean Room.
com.google.api.gax.longrunning.OperationFuture<SubscribeDataExchangeResponse,OperationMetadata>	subscribeDataExchangeAsync(String name) Creates a Subscription to a Data Clean Room.
com.google.api.gax.longrunning.OperationFuture<SubscribeDataExchangeResponse,OperationMetadata>	subscribeDataExchangeAsync(SubscribeDataExchangeRequest request) Creates a Subscription to a Data Clean Room.
com.google.api.gax.rpc.UnaryCallable<SubscribeDataExchangeRequest,com.google.longrunning.Operation>	subscribeDataExchangeCallable() Creates a Subscription to a Data Clean Room.
com.google.api.gax.rpc.OperationCallable<SubscribeDataExchangeRequest,SubscribeDataExchangeResponse,OperationMetadata>	subscribeDataExchangeOperationCallable() Creates a Subscription to a Data Clean Room.
SubscribeListingResponse	subscribeListing(ListingName name) Subscribes to a listing.
SubscribeListingResponse	subscribeListing(String name) Subscribes to a listing.
SubscribeListingResponse	subscribeListing(SubscribeListingRequest request) Subscribes to a listing.
com.google.api.gax.rpc.UnaryCallable<SubscribeListingRequest,SubscribeListingResponse>	subscribeListingCallable() Subscribes to a listing.
com.google.iam.v1.TestIamPermissionsResponse	testIamPermissions(com.google.iam.v1.TestIamPermissionsRequest request) Returns the permissions that a caller has.
com.google.api.gax.rpc.UnaryCallable<com.google.iam.v1.TestIamPermissionsRequest,com.google.iam.v1.TestIamPermissionsResponse>	testIamPermissionsCallable() Returns the permissions that a caller has.
DataExchange	updateDataExchange(DataExchange dataExchange, com.google.protobuf.FieldMask updateMask) Updates an existing data exchange.
DataExchange	updateDataExchange(UpdateDataExchangeRequest request) Updates an existing data exchange.
com.google.api.gax.rpc.UnaryCallable<UpdateDataExchangeRequest,DataExchange>	updateDataExchangeCallable() Updates an existing data exchange.
Listing	updateListing(Listing listing, com.google.protobuf.FieldMask updateMask) Updates an existing listing.
Listing	updateListing(UpdateListingRequest request) Updates an existing listing.
com.google.api.gax.rpc.UnaryCallable<UpdateListingRequest,Listing>	updateListingCallable() Updates an existing listing.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

AnalyticsHubServiceClient

protected AnalyticsHubServiceClient(AnalyticsHubServiceSettings settings)
                             throws IOException

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.

Throws:

IOException

AnalyticsHubServiceClient

protected AnalyticsHubServiceClient(AnalyticsHubServiceStub stub)

Method Detail

create

public static final AnalyticsHubServiceClient create()
                                              throws IOException

Constructs an instance of AnalyticsHubServiceClient with default settings.

Throws:

IOException

create

public static final AnalyticsHubServiceClient create(AnalyticsHubServiceSettings settings)
                                              throws IOException

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.

Throws:

IOException

create

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

getSettings

public final AnalyticsHubServiceSettings getSettings()

getStub

public AnalyticsHubServiceStub getStub()

getOperationsClient

public final com.google.longrunning.OperationsClient getOperationsClient()

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

getHttpJsonOperationsClient

@BetaApi
public final com.google.api.gax.httpjson.longrunning.OperationsClient getHttpJsonOperationsClient()

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

listDataExchanges

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);
   }
 }
 

Parameters:

parent - Required. The parent resource path of the data exchanges. e.g. `projects/myproject/locations/us`.

Throws:

com.google.api.gax.rpc.ApiException - if the remote call fails

listDataExchanges

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);
   }
 }
 

Parameters:

parent - Required. The parent resource path of the data exchanges. e.g. `projects/myproject/locations/us`.

Throws:

com.google.api.gax.rpc.ApiException - if the remote call fails

listDataExchanges

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);
   }
 }
 

Parameters:

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

Throws:

com.google.api.gax.rpc.ApiException - if the remote call fails

listDataExchangesPagedCallable

public final com.google.api.gax.rpc.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);
   }
 }
 

listDataExchangesCallable

public final com.google.api.gax.rpc.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;
     }
   }
 }
 

listOrgDataExchanges

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);
   }
 }
 

Parameters:

organization - Required. The organization resource path of the projects containing DataExchanges. e.g. `organizations/myorg/locations/us`.

Throws:

com.google.api.gax.rpc.ApiException - if the remote call fails

listOrgDataExchanges

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);
   }
 }
 

Parameters:

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

Throws:

com.google.api.gax.rpc.ApiException - if the remote call fails

listOrgDataExchangesPagedCallable

public final com.google.api.gax.rpc.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);
   }
 }
 

listOrgDataExchangesCallable

public final com.google.api.gax.rpc.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;
     }
   }
 }
 

getDataExchange

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);
 }
 

Parameters:

name - Required. The resource name of the data exchange. e.g. `projects/myproject/locations/us/dataExchanges/123`.

Throws:

com.google.api.gax.rpc.ApiException - if the remote call fails

getDataExchange

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);
 }
 

Parameters:

name - Required. The resource name of the data exchange. e.g. `projects/myproject/locations/us/dataExchanges/123`.

Throws:

com.google.api.gax.rpc.ApiException - if the remote call fails

getDataExchange

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);
 }
 

Parameters:

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

Throws:

com.google.api.gax.rpc.ApiException - if the remote call fails

getDataExchangeCallable

public final com.google.api.gax.rpc.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();
 }
 

createDataExchange

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:

parent - Required. The parent resource path of the data exchange. e.g. `projects/myproject/locations/us`.

dataExchange - Required. The data exchange to create.

Throws:

com.google.api.gax.rpc.ApiException - if the remote call fails

createDataExchange

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:

parent - Required. The parent resource path of the data exchange. e.g. `projects/myproject/locations/us`.

dataExchange - Required. The data exchange to create.

Throws:

com.google.api.gax.rpc.ApiException - if the remote call fails

createDataExchange

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);
 }
 

Parameters:

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

Throws:

com.google.api.gax.rpc.ApiException - if the remote call fails

createDataExchangeCallable

public final com.google.api.gax.rpc.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();
 }
 

updateDataExchange

public final DataExchange updateDataExchange(DataExchange dataExchange,
                                             com.google.protobuf.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:

dataExchange - Required. The data exchange to update.

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

Throws:

com.google.api.gax.rpc.ApiException - if the remote call fails

updateDataExchange

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);
 }
 

Parameters:

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

Throws:

com.google.api.gax.rpc.ApiException - if the remote call fails

updateDataExchangeCallable

public final com.google.api.gax.rpc.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();
 }
 

deleteDataExchange

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);
 }
 

Parameters:

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

Throws:

com.google.api.gax.rpc.ApiException - if the remote call fails

deleteDataExchange

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);
 }
 

Parameters:

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

Throws:

com.google.api.gax.rpc.ApiException - if the remote call fails

deleteDataExchange

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);
 }
 

Parameters:

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

Throws:

com.google.api.gax.rpc.ApiException - if the remote call fails

deleteDataExchangeCallable

public final com.google.api.gax.rpc.UnaryCallable<DeleteDataExchangeRequest,com.google.protobuf.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();
 }
 

listListings

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);
   }
 }
 

Parameters:

parent - Required. The parent resource path of the listing. e.g. `projects/myproject/locations/us/dataExchanges/123`.

Throws:

com.google.api.gax.rpc.ApiException - if the remote call fails

listListings

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);
   }
 }
 

Parameters:

parent - Required. The parent resource path of the listing. e.g. `projects/myproject/locations/us/dataExchanges/123`.

Throws:

com.google.api.gax.rpc.ApiException - if the remote call fails

listListings

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);
   }
 }
 

Parameters:

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

Throws:

com.google.api.gax.rpc.ApiException - if the remote call fails

listListingsPagedCallable

public final com.google.api.gax.rpc.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);
   }
 }
 

listListingsCallable

public final com.google.api.gax.rpc.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;
     }
   }
 }
 

getListing

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);
 }
 

Parameters:

name - Required. The resource name of the listing. e.g. `projects/myproject/locations/us/dataExchanges/123/listings/456`.

Throws:

com.google.api.gax.rpc.ApiException - if the remote call fails

getListing

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);
 }
 

Parameters:

name - Required. The resource name of the listing. e.g. `projects/myproject/locations/us/dataExchanges/123/listings/456`.

Throws:

com.google.api.gax.rpc.ApiException - if the remote call fails

getListing

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);
 }
 

Parameters:

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

Throws:

com.google.api.gax.rpc.ApiException - if the remote call fails

getListingCallable

public final com.google.api.gax.rpc.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();
 }
 

createListing

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:

parent - Required. The parent resource path of the listing. e.g. `projects/myproject/locations/us/dataExchanges/123`.

listing - Required. The listing to create.

Throws:

com.google.api.gax.rpc.ApiException - if the remote call fails

createListing

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:

parent - Required. The parent resource path of the listing. e.g. `projects/myproject/locations/us/dataExchanges/123`.

listing - Required. The listing to create.

Throws:

com.google.api.gax.rpc.ApiException - if the remote call fails

createListing

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);
 }
 

Parameters:

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

Throws:

com.google.api.gax.rpc.ApiException - if the remote call fails

createListingCallable

public final com.google.api.gax.rpc.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();
 }
 

updateListing

public final Listing updateListing(Listing listing,
                                   com.google.protobuf.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:

listing - Required. The listing to update.

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

Throws:

com.google.api.gax.rpc.ApiException - if the remote call fails

updateListing

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);
 }
 

Parameters:

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

Throws:

com.google.api.gax.rpc.ApiException - if the remote call fails

updateListingCallable

public final com.google.api.gax.rpc.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();
 }
 

deleteListing

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);
 }
 

Parameters:

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

Throws:

com.google.api.gax.rpc.ApiException - if the remote call fails

deleteListing

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);
 }
 

Parameters:

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

Throws:

com.google.api.gax.rpc.ApiException - if the remote call fails

deleteListing

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())
           .setDeleteCommercial(true)
           .build();
   analyticsHubServiceClient.deleteListing(request);
 }
 

Parameters:

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

Throws:

com.google.api.gax.rpc.ApiException - if the remote call fails

deleteListingCallable

public final com.google.api.gax.rpc.UnaryCallable<DeleteListingRequest,com.google.protobuf.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())
           .setDeleteCommercial(true)
           .build();
   ApiFuture<Empty> future =
       analyticsHubServiceClient.deleteListingCallable().futureCall(request);
   // Do something.
   future.get();
 }
 

subscribeListing

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);
 }
 

Parameters:

name - Required. Resource name of the listing that you want to subscribe to. e.g. `projects/myproject/locations/us/dataExchanges/123/listings/456`.

Throws:

com.google.api.gax.rpc.ApiException - if the remote call fails

subscribeListing

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);
 }
 

Parameters:

name - Required. Resource name of the listing that you want to subscribe to. e.g. `projects/myproject/locations/us/dataExchanges/123/listings/456`.

Throws:

com.google.api.gax.rpc.ApiException - if the remote call fails

subscribeListing

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);
 }
 

Parameters:

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

Throws:

com.google.api.gax.rpc.ApiException - if the remote call fails

subscribeListingCallable

public final com.google.api.gax.rpc.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();
 }
 

subscribeDataExchangeAsync

public final com.google.api.gax.longrunning.OperationFuture<SubscribeDataExchangeResponse,OperationMetadata> subscribeDataExchangeAsync(DataExchangeName name)

Creates a Subscription to a Data Clean Room. This is a long-running operation as it will create one or more linked datasets. Throws a Bad Request error if the Data Exchange does not contain any listings.

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();
 }
 

Parameters:

name - Required. Resource name of the Data Exchange. e.g. `projects/publisherproject/locations/us/dataExchanges/123`

Throws:

com.google.api.gax.rpc.ApiException - if the remote call fails

subscribeDataExchangeAsync

public final com.google.api.gax.longrunning.OperationFuture<SubscribeDataExchangeResponse,OperationMetadata> subscribeDataExchangeAsync(String name)

Creates a Subscription to a Data Clean Room. This is a long-running operation as it will create one or more linked datasets. Throws a Bad Request error if the Data Exchange does not contain any listings.

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();
 }
 

Parameters:

name - Required. Resource name of the Data Exchange. e.g. `projects/publisherproject/locations/us/dataExchanges/123`

Throws:

com.google.api.gax.rpc.ApiException - if the remote call fails

subscribeDataExchangeAsync

public final com.google.api.gax.longrunning.OperationFuture<SubscribeDataExchangeResponse,OperationMetadata> subscribeDataExchangeAsync(SubscribeDataExchangeRequest request)

Creates a Subscription to a Data Clean Room. This is a long-running operation as it will create one or more linked datasets. Throws a Bad Request error if the Data Exchange does not contain any listings.

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())
           .setDestinationDataset(DestinationDataset.newBuilder().build())
           .setSubscription("subscription341203229")
           .setSubscriberContact("subscriberContact-847205736")
           .build();
   SubscribeDataExchangeResponse response =
       analyticsHubServiceClient.subscribeDataExchangeAsync(request).get();
 }
 

Parameters:

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

Throws:

com.google.api.gax.rpc.ApiException - if the remote call fails

subscribeDataExchangeOperationCallable

public final com.google.api.gax.rpc.OperationCallable<SubscribeDataExchangeRequest,SubscribeDataExchangeResponse,OperationMetadata> subscribeDataExchangeOperationCallable()

Creates a Subscription to a Data Clean Room. This is a long-running operation as it will create one or more linked datasets. Throws a Bad Request error if the Data Exchange does not contain any listings.

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())
           .setDestinationDataset(DestinationDataset.newBuilder().build())
           .setSubscription("subscription341203229")
           .setSubscriberContact("subscriberContact-847205736")
           .build();
   OperationFuture<SubscribeDataExchangeResponse, OperationMetadata> future =
       analyticsHubServiceClient.subscribeDataExchangeOperationCallable().futureCall(request);
   // Do something.
   SubscribeDataExchangeResponse response = future.get();
 }
 

subscribeDataExchangeCallable

public final com.google.api.gax.rpc.UnaryCallable<SubscribeDataExchangeRequest,com.google.longrunning.Operation> subscribeDataExchangeCallable()

Creates a Subscription to a Data Clean Room. This is a long-running operation as it will create one or more linked datasets. Throws a Bad Request error if the Data Exchange does not contain any listings.

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())
           .setDestinationDataset(DestinationDataset.newBuilder().build())
           .setSubscription("subscription341203229")
           .setSubscriberContact("subscriberContact-847205736")
           .build();
   ApiFuture<Operation> future =
       analyticsHubServiceClient.subscribeDataExchangeCallable().futureCall(request);
   // Do something.
   Operation response = future.get();
 }
 

refreshSubscriptionAsync

public final com.google.api.gax.longrunning.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();
 }
 

Parameters:

name - Required. Resource name of the Subscription to refresh. e.g. `projects/subscriberproject/locations/us/subscriptions/123`

Throws:

com.google.api.gax.rpc.ApiException - if the remote call fails

refreshSubscriptionAsync

public final com.google.api.gax.longrunning.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();
 }
 

Parameters:

name - Required. Resource name of the Subscription to refresh. e.g. `projects/subscriberproject/locations/us/subscriptions/123`

Throws:

com.google.api.gax.rpc.ApiException - if the remote call fails

refreshSubscriptionAsync

public final com.google.api.gax.longrunning.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();
 }
 

Parameters:

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

Throws:

com.google.api.gax.rpc.ApiException - if the remote call fails

refreshSubscriptionOperationCallable

public final com.google.api.gax.rpc.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();
 }
 

refreshSubscriptionCallable

public final com.google.api.gax.rpc.UnaryCallable<RefreshSubscriptionRequest,com.google.longrunning.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();
 }
 

getSubscription

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);
 }
 

Parameters:

name - Required. Resource name of the subscription. e.g. projects/123/locations/us/subscriptions/456

Throws:

com.google.api.gax.rpc.ApiException - if the remote call fails

getSubscription

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);
 }
 

Parameters:

name - Required. Resource name of the subscription. e.g. projects/123/locations/us/subscriptions/456

Throws:

com.google.api.gax.rpc.ApiException - if the remote call fails

getSubscription

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);
 }
 

Parameters:

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

Throws:

com.google.api.gax.rpc.ApiException - if the remote call fails

getSubscriptionCallable

public final com.google.api.gax.rpc.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();
 }
 

listSubscriptions

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);
   }
 }
 

Parameters:

parent - Required. The parent resource path of the subscription. e.g. projects/myproject/locations/us

Throws:

com.google.api.gax.rpc.ApiException - if the remote call fails

listSubscriptions

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);
   }
 }
 

Parameters:

parent - Required. The parent resource path of the subscription. e.g. projects/myproject/locations/us

Throws:

com.google.api.gax.rpc.ApiException - if the remote call fails

listSubscriptions

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);
   }
 }
 

Parameters:

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

Throws:

com.google.api.gax.rpc.ApiException - if the remote call fails

listSubscriptionsPagedCallable

public final com.google.api.gax.rpc.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);
   }
 }
 

listSubscriptionsCallable

public final com.google.api.gax.rpc.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;
     }
   }
 }
 

listSharedResourceSubscriptions

public final AnalyticsHubServiceClient.ListSharedResourceSubscriptionsPagedResponse listSharedResourceSubscriptions(com.google.api.resourcenames.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);
   }
 }
 

Parameters:

resource - 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

Throws:

com.google.api.gax.rpc.ApiException - if the remote call fails

listSharedResourceSubscriptions

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);
   }
 }
 

Parameters:

resource - 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

Throws:

com.google.api.gax.rpc.ApiException - if the remote call fails

listSharedResourceSubscriptions

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);
   }
 }
 

Parameters:

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

Throws:

com.google.api.gax.rpc.ApiException - if the remote call fails

listSharedResourceSubscriptionsPagedCallable

public final com.google.api.gax.rpc.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);
   }
 }
 

listSharedResourceSubscriptionsCallable

public final com.google.api.gax.rpc.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;
     }
   }
 }
 

revokeSubscription

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);
 }
 

Parameters:

name - Required. Resource name of the subscription to revoke. e.g. projects/123/locations/us/subscriptions/456

Throws:

com.google.api.gax.rpc.ApiException - if the remote call fails

revokeSubscription

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);
 }
 

Parameters:

name - Required. Resource name of the subscription to revoke. e.g. projects/123/locations/us/subscriptions/456

Throws:

com.google.api.gax.rpc.ApiException - if the remote call fails

revokeSubscription

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())
           .setRevokeCommercial(true)
           .build();
   RevokeSubscriptionResponse response = analyticsHubServiceClient.revokeSubscription(request);
 }
 

Parameters:

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

Throws:

com.google.api.gax.rpc.ApiException - if the remote call fails

revokeSubscriptionCallable

public final com.google.api.gax.rpc.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())
           .setRevokeCommercial(true)
           .build();
   ApiFuture<RevokeSubscriptionResponse> future =
       analyticsHubServiceClient.revokeSubscriptionCallable().futureCall(request);
   // Do something.
   RevokeSubscriptionResponse response = future.get();
 }
 

deleteSubscriptionAsync

public final com.google.api.gax.longrunning.OperationFuture<com.google.protobuf.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();
 }
 

Parameters:

name - Required. Resource name of the subscription to delete. e.g. projects/123/locations/us/subscriptions/456

Throws:

com.google.api.gax.rpc.ApiException - if the remote call fails

deleteSubscriptionAsync

public final com.google.api.gax.longrunning.OperationFuture<com.google.protobuf.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();
 }
 

Parameters:

name - Required. Resource name of the subscription to delete. e.g. projects/123/locations/us/subscriptions/456

Throws:

com.google.api.gax.rpc.ApiException - if the remote call fails

deleteSubscriptionAsync

public final com.google.api.gax.longrunning.OperationFuture<com.google.protobuf.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();
 }
 

Parameters:

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

Throws:

com.google.api.gax.rpc.ApiException - if the remote call fails

deleteSubscriptionOperationCallable

public final com.google.api.gax.rpc.OperationCallable<DeleteSubscriptionRequest,com.google.protobuf.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();
 }
 

deleteSubscriptionCallable

public final com.google.api.gax.rpc.UnaryCallable<DeleteSubscriptionRequest,com.google.longrunning.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();
 }
 

getIamPolicy

public final com.google.iam.v1.Policy getIamPolicy(com.google.iam.v1.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);
 }
 

Parameters:

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

Throws:

com.google.api.gax.rpc.ApiException - if the remote call fails

getIamPolicyCallable

public final com.google.api.gax.rpc.UnaryCallable<com.google.iam.v1.GetIamPolicyRequest,com.google.iam.v1.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();
 }
 

setIamPolicy

public final com.google.iam.v1.Policy setIamPolicy(com.google.iam.v1.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);
 }
 

Parameters:

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

Throws:

com.google.api.gax.rpc.ApiException - if the remote call fails

setIamPolicyCallable

public final com.google.api.gax.rpc.UnaryCallable<com.google.iam.v1.SetIamPolicyRequest,com.google.iam.v1.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();
 }
 

testIamPermissions

public final com.google.iam.v1.TestIamPermissionsResponse testIamPermissions(com.google.iam.v1.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);
 }
 

Parameters:

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

Throws:

com.google.api.gax.rpc.ApiException - if the remote call fails

testIamPermissionsCallable

public final com.google.api.gax.rpc.UnaryCallable<com.google.iam.v1.TestIamPermissionsRequest,com.google.iam.v1.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();
 }
 

close

public final void close()

Specified by:

close in interface AutoCloseable

shutdown

public void shutdown()

Specified by:

shutdown in interface com.google.api.gax.core.BackgroundResource

isShutdown

public boolean isShutdown()

Specified by:

isShutdown in interface com.google.api.gax.core.BackgroundResource

isTerminated

public boolean isTerminated()

Specified by:

isTerminated in interface com.google.api.gax.core.BackgroundResource

shutdownNow

public void shutdownNow()

Specified by:

shutdownNow in interface com.google.api.gax.core.BackgroundResource

awaitTermination

public boolean awaitTermination(long duration,
                                TimeUnit unit)
                         throws InterruptedException

Specified by:

awaitTermination in interface com.google.api.gax.core.BackgroundResource

Throws:

InterruptedException