google::cloud::bigquery_analyticshub_v1::AnalyticsHubServiceClient Class Reference

The AnalyticsHubService API facilitates data sharing within and across organizations. More...

#include <google/cloud/bigquery/analyticshub/v1/analytics_hub_client.h>

Public Member Functions
	AnalyticsHubServiceClient (std::shared_ptr< AnalyticsHubServiceConnection > connection, Options opts={})
	~AnalyticsHubServiceClient ()
StreamRange< google::cloud::bigquery::analyticshub::v1::DataExchange >	ListDataExchanges (std::string const &parent, Options opts={})
	Lists all data exchanges in a given project and location. More...
StreamRange< google::cloud::bigquery::analyticshub::v1::DataExchange >	ListDataExchanges (google::cloud::bigquery::analyticshub::v1::ListDataExchangesRequest request, Options opts={})
	Lists all data exchanges in a given project and location. More...
StreamRange< google::cloud::bigquery::analyticshub::v1::DataExchange >	ListOrgDataExchanges (std::string const &organization, Options opts={})
	Lists all data exchanges from projects in a given organization and location. More...
StreamRange< google::cloud::bigquery::analyticshub::v1::DataExchange >	ListOrgDataExchanges (google::cloud::bigquery::analyticshub::v1::ListOrgDataExchangesRequest request, Options opts={})
	Lists all data exchanges from projects in a given organization and location. More...
StatusOr< google::cloud::bigquery::analyticshub::v1::DataExchange >	GetDataExchange (std::string const &name, Options opts={})
	Gets the details of a data exchange. More...
StatusOr< google::cloud::bigquery::analyticshub::v1::DataExchange >	GetDataExchange (google::cloud::bigquery::analyticshub::v1::GetDataExchangeRequest const &request, Options opts={})
	Gets the details of a data exchange. More...
StatusOr< google::cloud::bigquery::analyticshub::v1::DataExchange >	CreateDataExchange (std::string const &parent, google::cloud::bigquery::analyticshub::v1::DataExchange const &data_exchange, Options opts={})
	Creates a new data exchange. More...
StatusOr< google::cloud::bigquery::analyticshub::v1::DataExchange >	CreateDataExchange (google::cloud::bigquery::analyticshub::v1::CreateDataExchangeRequest const &request, Options opts={})
	Creates a new data exchange. More...
StatusOr< google::cloud::bigquery::analyticshub::v1::DataExchange >	UpdateDataExchange (google::cloud::bigquery::analyticshub::v1::DataExchange const &data_exchange, google::protobuf::FieldMask const &update_mask, Options opts={})
	Updates an existing data exchange. More...
StatusOr< google::cloud::bigquery::analyticshub::v1::DataExchange >	UpdateDataExchange (google::cloud::bigquery::analyticshub::v1::UpdateDataExchangeRequest const &request, Options opts={})
	Updates an existing data exchange. More...
Status	DeleteDataExchange (std::string const &name, Options opts={})
	Deletes an existing data exchange. More...
Status	DeleteDataExchange (google::cloud::bigquery::analyticshub::v1::DeleteDataExchangeRequest const &request, Options opts={})
	Deletes an existing data exchange. More...
StreamRange< google::cloud::bigquery::analyticshub::v1::Listing >	ListListings (std::string const &parent, Options opts={})
	Lists all listings in a given project and location. More...
StreamRange< google::cloud::bigquery::analyticshub::v1::Listing >	ListListings (google::cloud::bigquery::analyticshub::v1::ListListingsRequest request, Options opts={})
	Lists all listings in a given project and location. More...
StatusOr< google::cloud::bigquery::analyticshub::v1::Listing >	GetListing (std::string const &name, Options opts={})
	Gets the details of a listing. More...
StatusOr< google::cloud::bigquery::analyticshub::v1::Listing >	GetListing (google::cloud::bigquery::analyticshub::v1::GetListingRequest const &request, Options opts={})
	Gets the details of a listing. More...
StatusOr< google::cloud::bigquery::analyticshub::v1::Listing >	CreateListing (std::string const &parent, google::cloud::bigquery::analyticshub::v1::Listing const &listing, Options opts={})
	Creates a new listing. More...
StatusOr< google::cloud::bigquery::analyticshub::v1::Listing >	CreateListing (google::cloud::bigquery::analyticshub::v1::CreateListingRequest const &request, Options opts={})
	Creates a new listing. More...
StatusOr< google::cloud::bigquery::analyticshub::v1::Listing >	UpdateListing (google::cloud::bigquery::analyticshub::v1::Listing const &listing, google::protobuf::FieldMask const &update_mask, Options opts={})
	Updates an existing listing. More...
StatusOr< google::cloud::bigquery::analyticshub::v1::Listing >	UpdateListing (google::cloud::bigquery::analyticshub::v1::UpdateListingRequest const &request, Options opts={})
	Updates an existing listing. More...
Status	DeleteListing (std::string const &name, Options opts={})
	Deletes a listing. More...
Status	DeleteListing (google::cloud::bigquery::analyticshub::v1::DeleteListingRequest const &request, Options opts={})
	Deletes a listing. More...
StatusOr< google::cloud::bigquery::analyticshub::v1::SubscribeListingResponse >	SubscribeListing (std::string const &name, Options opts={})
	Subscribes to a listing. More...
StatusOr< google::cloud::bigquery::analyticshub::v1::SubscribeListingResponse >	SubscribeListing (google::cloud::bigquery::analyticshub::v1::SubscribeListingRequest const &request, Options opts={})
	Subscribes to a listing. More...
StatusOr< google::iam::v1::Policy >	GetIamPolicy (google::iam::v1::GetIamPolicyRequest const &request, Options opts={})
	Gets the IAM policy. More...
StatusOr< google::iam::v1::Policy >	SetIamPolicy (google::iam::v1::SetIamPolicyRequest const &request, Options opts={})
	Sets the IAM policy. More...
StatusOr< google::iam::v1::TestIamPermissionsResponse >	TestIamPermissions (google::iam::v1::TestIamPermissionsRequest const &request, Options opts={})
	Returns the permissions that a caller has. More...
Copy and move support
	AnalyticsHubServiceClient (AnalyticsHubServiceClient const &)=default
AnalyticsHubServiceClient &	operator= (AnalyticsHubServiceClient const &)=default
	AnalyticsHubServiceClient (AnalyticsHubServiceClient &&)=default
AnalyticsHubServiceClient &	operator= (AnalyticsHubServiceClient &&)=default

Friends
Equality
bool	operator== (AnalyticsHubServiceClient const &a, AnalyticsHubServiceClient const &b)
bool	operator!= (AnalyticsHubServiceClient const &a, AnalyticsHubServiceClient const &b)

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

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.

Constructor & Destructor Documentation

AnalyticsHubServiceClient() [1/3]

google::cloud::bigquery_analyticshub_v1::AnalyticsHubServiceClient::AnalyticsHubServiceClient ( std::shared_ptr< AnalyticsHubServiceConnection >  connection, Options  opts = {}  )

explicit

~AnalyticsHubServiceClient()

google::cloud::bigquery_analyticshub_v1::AnalyticsHubServiceClient::~AnalyticsHubServiceClient

(

)

AnalyticsHubServiceClient() [2/3]

google::cloud::bigquery_analyticshub_v1::AnalyticsHubServiceClient::AnalyticsHubServiceClient ( AnalyticsHubServiceClient const &  )

default

AnalyticsHubServiceClient() [3/3]

google::cloud::bigquery_analyticshub_v1::AnalyticsHubServiceClient::AnalyticsHubServiceClient ( AnalyticsHubServiceClient &&  )

default

Member Function Documentation

CreateDataExchange() [1/2]

StatusOr< google::cloud::bigquery::analyticshub::v1::DataExchange > google::cloud::bigquery_analyticshub_v1::AnalyticsHubServiceClient::CreateDataExchange	(	google::cloud::bigquery::analyticshub::v1::CreateDataExchangeRequest const &	request,
		Options	opts = {}
	)

Creates a new data exchange.

Parameters

request	google::cloud::bigquery::analyticshub::v1::CreateDataExchangeRequest
opts	Optional. Override the class-level options, such as retry and backoff policies.

Returns

google::cloud::bigquery::analyticshub::v1::DataExchange

CreateDataExchange() [2/2]

StatusOr< google::cloud::bigquery::analyticshub::v1::DataExchange > google::cloud::bigquery_analyticshub_v1::AnalyticsHubServiceClient::CreateDataExchange	(	std::string const &	parent,
		google::cloud::bigquery::analyticshub::v1::DataExchange const &	data_exchange,
		Options	opts = {}
	)

Creates a new data exchange.

Parameters

parent	Required. The parent resource path of the data exchange. e.g. projects/myproject/locations/US.
data_exchange	Required. The data exchange to create.
opts	Optional. Override the class-level options, such as retry and backoff policies.

Returns

google::cloud::bigquery::analyticshub::v1::DataExchange

CreateListing() [1/2]

StatusOr< google::cloud::bigquery::analyticshub::v1::Listing > google::cloud::bigquery_analyticshub_v1::AnalyticsHubServiceClient::CreateListing	(	google::cloud::bigquery::analyticshub::v1::CreateListingRequest const &	request,
		Options	opts = {}
	)

Creates a new listing.

Parameters

request	google::cloud::bigquery::analyticshub::v1::CreateListingRequest
opts	Optional. Override the class-level options, such as retry and backoff policies.

Returns

google::cloud::bigquery::analyticshub::v1::Listing

CreateListing() [2/2]

StatusOr< google::cloud::bigquery::analyticshub::v1::Listing > google::cloud::bigquery_analyticshub_v1::AnalyticsHubServiceClient::CreateListing	(	std::string const &	parent,
		google::cloud::bigquery::analyticshub::v1::Listing const &	listing,
		Options	opts = {}
	)

Creates a new 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.
opts	Optional. Override the class-level options, such as retry and backoff policies.

Returns

google::cloud::bigquery::analyticshub::v1::Listing

DeleteDataExchange() [1/2]

Status google::cloud::bigquery_analyticshub_v1::AnalyticsHubServiceClient::DeleteDataExchange	(	google::cloud::bigquery::analyticshub::v1::DeleteDataExchangeRequest const &	request,
		Options	opts = {}
	)

Deletes an existing data exchange.

Parameters

request	google::cloud::bigquery::analyticshub::v1::DeleteDataExchangeRequest
opts	Optional. Override the class-level options, such as retry and backoff policies.

DeleteDataExchange() [2/2]

Status google::cloud::bigquery_analyticshub_v1::AnalyticsHubServiceClient::DeleteDataExchange	(	std::string const &	name,
		Options	opts = {}
	)

Deletes an existing data exchange.

Parameters

name	Required. The full name of the data exchange resource that you want to delete. For example, projects/myproject/locations/US/dataExchanges/123.
opts	Optional. Override the class-level options, such as retry and backoff policies.

DeleteListing() [1/2]

Status google::cloud::bigquery_analyticshub_v1::AnalyticsHubServiceClient::DeleteListing	(	google::cloud::bigquery::analyticshub::v1::DeleteListingRequest const &	request,
		Options	opts = {}
	)

Deletes a listing.

Parameters

request	google::cloud::bigquery::analyticshub::v1::DeleteListingRequest
opts	Optional. Override the class-level options, such as retry and backoff policies.

DeleteListing() [2/2]

Status google::cloud::bigquery_analyticshub_v1::AnalyticsHubServiceClient::DeleteListing	(	std::string const &	name,
		Options	opts = {}
	)

Deletes a listing.

Parameters

name	Required. Resource name of the listing to delete. e.g. projects/myproject/locations/US/dataExchanges/123/listings/456.
opts	Optional. Override the class-level options, such as retry and backoff policies.

GetDataExchange() [1/2]

StatusOr< google::cloud::bigquery::analyticshub::v1::DataExchange > google::cloud::bigquery_analyticshub_v1::AnalyticsHubServiceClient::GetDataExchange	(	google::cloud::bigquery::analyticshub::v1::GetDataExchangeRequest const &	request,
		Options	opts = {}
	)

Gets the details of a data exchange.

Parameters

request	google::cloud::bigquery::analyticshub::v1::GetDataExchangeRequest
opts	Optional. Override the class-level options, such as retry and backoff policies.

Returns

google::cloud::bigquery::analyticshub::v1::DataExchange

GetDataExchange() [2/2]

StatusOr< google::cloud::bigquery::analyticshub::v1::DataExchange > google::cloud::bigquery_analyticshub_v1::AnalyticsHubServiceClient::GetDataExchange	(	std::string const &	name,
		Options	opts = {}
	)

Gets the details of a data exchange.

Parameters

name	Required. The resource name of the data exchange. e.g. projects/myproject/locations/US/dataExchanges/123.
opts	Optional. Override the class-level options, such as retry and backoff policies.

Returns

google::cloud::bigquery::analyticshub::v1::DataExchange

GetIamPolicy()

StatusOr< google::iam::v1::Policy > google::cloud::bigquery_analyticshub_v1::AnalyticsHubServiceClient::GetIamPolicy	(	google::iam::v1::GetIamPolicyRequest const &	request,
		Options	opts = {}
	)

Gets the IAM policy.

Parameters

request	google::iam::v1::GetIamPolicyRequest
opts	Optional. Override the class-level options, such as retry and backoff policies.

Returns

google::iam::v1::Policy

GetListing() [1/2]

StatusOr< google::cloud::bigquery::analyticshub::v1::Listing > google::cloud::bigquery_analyticshub_v1::AnalyticsHubServiceClient::GetListing	(	google::cloud::bigquery::analyticshub::v1::GetListingRequest const &	request,
		Options	opts = {}
	)

Gets the details of a listing.

Parameters

request	google::cloud::bigquery::analyticshub::v1::GetListingRequest
opts	Optional. Override the class-level options, such as retry and backoff policies.

Returns

google::cloud::bigquery::analyticshub::v1::Listing

GetListing() [2/2]

StatusOr< google::cloud::bigquery::analyticshub::v1::Listing > google::cloud::bigquery_analyticshub_v1::AnalyticsHubServiceClient::GetListing	(	std::string const &	name,
		Options	opts = {}
	)

Gets the details of a listing.

Parameters

name	Required. The resource name of the listing. e.g. projects/myproject/locations/US/dataExchanges/123/listings/456.
opts	Optional. Override the class-level options, such as retry and backoff policies.

Returns

google::cloud::bigquery::analyticshub::v1::Listing

ListDataExchanges() [1/2]

StreamRange< google::cloud::bigquery::analyticshub::v1::DataExchange > google::cloud::bigquery_analyticshub_v1::AnalyticsHubServiceClient::ListDataExchanges	(	google::cloud::bigquery::analyticshub::v1::ListDataExchangesRequest	request,
		Options	opts = {}
	)

Lists all data exchanges in a given project and location.

Parameters

request	google::cloud::bigquery::analyticshub::v1::ListDataExchangesRequest
opts	Optional. Override the class-level options, such as retry and backoff policies.

Returns

google::cloud::bigquery::analyticshub::v1::DataExchange

ListDataExchanges() [2/2]

StreamRange< google::cloud::bigquery::analyticshub::v1::DataExchange > google::cloud::bigquery_analyticshub_v1::AnalyticsHubServiceClient::ListDataExchanges	(	std::string const &	parent,
		Options	opts = {}
	)

Lists all data exchanges in a given project and location.

Parameters

parent	Required. The parent resource path of the data exchanges. e.g. projects/myproject/locations/US.
opts	Optional. Override the class-level options, such as retry and backoff policies.

Returns

google::cloud::bigquery::analyticshub::v1::DataExchange

ListListings() [1/2]

StreamRange< google::cloud::bigquery::analyticshub::v1::Listing > google::cloud::bigquery_analyticshub_v1::AnalyticsHubServiceClient::ListListings	(	google::cloud::bigquery::analyticshub::v1::ListListingsRequest	request,
		Options	opts = {}
	)

Lists all listings in a given project and location.

Parameters

request	google::cloud::bigquery::analyticshub::v1::ListListingsRequest
opts	Optional. Override the class-level options, such as retry and backoff policies.

Returns

google::cloud::bigquery::analyticshub::v1::Listing

ListListings() [2/2]

StreamRange< google::cloud::bigquery::analyticshub::v1::Listing > google::cloud::bigquery_analyticshub_v1::AnalyticsHubServiceClient::ListListings	(	std::string const &	parent,
		Options	opts = {}
	)

Lists all listings in a given project and location.

Parameters

parent	Required. The parent resource path of the listing. e.g. projects/myproject/locations/US/dataExchanges/123.
opts	Optional. Override the class-level options, such as retry and backoff policies.

Returns

google::cloud::bigquery::analyticshub::v1::Listing

ListOrgDataExchanges() [1/2]

StreamRange< google::cloud::bigquery::analyticshub::v1::DataExchange > google::cloud::bigquery_analyticshub_v1::AnalyticsHubServiceClient::ListOrgDataExchanges	(	google::cloud::bigquery::analyticshub::v1::ListOrgDataExchangesRequest	request,
		Options	opts = {}
	)

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

Parameters

request	google::cloud::bigquery::analyticshub::v1::ListOrgDataExchangesRequest
opts	Optional. Override the class-level options, such as retry and backoff policies.

Returns

google::cloud::bigquery::analyticshub::v1::DataExchange

ListOrgDataExchanges() [2/2]

StreamRange< google::cloud::bigquery::analyticshub::v1::DataExchange > google::cloud::bigquery_analyticshub_v1::AnalyticsHubServiceClient::ListOrgDataExchanges	(	std::string const &	organization,
		Options	opts = {}
	)

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

Parameters

organization	Required. The organization resource path of the projects containing DataExchanges. e.g. organizations/myorg/locations/US.
opts	Optional. Override the class-level options, such as retry and backoff policies.

Returns

google::cloud::bigquery::analyticshub::v1::DataExchange

operator=() [1/2]

AnalyticsHubServiceClient & google::cloud::bigquery_analyticshub_v1::AnalyticsHubServiceClient::operator= ( AnalyticsHubServiceClient &&  )

default

operator=() [2/2]

AnalyticsHubServiceClient & google::cloud::bigquery_analyticshub_v1::AnalyticsHubServiceClient::operator= ( AnalyticsHubServiceClient const &  )

default

SetIamPolicy()

StatusOr< google::iam::v1::Policy > google::cloud::bigquery_analyticshub_v1::AnalyticsHubServiceClient::SetIamPolicy	(	google::iam::v1::SetIamPolicyRequest const &	request,
		Options	opts = {}
	)

Sets the IAM policy.

Parameters

request	google::iam::v1::SetIamPolicyRequest
opts	Optional. Override the class-level options, such as retry and backoff policies.

Returns

google::iam::v1::Policy

SubscribeListing() [1/2]

StatusOr< google::cloud::bigquery::analyticshub::v1::SubscribeListingResponse > google::cloud::bigquery_analyticshub_v1::AnalyticsHubServiceClient::SubscribeListing	(	google::cloud::bigquery::analyticshub::v1::SubscribeListingRequest const &	request,
		Options	opts = {}
	)

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

request	google::cloud::bigquery::analyticshub::v1::SubscribeListingRequest
opts	Optional. Override the class-level options, such as retry and backoff policies.

Returns

google::cloud::bigquery::analyticshub::v1::SubscribeListingResponse

SubscribeListing() [2/2]

StatusOr< google::cloud::bigquery::analyticshub::v1::SubscribeListingResponse > google::cloud::bigquery_analyticshub_v1::AnalyticsHubServiceClient::SubscribeListing	(	std::string const &	name,
		Options	opts = {}
	)

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	Required. Resource name of the listing that you want to subscribe to. e.g. projects/myproject/locations/US/dataExchanges/123/listings/456.
opts	Optional. Override the class-level options, such as retry and backoff policies.

Returns

google::cloud::bigquery::analyticshub::v1::SubscribeListingResponse

TestIamPermissions()

StatusOr< google::iam::v1::TestIamPermissionsResponse > google::cloud::bigquery_analyticshub_v1::AnalyticsHubServiceClient::TestIamPermissions	(	google::iam::v1::TestIamPermissionsRequest const &	request,
		Options	opts = {}
	)

Returns the permissions that a caller has.

Parameters

request	google::iam::v1::TestIamPermissionsRequest
opts	Optional. Override the class-level options, such as retry and backoff policies.

Returns

google::iam::v1::TestIamPermissionsResponse

UpdateDataExchange() [1/2]

StatusOr< google::cloud::bigquery::analyticshub::v1::DataExchange > google::cloud::bigquery_analyticshub_v1::AnalyticsHubServiceClient::UpdateDataExchange	(	google::cloud::bigquery::analyticshub::v1::DataExchange const &	data_exchange,
		google::protobuf::FieldMask const &	update_mask,
		Options	opts = {}
	)

Updates an existing data exchange.

Parameters

data_exchange	Required. The data exchange to update.
update_mask	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	Optional. Override the class-level options, such as retry and backoff policies.

Returns

google::cloud::bigquery::analyticshub::v1::DataExchange

UpdateDataExchange() [2/2]

StatusOr< google::cloud::bigquery::analyticshub::v1::DataExchange > google::cloud::bigquery_analyticshub_v1::AnalyticsHubServiceClient::UpdateDataExchange	(	google::cloud::bigquery::analyticshub::v1::UpdateDataExchangeRequest const &	request,
		Options	opts = {}
	)

Updates an existing data exchange.

Parameters

request	google::cloud::bigquery::analyticshub::v1::UpdateDataExchangeRequest
opts	Optional. Override the class-level options, such as retry and backoff policies.

Returns

google::cloud::bigquery::analyticshub::v1::DataExchange

UpdateListing() [1/2]

StatusOr< google::cloud::bigquery::analyticshub::v1::Listing > google::cloud::bigquery_analyticshub_v1::AnalyticsHubServiceClient::UpdateListing	(	google::cloud::bigquery::analyticshub::v1::Listing const &	listing,
		google::protobuf::FieldMask const &	update_mask,
		Options	opts = {}
	)

Updates an existing listing.

Parameters

listing	Required. The listing to update.
update_mask	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	Optional. Override the class-level options, such as retry and backoff policies.

Returns

google::cloud::bigquery::analyticshub::v1::Listing

UpdateListing() [2/2]

StatusOr< google::cloud::bigquery::analyticshub::v1::Listing > google::cloud::bigquery_analyticshub_v1::AnalyticsHubServiceClient::UpdateListing	(	google::cloud::bigquery::analyticshub::v1::UpdateListingRequest const &	request,
		Options	opts = {}
	)

Updates an existing listing.

Parameters

request	google::cloud::bigquery::analyticshub::v1::UpdateListingRequest
opts	Optional. Override the class-level options, such as retry and backoff policies.

Returns

google::cloud::bigquery::analyticshub::v1::Listing

Friends And Related Function Documentation

operator!=

bool operator!= ( AnalyticsHubServiceClient const &  a, AnalyticsHubServiceClient const &  b  )

friend

operator==

bool operator== ( AnalyticsHubServiceClient const &  a, AnalyticsHubServiceClient const &  b  )

friend