AnalyticsHubService - Documentation

Constructor

new AnalyticsHubService(rpcImpl, requestDelimitedopt, responseDelimitedopt)

Constructs a new AnalyticsHubService service.

Parameters:

Name	Type	Attributes	Default	Description
`rpcImpl`	$protobuf.RPCImpl			RPC implementation
`requestDelimited`	boolean	<optional>	false	Whether requests are length-delimited
`responseDelimited`	boolean	<optional>	false	Whether responses are length-delimited

Extends

$protobuf.rpc.Service

Methods

createDataExchange(request, callback) → {undefined}

Calls CreateDataExchange.

Parameters:

Name	Type	Description
`request`	google.cloud.bigquery.dataexchange.v1beta1.ICreateDataExchangeRequest	CreateDataExchangeRequest message or plain object
`callback`	google.cloud.bigquery.dataexchange.v1beta1.AnalyticsHubService.CreateDataExchangeCallback	Node-style callback called with the error, if any, and DataExchange

Returns:

Type	Description
undefined

createDataExchange(request) → {Promise.<google.cloud.bigquery.dataexchange.v1beta1.DataExchange>}

Calls CreateDataExchange.

Parameters:

Name	Type	Description
`request`	google.cloud.bigquery.dataexchange.v1beta1.ICreateDataExchangeRequest	CreateDataExchangeRequest message or plain object

Returns:

Type	Description
Promise.<google.cloud.bigquery.dataexchange.v1beta1.DataExchange>	Promise

createListing(request, callback) → {undefined}

Calls CreateListing.

Parameters:

Name	Type	Description
`request`	google.cloud.bigquery.dataexchange.v1beta1.ICreateListingRequest	CreateListingRequest message or plain object
`callback`	google.cloud.bigquery.dataexchange.v1beta1.AnalyticsHubService.CreateListingCallback	Node-style callback called with the error, if any, and Listing

Returns:

Type	Description
undefined

createListing(request) → {Promise.<google.cloud.bigquery.dataexchange.v1beta1.Listing>}

Calls CreateListing.

Parameters:

Name	Type	Description
`request`	google.cloud.bigquery.dataexchange.v1beta1.ICreateListingRequest	CreateListingRequest message or plain object

Returns:

Type	Description
Promise.<google.cloud.bigquery.dataexchange.v1beta1.Listing>	Promise

deleteDataExchange(request, callback) → {undefined}

Calls DeleteDataExchange.

Parameters:

Name	Type	Description
`request`	google.cloud.bigquery.dataexchange.v1beta1.IDeleteDataExchangeRequest	DeleteDataExchangeRequest message or plain object
`callback`	google.cloud.bigquery.dataexchange.v1beta1.AnalyticsHubService.DeleteDataExchangeCallback	Node-style callback called with the error, if any, and Empty

Returns:

Type	Description
undefined

deleteDataExchange(request) → {Promise.<google.protobuf.Empty>}

Calls DeleteDataExchange.

Parameters:

Name	Type	Description
`request`	google.cloud.bigquery.dataexchange.v1beta1.IDeleteDataExchangeRequest	DeleteDataExchangeRequest message or plain object

Returns:

Type	Description
Promise.<google.protobuf.Empty>	Promise

deleteListing(request, callback) → {undefined}

Calls DeleteListing.

Parameters:

Name	Type	Description
`request`	google.cloud.bigquery.dataexchange.v1beta1.IDeleteListingRequest	DeleteListingRequest message or plain object
`callback`	google.cloud.bigquery.dataexchange.v1beta1.AnalyticsHubService.DeleteListingCallback	Node-style callback called with the error, if any, and Empty

Returns:

Type	Description
undefined

deleteListing(request) → {Promise.<google.protobuf.Empty>}

Calls DeleteListing.

Parameters:

Name	Type	Description
`request`	google.cloud.bigquery.dataexchange.v1beta1.IDeleteListingRequest	DeleteListingRequest message or plain object

Returns:

Type	Description
Promise.<google.protobuf.Empty>	Promise

getDataExchange(request, callback) → {undefined}

Calls GetDataExchange.

Parameters:

Name	Type	Description
`request`	google.cloud.bigquery.dataexchange.v1beta1.IGetDataExchangeRequest	GetDataExchangeRequest message or plain object
`callback`	google.cloud.bigquery.dataexchange.v1beta1.AnalyticsHubService.GetDataExchangeCallback	Node-style callback called with the error, if any, and DataExchange

Returns:

Type	Description
undefined

getDataExchange(request) → {Promise.<google.cloud.bigquery.dataexchange.v1beta1.DataExchange>}

Calls GetDataExchange.

Parameters:

Name	Type	Description
`request`	google.cloud.bigquery.dataexchange.v1beta1.IGetDataExchangeRequest	GetDataExchangeRequest message or plain object

Returns:

Type	Description
Promise.<google.cloud.bigquery.dataexchange.v1beta1.DataExchange>	Promise

getIamPolicy(request, callback) → {undefined}

Calls GetIamPolicy.

Parameters:

Name	Type	Description
`request`	google.iam.v1.IGetIamPolicyRequest	GetIamPolicyRequest message or plain object
`callback`	google.cloud.bigquery.dataexchange.v1beta1.AnalyticsHubService.GetIamPolicyCallback	Node-style callback called with the error, if any, and Policy

Returns:

Type	Description
undefined

getIamPolicy(request) → {Promise.<google.iam.v1.Policy>}

Calls GetIamPolicy.

Parameters:

Name	Type	Description
`request`	google.iam.v1.IGetIamPolicyRequest	GetIamPolicyRequest message or plain object

Returns:

Type	Description
Promise.<google.iam.v1.Policy>	Promise

getListing(request, callback) → {undefined}

Calls GetListing.

Parameters:

Name	Type	Description
`request`	google.cloud.bigquery.dataexchange.v1beta1.IGetListingRequest	GetListingRequest message or plain object
`callback`	google.cloud.bigquery.dataexchange.v1beta1.AnalyticsHubService.GetListingCallback	Node-style callback called with the error, if any, and Listing

Returns:

Type	Description
undefined

getListing(request) → {Promise.<google.cloud.bigquery.dataexchange.v1beta1.Listing>}

Calls GetListing.

Parameters:

Name	Type	Description
`request`	google.cloud.bigquery.dataexchange.v1beta1.IGetListingRequest	GetListingRequest message or plain object

Returns:

Type	Description
Promise.<google.cloud.bigquery.dataexchange.v1beta1.Listing>	Promise

listDataExchanges(request, callback) → {undefined}

Calls ListDataExchanges.

Parameters:

Name	Type	Description
`request`	google.cloud.bigquery.dataexchange.v1beta1.IListDataExchangesRequest	ListDataExchangesRequest message or plain object
`callback`	google.cloud.bigquery.dataexchange.v1beta1.AnalyticsHubService.ListDataExchangesCallback	Node-style callback called with the error, if any, and ListDataExchangesResponse

Returns:

Type	Description
undefined

listDataExchanges(request) → {Promise.<google.cloud.bigquery.dataexchange.v1beta1.ListDataExchangesResponse>}

Calls ListDataExchanges.

Parameters:

Name	Type	Description
`request`	google.cloud.bigquery.dataexchange.v1beta1.IListDataExchangesRequest	ListDataExchangesRequest message or plain object

Returns:

Type	Description
Promise.<google.cloud.bigquery.dataexchange.v1beta1.ListDataExchangesResponse>	Promise

listListings(request, callback) → {undefined}

Calls ListListings.

Parameters:

Name	Type	Description
`request`	google.cloud.bigquery.dataexchange.v1beta1.IListListingsRequest	ListListingsRequest message or plain object
`callback`	google.cloud.bigquery.dataexchange.v1beta1.AnalyticsHubService.ListListingsCallback	Node-style callback called with the error, if any, and ListListingsResponse

Returns:

Type	Description
undefined

listListings(request) → {Promise.<google.cloud.bigquery.dataexchange.v1beta1.ListListingsResponse>}

Calls ListListings.

Parameters:

Name	Type	Description
`request`	google.cloud.bigquery.dataexchange.v1beta1.IListListingsRequest	ListListingsRequest message or plain object

Returns:

Type	Description
Promise.<google.cloud.bigquery.dataexchange.v1beta1.ListListingsResponse>	Promise

listOrgDataExchanges(request, callback) → {undefined}

Calls ListOrgDataExchanges.

Parameters:

Name	Type	Description
`request`	google.cloud.bigquery.dataexchange.v1beta1.IListOrgDataExchangesRequest	ListOrgDataExchangesRequest message or plain object
`callback`	google.cloud.bigquery.dataexchange.v1beta1.AnalyticsHubService.ListOrgDataExchangesCallback	Node-style callback called with the error, if any, and ListOrgDataExchangesResponse

Returns:

Type	Description
undefined

listOrgDataExchanges(request) → {Promise.<google.cloud.bigquery.dataexchange.v1beta1.ListOrgDataExchangesResponse>}

Calls ListOrgDataExchanges.

Parameters:

Name	Type	Description
`request`	google.cloud.bigquery.dataexchange.v1beta1.IListOrgDataExchangesRequest	ListOrgDataExchangesRequest message or plain object

Returns:

Type	Description
Promise.<google.cloud.bigquery.dataexchange.v1beta1.ListOrgDataExchangesResponse>	Promise

setIamPolicy(request, callback) → {undefined}

Calls SetIamPolicy.

Parameters:

Name	Type	Description
`request`	google.iam.v1.ISetIamPolicyRequest	SetIamPolicyRequest message or plain object
`callback`	google.cloud.bigquery.dataexchange.v1beta1.AnalyticsHubService.SetIamPolicyCallback	Node-style callback called with the error, if any, and Policy

Returns:

Type	Description
undefined

setIamPolicy(request) → {Promise.<google.iam.v1.Policy>}

Calls SetIamPolicy.

Parameters:

Name	Type	Description
`request`	google.iam.v1.ISetIamPolicyRequest	SetIamPolicyRequest message or plain object

Returns:

Type	Description
Promise.<google.iam.v1.Policy>	Promise

subscribeListing(request, callback) → {undefined}

Calls SubscribeListing.

Parameters:

Name	Type	Description
`request`	google.cloud.bigquery.dataexchange.v1beta1.ISubscribeListingRequest	SubscribeListingRequest message or plain object
`callback`	google.cloud.bigquery.dataexchange.v1beta1.AnalyticsHubService.SubscribeListingCallback	Node-style callback called with the error, if any, and SubscribeListingResponse

Returns:

Type	Description
undefined

subscribeListing(request) → {Promise.<google.cloud.bigquery.dataexchange.v1beta1.SubscribeListingResponse>}

Calls SubscribeListing.

Parameters:

Name	Type	Description
`request`	google.cloud.bigquery.dataexchange.v1beta1.ISubscribeListingRequest	SubscribeListingRequest message or plain object

Returns:

Type	Description
Promise.<google.cloud.bigquery.dataexchange.v1beta1.SubscribeListingResponse>	Promise

testIamPermissions(request, callback) → {undefined}

Calls TestIamPermissions.

Parameters:

Name	Type	Description
`request`	google.iam.v1.ITestIamPermissionsRequest	TestIamPermissionsRequest message or plain object
`callback`	google.cloud.bigquery.dataexchange.v1beta1.AnalyticsHubService.TestIamPermissionsCallback	Node-style callback called with the error, if any, and TestIamPermissionsResponse

Returns:

Type	Description
undefined

testIamPermissions(request) → {Promise.<google.iam.v1.TestIamPermissionsResponse>}

Calls TestIamPermissions.

Parameters:

Name	Type	Description
`request`	google.iam.v1.ITestIamPermissionsRequest	TestIamPermissionsRequest message or plain object

Returns:

Type	Description
Promise.<google.iam.v1.TestIamPermissionsResponse>	Promise

updateDataExchange(request, callback) → {undefined}

Calls UpdateDataExchange.

Parameters:

Name	Type	Description
`request`	google.cloud.bigquery.dataexchange.v1beta1.IUpdateDataExchangeRequest	UpdateDataExchangeRequest message or plain object
`callback`	google.cloud.bigquery.dataexchange.v1beta1.AnalyticsHubService.UpdateDataExchangeCallback	Node-style callback called with the error, if any, and DataExchange

Returns:

Type	Description
undefined

updateDataExchange(request) → {Promise.<google.cloud.bigquery.dataexchange.v1beta1.DataExchange>}

Calls UpdateDataExchange.

Parameters:

Name	Type	Description
`request`	google.cloud.bigquery.dataexchange.v1beta1.IUpdateDataExchangeRequest	UpdateDataExchangeRequest message or plain object

Returns:

Type	Description
Promise.<google.cloud.bigquery.dataexchange.v1beta1.DataExchange>	Promise

updateListing(request, callback) → {undefined}

Calls UpdateListing.

Parameters:

Name	Type	Description
`request`	google.cloud.bigquery.dataexchange.v1beta1.IUpdateListingRequest	UpdateListingRequest message or plain object
`callback`	google.cloud.bigquery.dataexchange.v1beta1.AnalyticsHubService.UpdateListingCallback	Node-style callback called with the error, if any, and Listing

Returns:

Type	Description
undefined

updateListing(request) → {Promise.<google.cloud.bigquery.dataexchange.v1beta1.Listing>}

Calls UpdateListing.

Parameters:

Name	Type	Description
`request`	google.cloud.bigquery.dataexchange.v1beta1.IUpdateListingRequest	UpdateListingRequest message or plain object

Returns:

Type	Description
Promise.<google.cloud.bigquery.dataexchange.v1beta1.Listing>	Promise

(static) create(rpcImpl, requestDelimitedopt, responseDelimitedopt) → {AnalyticsHubService}

Creates new AnalyticsHubService service using the specified rpc implementation.

Parameters:

Name	Type	Attributes	Default	Description
`rpcImpl`	$protobuf.RPCImpl			RPC implementation
`requestDelimited`	boolean	<optional>	false	Whether requests are length-delimited
`responseDelimited`	boolean	<optional>	false	Whether responses are length-delimited

Returns:

Type	Description
AnalyticsHubService	RPC service. Useful where requests and/or responses are streamed.

Type Definitions

CreateDataExchangeCallback(error, responseopt)

Callback as used by createDataExchange.

Parameters:

Name	Type	Attributes	Description
`error`	Error \| null		Error, if any
`response`	google.cloud.bigquery.dataexchange.v1beta1.DataExchange	<optional>	DataExchange

CreateListingCallback(error, responseopt)

Callback as used by createListing.

Parameters:

Name	Type	Attributes	Description
`error`	Error \| null		Error, if any
`response`	google.cloud.bigquery.dataexchange.v1beta1.Listing	<optional>	Listing

DeleteDataExchangeCallback(error, responseopt)

Callback as used by deleteDataExchange.

Parameters:

Name	Type	Attributes	Description
`error`	Error \| null		Error, if any
`response`	google.protobuf.Empty	<optional>	Empty

DeleteListingCallback(error, responseopt)

Callback as used by deleteListing.

Parameters:

Name	Type	Attributes	Description
`error`	Error \| null		Error, if any
`response`	google.protobuf.Empty	<optional>	Empty

GetDataExchangeCallback(error, responseopt)

Callback as used by getDataExchange.

Parameters:

Name	Type	Attributes	Description
`error`	Error \| null		Error, if any
`response`	google.cloud.bigquery.dataexchange.v1beta1.DataExchange	<optional>	DataExchange

GetIamPolicyCallback(error, responseopt)

Callback as used by getIamPolicy.

Parameters:

Name	Type	Attributes	Description
`error`	Error \| null		Error, if any
`response`	google.iam.v1.Policy	<optional>	Policy

GetListingCallback(error, responseopt)

Callback as used by getListing.

Parameters:

Name	Type	Attributes	Description
`error`	Error \| null		Error, if any
`response`	google.cloud.bigquery.dataexchange.v1beta1.Listing	<optional>	Listing

ListDataExchangesCallback(error, responseopt)

Callback as used by listDataExchanges.

Parameters:

Name	Type	Attributes	Description
`error`	Error \| null		Error, if any
`response`	google.cloud.bigquery.dataexchange.v1beta1.ListDataExchangesResponse	<optional>	ListDataExchangesResponse

ListListingsCallback(error, responseopt)

Callback as used by listListings.

Parameters:

Name	Type	Attributes	Description
`error`	Error \| null		Error, if any
`response`	google.cloud.bigquery.dataexchange.v1beta1.ListListingsResponse	<optional>	ListListingsResponse

ListOrgDataExchangesCallback(error, responseopt)

Callback as used by listOrgDataExchanges.

Parameters:

Name	Type	Attributes	Description
`error`	Error \| null		Error, if any
`response`	google.cloud.bigquery.dataexchange.v1beta1.ListOrgDataExchangesResponse	<optional>	ListOrgDataExchangesResponse

SetIamPolicyCallback(error, responseopt)

Callback as used by setIamPolicy.

Parameters:

Name	Type	Attributes	Description
`error`	Error \| null		Error, if any
`response`	google.iam.v1.Policy	<optional>	Policy

SubscribeListingCallback(error, responseopt)

Callback as used by subscribeListing.

Parameters:

Name	Type	Attributes	Description
`error`	Error \| null		Error, if any
`response`	google.cloud.bigquery.dataexchange.v1beta1.SubscribeListingResponse	<optional>	SubscribeListingResponse

TestIamPermissionsCallback(error, responseopt)

Callback as used by testIamPermissions.

Parameters:

Name	Type	Attributes	Description
`error`	Error \| null		Error, if any
`response`	google.iam.v1.TestIamPermissionsResponse	<optional>	TestIamPermissionsResponse

UpdateDataExchangeCallback(error, responseopt)

Callback as used by updateDataExchange.

Parameters:

Name	Type	Attributes	Description
`error`	Error \| null		Error, if any
`response`	google.cloud.bigquery.dataexchange.v1beta1.DataExchange	<optional>	DataExchange

UpdateListingCallback(error, responseopt)

Callback as used by updateListing.

Parameters:

Name	Type	Attributes	Description
`error`	Error \| null		Error, if any
`response`	google.cloud.bigquery.dataexchange.v1beta1.Listing	<optional>	Listing