Class AnalyticsHubServiceClient (2.26.0)

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.

Equality

Instances of this class created via copy-construction or copy-assignment always compare equal. Instances created with equal std::shared_ptr<*Connection> objects compare equal. Objects that compare equal share the same underlying resources.

Performance

Creating a new instance of this class is a relatively expensive operation, new objects establish new connections to the service. In contrast, copy-construction, move-construction, and the corresponding assignment operations are relatively efficient as the copies share all underlying resources.

Thread Safety

Concurrent access to different instances of this class, even if they compare equal, is guaranteed to work. Two or more threads operating on the same instance of this class is not guaranteed to work. Since copy-construction and move-construction is a relatively efficient operation, consider using such a copy when using this class from multiple threads.

Constructors

AnalyticsHubServiceClient(AnalyticsHubServiceClient const &)

Copy and move support

Parameter
Name	Description
	`AnalyticsHubServiceClient const &`

AnalyticsHubServiceClient(AnalyticsHubServiceClient &&)

Copy and move support

Parameter
Name	Description
	`AnalyticsHubServiceClient &&`

AnalyticsHubServiceClient(std::shared_ptr< AnalyticsHubServiceConnection >, Options)

Parameters
Name	Description
`connection`	`std::shared_ptr< AnalyticsHubServiceConnection >`
`opts`	`Options`

Operators

operator=(AnalyticsHubServiceClient const &)

Copy and move support

Parameter
Name	Description
	`AnalyticsHubServiceClient const &`

Returns
Type	Description
`AnalyticsHubServiceClient &`

operator=(AnalyticsHubServiceClient &&)

Copy and move support

Parameter
Name	Description
	`AnalyticsHubServiceClient &&`

Returns
Type	Description
`AnalyticsHubServiceClient &`

Functions

ListDataExchanges(std::string const &, Options)

Lists all data exchanges in a given project and location.

Parameters
Name	Description
`parent`	`std::string const &` Required. The parent resource path of the data exchanges. e.g. `projects/myproject/locations/US`.
`opts`	`Options` Optional. Override the class-level options, such as retry and backoff policies.

Returns

Type Description

StreamRange< google::cloud::bigquery::analyticshub::v1::DataExchange >

a StreamRange to iterate of the results. See the documentation of this type for details. In brief, this class has begin() and end() member functions returning a iterator class meeting the input iterator requirements. The value type for this iterator is a StatusOr as the iteration may fail even after some values are retrieved successfully, for example, if there is a network disconnect. An empty set of results does not indicate an error, it indicates that there are no resources meeting the request criteria. On a successful iteration the StatusOr<T> contains elements of type google.cloud.bigquery.analyticshub.v1.DataExchange, or rather, the C++ class generated by Protobuf from that type. Please consult the Protobuf documentation for details on the Protobuf mapping rules.

ListDataExchanges(google::cloud::bigquery::analyticshub::v1::ListDataExchangesRequest, Options)

Lists all data exchanges in a given project and location.

Parameters
Name	Description
`request`	`google::cloud::bigquery::analyticshub::v1::ListDataExchangesRequest` Unary RPCs, such as the one wrapped by this function, receive a single `request` proto message which includes all the inputs for the RPC. In this case, the proto message is a google.cloud.bigquery.analyticshub.v1.ListDataExchangesRequest. Proto messages are converted to C++ classes by Protobuf, using the Protobuf mapping rules.
`opts`	`Options` Optional. Override the class-level options, such as retry and backoff policies.

Returns

Type Description

StreamRange< google::cloud::bigquery::analyticshub::v1::DataExchange >

ListOrgDataExchanges(std::string const &, Options)

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

Parameters
Name	Description
`organization`	`std::string const &` Required. The organization resource path of the projects containing DataExchanges. e.g. `organizations/myorg/locations/US`.
`opts`	`Options` Optional. Override the class-level options, such as retry and backoff policies.

Returns

Type Description

StreamRange< google::cloud::bigquery::analyticshub::v1::DataExchange >

ListOrgDataExchanges(google::cloud::bigquery::analyticshub::v1::ListOrgDataExchangesRequest, Options)

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

Parameters
Name	Description
`request`	`google::cloud::bigquery::analyticshub::v1::ListOrgDataExchangesRequest` Unary RPCs, such as the one wrapped by this function, receive a single `request` proto message which includes all the inputs for the RPC. In this case, the proto message is a google.cloud.bigquery.analyticshub.v1.ListOrgDataExchangesRequest. Proto messages are converted to C++ classes by Protobuf, using the Protobuf mapping rules.
`opts`	`Options` Optional. Override the class-level options, such as retry and backoff policies.

Returns

Type Description

StreamRange< google::cloud::bigquery::analyticshub::v1::DataExchange >

GetDataExchange(std::string const &, Options)

Gets the details of a data exchange.

Parameters
Name	Description
`name`	`std::string const &` Required. The resource name of the data exchange. e.g. `projects/myproject/locations/US/dataExchanges/123`.
`opts`	`Options` Optional. Override the class-level options, such as retry and backoff policies.

Returns
Type	Description
`StatusOr< google::cloud::bigquery::analyticshub::v1::DataExchange >`	the result of the RPC. The response message type (google.cloud.bigquery.analyticshub.v1.DataExchange) is mapped to a C++ class using the Protobuf mapping rules. If the request fails, the `StatusOr` contains the error details.

GetDataExchange(google::cloud::bigquery::analyticshub::v1::GetDataExchangeRequest const &, Options)

Gets the details of a data exchange.

Parameters
Name	Description
`request`	`google::cloud::bigquery::analyticshub::v1::GetDataExchangeRequest const &` Unary RPCs, such as the one wrapped by this function, receive a single `request` proto message which includes all the inputs for the RPC. In this case, the proto message is a google.cloud.bigquery.analyticshub.v1.GetDataExchangeRequest. Proto messages are converted to C++ classes by Protobuf, using the Protobuf mapping rules.
`opts`	`Options` Optional. Override the class-level options, such as retry and backoff policies.

Returns
Type	Description
`StatusOr< google::cloud::bigquery::analyticshub::v1::DataExchange >`	the result of the RPC. The response message type (google.cloud.bigquery.analyticshub.v1.DataExchange) is mapped to a C++ class using the Protobuf mapping rules. If the request fails, the `StatusOr` contains the error details.

CreateDataExchange(std::string const &, google::cloud::bigquery::analyticshub::v1::DataExchange const &, Options)

Creates a new data exchange.

Parameters
Name	Description
`parent`	`std::string const &` Required. The parent resource path of the data exchange. e.g. `projects/myproject/locations/US`.
`data_exchange`	`google::cloud::bigquery::analyticshub::v1::DataExchange const &` Required. The data exchange to create.
`opts`	`Options` Optional. Override the class-level options, such as retry and backoff policies.

Returns
Type	Description
`StatusOr< google::cloud::bigquery::analyticshub::v1::DataExchange >`	the result of the RPC. The response message type (google.cloud.bigquery.analyticshub.v1.DataExchange) is mapped to a C++ class using the Protobuf mapping rules. If the request fails, the `StatusOr` contains the error details.

CreateDataExchange(google::cloud::bigquery::analyticshub::v1::CreateDataExchangeRequest const &, Options)

Creates a new data exchange.

Parameters
Name	Description
`request`	`google::cloud::bigquery::analyticshub::v1::CreateDataExchangeRequest const &` Unary RPCs, such as the one wrapped by this function, receive a single `request` proto message which includes all the inputs for the RPC. In this case, the proto message is a google.cloud.bigquery.analyticshub.v1.CreateDataExchangeRequest. Proto messages are converted to C++ classes by Protobuf, using the Protobuf mapping rules.
`opts`	`Options` Optional. Override the class-level options, such as retry and backoff policies.

Returns
Type	Description
`StatusOr< google::cloud::bigquery::analyticshub::v1::DataExchange >`	the result of the RPC. The response message type (google.cloud.bigquery.analyticshub.v1.DataExchange) is mapped to a C++ class using the Protobuf mapping rules. If the request fails, the `StatusOr` contains the error details.

UpdateDataExchange(google::cloud::bigquery::analyticshub::v1::DataExchange const &, google::protobuf::FieldMask const &, Options)

Updates an existing data exchange.

Parameters
Name	Description
`data_exchange`	`google::cloud::bigquery::analyticshub::v1::DataExchange const &` Required. The data exchange to update.
`update_mask`	`google::protobuf::FieldMask const &` 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.
`opts`	`Options` Optional. Override the class-level options, such as retry and backoff policies.

Returns
Type	Description
`StatusOr< google::cloud::bigquery::analyticshub::v1::DataExchange >`	the result of the RPC. The response message type (google.cloud.bigquery.analyticshub.v1.DataExchange) is mapped to a C++ class using the Protobuf mapping rules. If the request fails, the `StatusOr` contains the error details.

UpdateDataExchange(google::cloud::bigquery::analyticshub::v1::UpdateDataExchangeRequest const &, Options)

Updates an existing data exchange.

Parameters
Name	Description
`request`	`google::cloud::bigquery::analyticshub::v1::UpdateDataExchangeRequest const &` Unary RPCs, such as the one wrapped by this function, receive a single `request` proto message which includes all the inputs for the RPC. In this case, the proto message is a google.cloud.bigquery.analyticshub.v1.UpdateDataExchangeRequest. Proto messages are converted to C++ classes by Protobuf, using the Protobuf mapping rules.
`opts`	`Options` Optional. Override the class-level options, such as retry and backoff policies.

Returns
Type	Description
`StatusOr< google::cloud::bigquery::analyticshub::v1::DataExchange >`	the result of the RPC. The response message type (google.cloud.bigquery.analyticshub.v1.DataExchange) is mapped to a C++ class using the Protobuf mapping rules. If the request fails, the `StatusOr` contains the error details.

DeleteDataExchange(std::string const &, Options)

Deletes an existing data exchange.

Parameters
Name	Description
`name`	`std::string const &` Required. The full name of the data exchange resource that you want to delete. For example, `projects/myproject/locations/US/dataExchanges/123`.
`opts`	`Options` Optional. Override the class-level options, such as retry and backoff policies.

Returns
Type	Description
`Status`	a `Status` object. If the request failed, the status contains the details of the failure.

DeleteDataExchange(google::cloud::bigquery::analyticshub::v1::DeleteDataExchangeRequest const &, Options)

Deletes an existing data exchange.

Parameters
Name	Description
`request`	`google::cloud::bigquery::analyticshub::v1::DeleteDataExchangeRequest const &` Unary RPCs, such as the one wrapped by this function, receive a single `request` proto message which includes all the inputs for the RPC. In this case, the proto message is a google.cloud.bigquery.analyticshub.v1.DeleteDataExchangeRequest. Proto messages are converted to C++ classes by Protobuf, using the Protobuf mapping rules.
`opts`	`Options` Optional. Override the class-level options, such as retry and backoff policies.

Returns
Type	Description
`Status`	a `Status` object. If the request failed, the status contains the details of the failure.

ListListings(std::string const &, Options)

Lists all listings in a given project and location.

Parameters
Name	Description
`parent`	`std::string const &` Required. The parent resource path of the listing. e.g. `projects/myproject/locations/US/dataExchanges/123`.
`opts`	`Options` Optional. Override the class-level options, such as retry and backoff policies.

Returns

Type Description

StreamRange< google::cloud::bigquery::analyticshub::v1::Listing >

a StreamRange to iterate of the results. See the documentation of this type for details. In brief, this class has begin() and end() member functions returning a iterator class meeting the input iterator requirements. The value type for this iterator is a StatusOr as the iteration may fail even after some values are retrieved successfully, for example, if there is a network disconnect. An empty set of results does not indicate an error, it indicates that there are no resources meeting the request criteria. On a successful iteration the StatusOr<T> contains elements of type google.cloud.bigquery.analyticshub.v1.Listing, or rather, the C++ class generated by Protobuf from that type. Please consult the Protobuf documentation for details on the Protobuf mapping rules.

ListListings(google::cloud::bigquery::analyticshub::v1::ListListingsRequest, Options)

Lists all listings in a given project and location.

Parameters
Name	Description
`request`	`google::cloud::bigquery::analyticshub::v1::ListListingsRequest` Unary RPCs, such as the one wrapped by this function, receive a single `request` proto message which includes all the inputs for the RPC. In this case, the proto message is a google.cloud.bigquery.analyticshub.v1.ListListingsRequest. Proto messages are converted to C++ classes by Protobuf, using the Protobuf mapping rules.
`opts`	`Options` Optional. Override the class-level options, such as retry and backoff policies.

Returns

Type Description

StreamRange< google::cloud::bigquery::analyticshub::v1::Listing >

a StreamRange to iterate of the results. See the documentation of this type for details. In brief, this class has begin() and end() member functions returning a iterator class meeting the input iterator requirements. The value type for this iterator is a StatusOr as the iteration may fail even after some values are retrieved successfully, for example, if there is a network disconnect. An empty set of results does not indicate an error, it indicates that there are no resources meeting the request criteria. On a successful iteration the StatusOr<T> contains elements of type google.cloud.bigquery.analyticshub.v1.Listing, or rather, the C++ class generated by Protobuf from that type. Please consult the Protobuf documentation for details on the Protobuf mapping rules.

GetListing(std::string const &, Options)

Gets the details of a listing.

Parameters
Name	Description
`name`	`std::string const &` Required. The resource name of the listing. e.g. `projects/myproject/locations/US/dataExchanges/123/listings/456`.
`opts`	`Options` Optional. Override the class-level options, such as retry and backoff policies.

Returns
Type	Description
`StatusOr< google::cloud::bigquery::analyticshub::v1::Listing >`	the result of the RPC. The response message type (google.cloud.bigquery.analyticshub.v1.Listing) is mapped to a C++ class using the Protobuf mapping rules. If the request fails, the `StatusOr` contains the error details.

GetListing(google::cloud::bigquery::analyticshub::v1::GetListingRequest const &, Options)

Gets the details of a listing.

Parameters
Name	Description
`request`	`google::cloud::bigquery::analyticshub::v1::GetListingRequest const &` Unary RPCs, such as the one wrapped by this function, receive a single `request` proto message which includes all the inputs for the RPC. In this case, the proto message is a google.cloud.bigquery.analyticshub.v1.GetListingRequest. Proto messages are converted to C++ classes by Protobuf, using the Protobuf mapping rules.
`opts`	`Options` Optional. Override the class-level options, such as retry and backoff policies.

Returns
Type	Description
`StatusOr< google::cloud::bigquery::analyticshub::v1::Listing >`	the result of the RPC. The response message type (google.cloud.bigquery.analyticshub.v1.Listing) is mapped to a C++ class using the Protobuf mapping rules. If the request fails, the `StatusOr` contains the error details.

CreateListing(std::string const &, google::cloud::bigquery::analyticshub::v1::Listing const &, Options)

Creates a new listing.

Parameters
Name	Description
`parent`	`std::string const &` Required. The parent resource path of the listing. e.g. `projects/myproject/locations/US/dataExchanges/123`.
`listing`	`google::cloud::bigquery::analyticshub::v1::Listing const &` Required. The listing to create.
`opts`	`Options` Optional. Override the class-level options, such as retry and backoff policies.

Returns
Type	Description
`StatusOr< google::cloud::bigquery::analyticshub::v1::Listing >`	the result of the RPC. The response message type (google.cloud.bigquery.analyticshub.v1.Listing) is mapped to a C++ class using the Protobuf mapping rules. If the request fails, the `StatusOr` contains the error details.

CreateListing(google::cloud::bigquery::analyticshub::v1::CreateListingRequest const &, Options)

Creates a new listing.

Parameters
Name	Description
`request`	`google::cloud::bigquery::analyticshub::v1::CreateListingRequest const &` Unary RPCs, such as the one wrapped by this function, receive a single `request` proto message which includes all the inputs for the RPC. In this case, the proto message is a google.cloud.bigquery.analyticshub.v1.CreateListingRequest. Proto messages are converted to C++ classes by Protobuf, using the Protobuf mapping rules.
`opts`	`Options` Optional. Override the class-level options, such as retry and backoff policies.

Returns
Type	Description
`StatusOr< google::cloud::bigquery::analyticshub::v1::Listing >`	the result of the RPC. The response message type (google.cloud.bigquery.analyticshub.v1.Listing) is mapped to a C++ class using the Protobuf mapping rules. If the request fails, the `StatusOr` contains the error details.

UpdateListing(google::cloud::bigquery::analyticshub::v1::Listing const &, google::protobuf::FieldMask const &, Options)

Updates an existing listing.

Parameters
Name	Description
`listing`	`google::cloud::bigquery::analyticshub::v1::Listing const &` Required. The listing to update.
`update_mask`	`google::protobuf::FieldMask const &` 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.
`opts`	`Options` Optional. Override the class-level options, such as retry and backoff policies.

Returns
Type	Description
`StatusOr< google::cloud::bigquery::analyticshub::v1::Listing >`	the result of the RPC. The response message type (google.cloud.bigquery.analyticshub.v1.Listing) is mapped to a C++ class using the Protobuf mapping rules. If the request fails, the `StatusOr` contains the error details.

UpdateListing(google::cloud::bigquery::analyticshub::v1::UpdateListingRequest const &, Options)

Updates an existing listing.

Parameters
Name	Description
`request`	`google::cloud::bigquery::analyticshub::v1::UpdateListingRequest const &` Unary RPCs, such as the one wrapped by this function, receive a single `request` proto message which includes all the inputs for the RPC. In this case, the proto message is a google.cloud.bigquery.analyticshub.v1.UpdateListingRequest. Proto messages are converted to C++ classes by Protobuf, using the Protobuf mapping rules.
`opts`	`Options` Optional. Override the class-level options, such as retry and backoff policies.

Returns
Type	Description
`StatusOr< google::cloud::bigquery::analyticshub::v1::Listing >`	the result of the RPC. The response message type (google.cloud.bigquery.analyticshub.v1.Listing) is mapped to a C++ class using the Protobuf mapping rules. If the request fails, the `StatusOr` contains the error details.

DeleteListing(std::string const &, Options)

Deletes a listing.

Parameters
Name	Description
`name`	`std::string const &` Required. Resource name of the listing to delete. e.g. `projects/myproject/locations/US/dataExchanges/123/listings/456`.
`opts`	`Options` Optional. Override the class-level options, such as retry and backoff policies.

Returns
Type	Description
`Status`	a `Status` object. If the request failed, the status contains the details of the failure.

DeleteListing(google::cloud::bigquery::analyticshub::v1::DeleteListingRequest const &, Options)

Deletes a listing.

Parameters
Name	Description
`request`	`google::cloud::bigquery::analyticshub::v1::DeleteListingRequest const &` Unary RPCs, such as the one wrapped by this function, receive a single `request` proto message which includes all the inputs for the RPC. In this case, the proto message is a google.cloud.bigquery.analyticshub.v1.DeleteListingRequest. Proto messages are converted to C++ classes by Protobuf, using the Protobuf mapping rules.
`opts`	`Options` Optional. Override the class-level options, such as retry and backoff policies.

Returns
Type	Description
`Status`	a `Status` object. If the request failed, the status contains the details of the failure.

SubscribeListing(std::string const &, Options)

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.

Parameters
Name	Description
`name`	`std::string const &` Required. Resource name of the listing that you want to subscribe to. e.g. `projects/myproject/locations/US/dataExchanges/123/listings/456`.
`opts`	`Options` Optional. Override the class-level options, such as retry and backoff policies.

Returns
Type	Description
`StatusOr< google::cloud::bigquery::analyticshub::v1::SubscribeListingResponse >`	the result of the RPC. The response message type (google.cloud.bigquery.analyticshub.v1.SubscribeListingResponse) is mapped to a C++ class using the Protobuf mapping rules. If the request fails, the `StatusOr` contains the error details.

SubscribeListing(google::cloud::bigquery::analyticshub::v1::SubscribeListingRequest const &, Options)

Subscribes to a listing.

Parameters
Name	Description
`request`	`google::cloud::bigquery::analyticshub::v1::SubscribeListingRequest const &` Unary RPCs, such as the one wrapped by this function, receive a single `request` proto message which includes all the inputs for the RPC. In this case, the proto message is a google.cloud.bigquery.analyticshub.v1.SubscribeListingRequest. Proto messages are converted to C++ classes by Protobuf, using the Protobuf mapping rules.
`opts`	`Options` Optional. Override the class-level options, such as retry and backoff policies.

Returns
Type	Description
`StatusOr< google::cloud::bigquery::analyticshub::v1::SubscribeListingResponse >`	the result of the RPC. The response message type (google.cloud.bigquery.analyticshub.v1.SubscribeListingResponse) is mapped to a C++ class using the Protobuf mapping rules. If the request fails, the `StatusOr` contains the error details.

SubscribeDataExchange(std::string const &, Options)

Creates a Subscription to a Data Exchange.

This is a long-running operation as it will create one or more linked datasets.

Parameters
Name	Description
`name`	`std::string const &` Required. Resource name of the Data Exchange. e.g. `projects/publisherproject/locations/US/dataExchanges/123`
`opts`	`Options` Optional. Override the class-level options, such as retry and backoff policies.

Returns

Type Description

future< StatusOr< google::cloud::bigquery::analyticshub::v1::SubscribeDataExchangeResponse > >

A future that becomes satisfied when the LRO (Long Running Operation) completes or the polling policy in effect for this call is exhausted. The future is satisfied with an error if the LRO completes with an error or the polling policy is exhausted. In this case the StatusOr returned by the future contains the error. If the LRO completes successfully the value of the future contains the LRO's result. For this RPC the result is a google.cloud.bigquery.analyticshub.v1.SubscribeDataExchangeResponse proto message. The C++ class representing this message is created by Protobuf, using the Protobuf mapping rules.

SubscribeDataExchange(ExperimentalTag, NoAwaitTag, std::string const &, Options)

Creates a Subscription to a Data Exchange.

Specifying the NoAwaitTag immediately returns the [google::longrunning::Operation] that corresponds to the Long Running Operation that has been started. No polling for operation status occurs.

Parameters
Name	Description
	`ExperimentalTag`
	`NoAwaitTag`
`name`	`std::string const &`
`opts`	`Options`

Returns
Type	Description
`StatusOr< google::longrunning::Operation >`

SubscribeDataExchange(google::cloud::bigquery::analyticshub::v1::SubscribeDataExchangeRequest const &, Options)

Creates a Subscription to a Data Exchange.

This is a long-running operation as it will create one or more linked datasets.

Parameters
Name	Description
`request`	`google::cloud::bigquery::analyticshub::v1::SubscribeDataExchangeRequest const &` Unary RPCs, such as the one wrapped by this function, receive a single `request` proto message which includes all the inputs for the RPC. In this case, the proto message is a google.cloud.bigquery.analyticshub.v1.SubscribeDataExchangeRequest. Proto messages are converted to C++ classes by Protobuf, using the Protobuf mapping rules.
`opts`	`Options` Optional. Override the class-level options, such as retry and backoff policies.

Returns

Type Description

future< StatusOr< google::cloud::bigquery::analyticshub::v1::SubscribeDataExchangeResponse > >

SubscribeDataExchange(ExperimentalTag, NoAwaitTag, google::cloud::bigquery::analyticshub::v1::SubscribeDataExchangeRequest const &, Options)

Creates a Subscription to a Data Exchange.

Specifying the NoAwaitTag immediately returns the [google::longrunning::Operation] that corresponds to the Long Running Operation that has been started. No polling for operation status occurs.

Parameters
Name	Description
	`ExperimentalTag`
	`NoAwaitTag`
`request`	`google::cloud::bigquery::analyticshub::v1::SubscribeDataExchangeRequest const &`
`opts`	`Options`

Returns
Type	Description
`StatusOr< google::longrunning::Operation >`

SubscribeDataExchange(ExperimentalTag, google::longrunning::Operation const &, Options)

Creates a Subscription to a Data Exchange.

This method accepts a google::longrunning::Operation that corresponds to a previously started Long Running Operation (LRO) and polls the status of the LRO in the background.

Parameters
Name	Description
	`ExperimentalTag`
`operation`	`google::longrunning::Operation const &`
`opts`	`Options`

Returns
Type	Description
`future< StatusOr< google::cloud::bigquery::analyticshub::v1::SubscribeDataExchangeResponse > >`

RefreshSubscription(std::string const &, Options)

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.

Parameters
Name	Description
`name`	`std::string const &` Required. Resource name of the Subscription to refresh. e.g. `projects/subscriberproject/locations/US/subscriptions/123`
`opts`	`Options` Optional. Override the class-level options, such as retry and backoff policies.

Returns

Type Description

future< StatusOr< google::cloud::bigquery::analyticshub::v1::RefreshSubscriptionResponse > >

A future that becomes satisfied when the LRO (Long Running Operation) completes or the polling policy in effect for this call is exhausted. The future is satisfied with an error if the LRO completes with an error or the polling policy is exhausted. In this case the StatusOr returned by the future contains the error. If the LRO completes successfully the value of the future contains the LRO's result. For this RPC the result is a google.cloud.bigquery.analyticshub.v1.RefreshSubscriptionResponse proto message. The C++ class representing this message is created by Protobuf, using the Protobuf mapping rules.

RefreshSubscription(ExperimentalTag, NoAwaitTag, std::string const &, Options)

Refreshes a Subscription to a Data Exchange.

Specifying the NoAwaitTag immediately returns the [google::longrunning::Operation] that corresponds to the Long Running Operation that has been started. No polling for operation status occurs.

Parameters
Name	Description
	`ExperimentalTag`
	`NoAwaitTag`
`name`	`std::string const &`
`opts`	`Options`

Returns
Type	Description
`StatusOr< google::longrunning::Operation >`

RefreshSubscription(google::cloud::bigquery::analyticshub::v1::RefreshSubscriptionRequest const &, Options)

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.

Parameters
Name	Description
`request`	`google::cloud::bigquery::analyticshub::v1::RefreshSubscriptionRequest const &` Unary RPCs, such as the one wrapped by this function, receive a single `request` proto message which includes all the inputs for the RPC. In this case, the proto message is a google.cloud.bigquery.analyticshub.v1.RefreshSubscriptionRequest. Proto messages are converted to C++ classes by Protobuf, using the Protobuf mapping rules.
`opts`	`Options` Optional. Override the class-level options, such as retry and backoff policies.

Returns

Type Description

future< StatusOr< google::cloud::bigquery::analyticshub::v1::RefreshSubscriptionResponse > >

A future that becomes satisfied when the LRO (Long Running Operation) completes or the polling policy in effect for this call is exhausted. The future is satisfied with an error if the LRO completes with an error or the polling policy is exhausted. In this case the StatusOr returned by the future contains the error. If the LRO completes successfully the value of the future contains the LRO's result. For this RPC the result is a google.cloud.bigquery.analyticshub.v1.RefreshSubscriptionResponse proto message. The C++ class representing this message is created by Protobuf, using the Protobuf mapping rules.

RefreshSubscription(ExperimentalTag, NoAwaitTag, google::cloud::bigquery::analyticshub::v1::RefreshSubscriptionRequest const &, Options)

Refreshes a Subscription to a Data Exchange.

Specifying the NoAwaitTag immediately returns the [google::longrunning::Operation] that corresponds to the Long Running Operation that has been started. No polling for operation status occurs.

Parameters
Name	Description
	`ExperimentalTag`
	`NoAwaitTag`
`request`	`google::cloud::bigquery::analyticshub::v1::RefreshSubscriptionRequest const &`
`opts`	`Options`

Returns
Type	Description
`StatusOr< google::longrunning::Operation >`

RefreshSubscription(ExperimentalTag, google::longrunning::Operation const &, Options)

Refreshes a Subscription to a Data Exchange.

This method accepts a google::longrunning::Operation that corresponds to a previously started Long Running Operation (LRO) and polls the status of the LRO in the background.

Parameters
Name	Description
	`ExperimentalTag`
`operation`	`google::longrunning::Operation const &`
`opts`	`Options`

Returns
Type	Description
`future< StatusOr< google::cloud::bigquery::analyticshub::v1::RefreshSubscriptionResponse > >`

GetSubscription(std::string const &, Options)

Gets the details of a Subscription.

Parameters
Name	Description
`name`	`std::string const &` Required. Resource name of the subscription. e.g. projects/123/locations/US/subscriptions/456
`opts`	`Options` Optional. Override the class-level options, such as retry and backoff policies.

Returns
Type	Description
`StatusOr< google::cloud::bigquery::analyticshub::v1::Subscription >`	the result of the RPC. The response message type (google.cloud.bigquery.analyticshub.v1.Subscription) is mapped to a C++ class using the Protobuf mapping rules. If the request fails, the `StatusOr` contains the error details.

GetSubscription(google::cloud::bigquery::analyticshub::v1::GetSubscriptionRequest const &, Options)

Gets the details of a Subscription.

Parameters
Name	Description
`request`	`google::cloud::bigquery::analyticshub::v1::GetSubscriptionRequest const &` Unary RPCs, such as the one wrapped by this function, receive a single `request` proto message which includes all the inputs for the RPC. In this case, the proto message is a google.cloud.bigquery.analyticshub.v1.GetSubscriptionRequest. Proto messages are converted to C++ classes by Protobuf, using the Protobuf mapping rules.
`opts`	`Options` Optional. Override the class-level options, such as retry and backoff policies.

Returns
Type	Description
`StatusOr< google::cloud::bigquery::analyticshub::v1::Subscription >`	the result of the RPC. The response message type (google.cloud.bigquery.analyticshub.v1.Subscription) is mapped to a C++ class using the Protobuf mapping rules. If the request fails, the `StatusOr` contains the error details.

ListSubscriptions(std::string const &, Options)

Lists all subscriptions in a given project and location.

Parameters
Name	Description
`parent`	`std::string const &` Required. The parent resource path of the subscription. e.g. projects/myproject/locations/US
`opts`	`Options` Optional. Override the class-level options, such as retry and backoff policies.

Returns

Type Description

StreamRange< google::cloud::bigquery::analyticshub::v1::Subscription >

a StreamRange to iterate of the results. See the documentation of this type for details. In brief, this class has begin() and end() member functions returning a iterator class meeting the input iterator requirements. The value type for this iterator is a StatusOr as the iteration may fail even after some values are retrieved successfully, for example, if there is a network disconnect. An empty set of results does not indicate an error, it indicates that there are no resources meeting the request criteria. On a successful iteration the StatusOr<T> contains elements of type google.cloud.bigquery.analyticshub.v1.Subscription, or rather, the C++ class generated by Protobuf from that type. Please consult the Protobuf documentation for details on the Protobuf mapping rules.

ListSubscriptions(google::cloud::bigquery::analyticshub::v1::ListSubscriptionsRequest, Options)

Lists all subscriptions in a given project and location.

Parameters
Name	Description
`request`	`google::cloud::bigquery::analyticshub::v1::ListSubscriptionsRequest` Unary RPCs, such as the one wrapped by this function, receive a single `request` proto message which includes all the inputs for the RPC. In this case, the proto message is a google.cloud.bigquery.analyticshub.v1.ListSubscriptionsRequest. Proto messages are converted to C++ classes by Protobuf, using the Protobuf mapping rules.
`opts`	`Options` Optional. Override the class-level options, such as retry and backoff policies.

Returns

Type Description

StreamRange< google::cloud::bigquery::analyticshub::v1::Subscription >

a StreamRange to iterate of the results. See the documentation of this type for details. In brief, this class has begin() and end() member functions returning a iterator class meeting the input iterator requirements. The value type for this iterator is a StatusOr as the iteration may fail even after some values are retrieved successfully, for example, if there is a network disconnect. An empty set of results does not indicate an error, it indicates that there are no resources meeting the request criteria. On a successful iteration the StatusOr<T> contains elements of type google.cloud.bigquery.analyticshub.v1.Subscription, or rather, the C++ class generated by Protobuf from that type. Please consult the Protobuf documentation for details on the Protobuf mapping rules.

ListSharedResourceSubscriptions(std::string const &, Options)

Lists all subscriptions on a given Data Exchange or Listing.

Parameters
Name	Description
`resource`	`std::string const &` 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
`opts`	`Options` Optional. Override the class-level options, such as retry and backoff policies.

Returns

Type Description

StreamRange< google::cloud::bigquery::analyticshub::v1::Subscription >

a StreamRange to iterate of the results. See the documentation of this type for details. In brief, this class has begin() and end() member functions returning a iterator class meeting the input iterator requirements. The value type for this iterator is a StatusOr as the iteration may fail even after some values are retrieved successfully, for example, if there is a network disconnect. An empty set of results does not indicate an error, it indicates that there are no resources meeting the request criteria. On a successful iteration the StatusOr<T> contains elements of type google.cloud.bigquery.analyticshub.v1.Subscription, or rather, the C++ class generated by Protobuf from that type. Please consult the Protobuf documentation for details on the Protobuf mapping rules.

ListSharedResourceSubscriptions(google::cloud::bigquery::analyticshub::v1::ListSharedResourceSubscriptionsRequest, Options)

Lists all subscriptions on a given Data Exchange or Listing.

Parameters
Name	Description
`request`	`google::cloud::bigquery::analyticshub::v1::ListSharedResourceSubscriptionsRequest` Unary RPCs, such as the one wrapped by this function, receive a single `request` proto message which includes all the inputs for the RPC. In this case, the proto message is a google.cloud.bigquery.analyticshub.v1.ListSharedResourceSubscriptionsRequest. Proto messages are converted to C++ classes by Protobuf, using the Protobuf mapping rules.
`opts`	`Options` Optional. Override the class-level options, such as retry and backoff policies.

Returns

Type Description

StreamRange< google::cloud::bigquery::analyticshub::v1::Subscription >

a StreamRange to iterate of the results. See the documentation of this type for details. In brief, this class has begin() and end() member functions returning a iterator class meeting the input iterator requirements. The value type for this iterator is a StatusOr as the iteration may fail even after some values are retrieved successfully, for example, if there is a network disconnect. An empty set of results does not indicate an error, it indicates that there are no resources meeting the request criteria. On a successful iteration the StatusOr<T> contains elements of type google.cloud.bigquery.analyticshub.v1.Subscription, or rather, the C++ class generated by Protobuf from that type. Please consult the Protobuf documentation for details on the Protobuf mapping rules.

RevokeSubscription(std::string const &, Options)

Revokes a given subscription.

Parameters
Name	Description
`name`	`std::string const &` Required. Resource name of the subscription to revoke. e.g. projects/123/locations/US/subscriptions/456
`opts`	`Options` Optional. Override the class-level options, such as retry and backoff policies.

Returns
Type	Description
`StatusOr< google::cloud::bigquery::analyticshub::v1::RevokeSubscriptionResponse >`	the result of the RPC. The response message type (google.cloud.bigquery.analyticshub.v1.RevokeSubscriptionResponse) is mapped to a C++ class using the Protobuf mapping rules. If the request fails, the `StatusOr` contains the error details.

RevokeSubscription(google::cloud::bigquery::analyticshub::v1::RevokeSubscriptionRequest const &, Options)

Revokes a given subscription.

Parameters
Name	Description
`request`	`google::cloud::bigquery::analyticshub::v1::RevokeSubscriptionRequest const &` Unary RPCs, such as the one wrapped by this function, receive a single `request` proto message which includes all the inputs for the RPC. In this case, the proto message is a google.cloud.bigquery.analyticshub.v1.RevokeSubscriptionRequest. Proto messages are converted to C++ classes by Protobuf, using the Protobuf mapping rules.
`opts`	`Options` Optional. Override the class-level options, such as retry and backoff policies.

Returns
Type	Description
`StatusOr< google::cloud::bigquery::analyticshub::v1::RevokeSubscriptionResponse >`	the result of the RPC. The response message type (google.cloud.bigquery.analyticshub.v1.RevokeSubscriptionResponse) is mapped to a C++ class using the Protobuf mapping rules. If the request fails, the `StatusOr` contains the error details.

DeleteSubscription(std::string const &, Options)

Deletes a subscription.

Parameters
Name	Description
`name`	`std::string const &` Required. Resource name of the subscription to delete. e.g. projects/123/locations/US/subscriptions/456
`opts`	`Options` Optional. Override the class-level options, such as retry and backoff policies.

Returns

Type Description

future< StatusOr< google::cloud::bigquery::analyticshub::v1::OperationMetadata > >

A future that becomes satisfied when the LRO (Long Running Operation) completes or the polling policy in effect for this call is exhausted. The future is satisfied with an error if the LRO completes with an error or the polling policy is exhausted. In this case the StatusOr returned by the future contains the error. If the LRO completes successfully the value of the future contains the LRO's result. For this RPC the result is a google.cloud.bigquery.analyticshub.v1.OperationMetadata proto message. The C++ class representing this message is created by Protobuf, using the Protobuf mapping rules.

DeleteSubscription(ExperimentalTag, NoAwaitTag, std::string const &, Options)

Deletes a subscription.

Specifying the NoAwaitTag immediately returns the [google::longrunning::Operation] that corresponds to the Long Running Operation that has been started. No polling for operation status occurs.

Parameters
Name	Description
	`ExperimentalTag`
	`NoAwaitTag`
`name`	`std::string const &`
`opts`	`Options`

Returns
Type	Description
`StatusOr< google::longrunning::Operation >`

DeleteSubscription(google::cloud::bigquery::analyticshub::v1::DeleteSubscriptionRequest const &, Options)

Deletes a subscription.

Parameters
Name	Description
`request`	`google::cloud::bigquery::analyticshub::v1::DeleteSubscriptionRequest const &` Unary RPCs, such as the one wrapped by this function, receive a single `request` proto message which includes all the inputs for the RPC. In this case, the proto message is a google.cloud.bigquery.analyticshub.v1.DeleteSubscriptionRequest. Proto messages are converted to C++ classes by Protobuf, using the Protobuf mapping rules.
`opts`	`Options` Optional. Override the class-level options, such as retry and backoff policies.

Returns

Type Description

future< StatusOr< google::cloud::bigquery::analyticshub::v1::OperationMetadata > >

A future that becomes satisfied when the LRO (Long Running Operation) completes or the polling policy in effect for this call is exhausted. The future is satisfied with an error if the LRO completes with an error or the polling policy is exhausted. In this case the StatusOr returned by the future contains the error. If the LRO completes successfully the value of the future contains the LRO's result. For this RPC the result is a google.cloud.bigquery.analyticshub.v1.OperationMetadata proto message. The C++ class representing this message is created by Protobuf, using the Protobuf mapping rules.

DeleteSubscription(ExperimentalTag, NoAwaitTag, google::cloud::bigquery::analyticshub::v1::DeleteSubscriptionRequest const &, Options)

Deletes a subscription.

Specifying the NoAwaitTag immediately returns the [google::longrunning::Operation] that corresponds to the Long Running Operation that has been started. No polling for operation status occurs.

Parameters
Name	Description
	`ExperimentalTag`
	`NoAwaitTag`
`request`	`google::cloud::bigquery::analyticshub::v1::DeleteSubscriptionRequest const &`
`opts`	`Options`

Returns
Type	Description
`StatusOr< google::longrunning::Operation >`

DeleteSubscription(ExperimentalTag, google::longrunning::Operation const &, Options)

Deletes a subscription.

This method accepts a google::longrunning::Operation that corresponds to a previously started Long Running Operation (LRO) and polls the status of the LRO in the background.

Parameters
Name	Description
	`ExperimentalTag`
`operation`	`google::longrunning::Operation const &`
`opts`	`Options`

Returns
Type	Description
`future< StatusOr< google::cloud::bigquery::analyticshub::v1::OperationMetadata > >`

GetIamPolicy(google::iam::v1::GetIamPolicyRequest const &, Options)

Gets the IAM policy.

Parameters
Name	Description
`request`	`google::iam::v1::GetIamPolicyRequest const &` Unary RPCs, such as the one wrapped by this function, receive a single `request` proto message which includes all the inputs for the RPC. In this case, the proto message is a google.iam.v1.GetIamPolicyRequest. Proto messages are converted to C++ classes by Protobuf, using the Protobuf mapping rules.
`opts`	`Options` Optional. Override the class-level options, such as retry and backoff policies.

Returns
Type	Description
`StatusOr< google::iam::v1::Policy >`	the result of the RPC. The response message type (google.iam.v1.Policy) is mapped to a C++ class using the Protobuf mapping rules. If the request fails, the `StatusOr` contains the error details.

SetIamPolicy(google::iam::v1::SetIamPolicyRequest const &, Options)

Sets the IAM policy.

Parameters
Name	Description
`request`	`google::iam::v1::SetIamPolicyRequest const &` Unary RPCs, such as the one wrapped by this function, receive a single `request` proto message which includes all the inputs for the RPC. In this case, the proto message is a google.iam.v1.SetIamPolicyRequest. Proto messages are converted to C++ classes by Protobuf, using the Protobuf mapping rules.
`opts`	`Options` Optional. Override the class-level options, such as retry and backoff policies.

Returns
Type	Description
`StatusOr< google::iam::v1::Policy >`	the result of the RPC. The response message type (google.iam.v1.Policy) is mapped to a C++ class using the Protobuf mapping rules. If the request fails, the `StatusOr` contains the error details.

TestIamPermissions(google::iam::v1::TestIamPermissionsRequest const &, Options)

Returns the permissions that a caller has.

Parameters
Name	Description
`request`	`google::iam::v1::TestIamPermissionsRequest const &` Unary RPCs, such as the one wrapped by this function, receive a single `request` proto message which includes all the inputs for the RPC. In this case, the proto message is a google.iam.v1.TestIamPermissionsRequest. Proto messages are converted to C++ classes by Protobuf, using the Protobuf mapping rules.
`opts`	`Options` Optional. Override the class-level options, such as retry and backoff policies.

Returns
Type	Description
`StatusOr< google::iam::v1::TestIamPermissionsResponse >`	the result of the RPC. The response message type (google.iam.v1.TestIamPermissionsResponse) is mapped to a C++ class using the Protobuf mapping rules. If the request fails, the `StatusOr` contains the error details.