Analytics Hub v1 API - Class AnalyticsHubService.AnalyticsHubServiceBase (1.10.0)

[BindServiceMethod(typeof(AnalyticsHubService), "BindService")]
public abstract class AnalyticsHubService.AnalyticsHubServiceBase

Reference documentation and code samples for the Analytics Hub v1 API class AnalyticsHubService.AnalyticsHubServiceBase.

Base class for server-side implementations of AnalyticsHubService

Inheritance

object > AnalyticsHubService.AnalyticsHubServiceBase

Inherited Members

object.GetHashCode()

object.GetType()

object.MemberwiseClone()

object.ToString()

Namespace

Google.Cloud.BigQuery.AnalyticsHub.V1

Assembly

Google.Cloud.BigQuery.AnalyticsHub.V1.dll

Methods

ApproveQueryTemplate(ApproveQueryTemplateRequest, ServerCallContext)

public virtual Task<QueryTemplate> ApproveQueryTemplate(ApproveQueryTemplateRequest request, ServerCallContext context)

Approves a query template.

Parameters
Name	Description
`request`	`ApproveQueryTemplateRequest` The request received from the client.
`context`	`ServerCallContext` The context of the server-side call handler being invoked.

Returns
Type	Description
`TaskQueryTemplate`	The response to send back to the client (wrapped by a task).

CreateDataExchange(CreateDataExchangeRequest, ServerCallContext)

public virtual Task<DataExchange> CreateDataExchange(CreateDataExchangeRequest request, ServerCallContext context)

Creates a new data exchange.

Parameters
Name	Description
`request`	`CreateDataExchangeRequest` The request received from the client.
`context`	`ServerCallContext` The context of the server-side call handler being invoked.

Returns
Type	Description
`TaskDataExchange`	The response to send back to the client (wrapped by a task).

CreateListing(CreateListingRequest, ServerCallContext)

public virtual Task<Listing> CreateListing(CreateListingRequest request, ServerCallContext context)

Creates a new listing.

Parameters
Name	Description
`request`	`CreateListingRequest` The request received from the client.
`context`	`ServerCallContext` The context of the server-side call handler being invoked.

Returns
Type	Description
`TaskListing`	The response to send back to the client (wrapped by a task).

CreateQueryTemplate(CreateQueryTemplateRequest, ServerCallContext)

public virtual Task<QueryTemplate> CreateQueryTemplate(CreateQueryTemplateRequest request, ServerCallContext context)

Creates a new QueryTemplate

Parameters
Name	Description
`request`	`CreateQueryTemplateRequest` The request received from the client.
`context`	`ServerCallContext` The context of the server-side call handler being invoked.

Returns
Type	Description
`TaskQueryTemplate`	The response to send back to the client (wrapped by a task).

DeleteDataExchange(DeleteDataExchangeRequest, ServerCallContext)

public virtual Task<Empty> DeleteDataExchange(DeleteDataExchangeRequest request, ServerCallContext context)

Deletes an existing data exchange.

Parameters
Name	Description
`request`	`DeleteDataExchangeRequest` The request received from the client.
`context`	`ServerCallContext` The context of the server-side call handler being invoked.

Returns
Type	Description
`TaskEmpty`	The response to send back to the client (wrapped by a task).

DeleteListing(DeleteListingRequest, ServerCallContext)

public virtual Task<Empty> DeleteListing(DeleteListingRequest request, ServerCallContext context)

Deletes a listing.

Parameters
Name	Description
`request`	`DeleteListingRequest` The request received from the client.
`context`	`ServerCallContext` The context of the server-side call handler being invoked.

Returns
Type	Description
`TaskEmpty`	The response to send back to the client (wrapped by a task).

DeleteQueryTemplate(DeleteQueryTemplateRequest, ServerCallContext)

public virtual Task<Empty> DeleteQueryTemplate(DeleteQueryTemplateRequest request, ServerCallContext context)

Deletes a query template.

Parameters
Name	Description
`request`	`DeleteQueryTemplateRequest` The request received from the client.
`context`	`ServerCallContext` The context of the server-side call handler being invoked.

Returns
Type	Description
`TaskEmpty`	The response to send back to the client (wrapped by a task).

DeleteSubscription(DeleteSubscriptionRequest, ServerCallContext)

public virtual Task<Operation> DeleteSubscription(DeleteSubscriptionRequest request, ServerCallContext context)

Deletes a subscription.

Parameters
Name	Description
`request`	`DeleteSubscriptionRequest` The request received from the client.
`context`	`ServerCallContext` The context of the server-side call handler being invoked.

Returns
Type	Description
`TaskOperation`	The response to send back to the client (wrapped by a task).

GetDataExchange(GetDataExchangeRequest, ServerCallContext)

public virtual Task<DataExchange> GetDataExchange(GetDataExchangeRequest request, ServerCallContext context)

Gets the details of a data exchange.

Parameters
Name	Description
`request`	`GetDataExchangeRequest` The request received from the client.
`context`	`ServerCallContext` The context of the server-side call handler being invoked.

Returns
Type	Description
`TaskDataExchange`	The response to send back to the client (wrapped by a task).

GetIamPolicy(GetIamPolicyRequest, ServerCallContext)

public virtual Task<Policy> GetIamPolicy(GetIamPolicyRequest request, ServerCallContext context)

Gets the IAM policy.

Parameters
Name	Description
`request`	`GetIamPolicyRequest` The request received from the client.
`context`	`ServerCallContext` The context of the server-side call handler being invoked.

Returns
Type	Description
`TaskPolicy`	The response to send back to the client (wrapped by a task).

GetListing(GetListingRequest, ServerCallContext)

public virtual Task<Listing> GetListing(GetListingRequest request, ServerCallContext context)

Gets the details of a listing.

Parameters
Name	Description
`request`	`GetListingRequest` The request received from the client.
`context`	`ServerCallContext` The context of the server-side call handler being invoked.

Returns
Type	Description
`TaskListing`	The response to send back to the client (wrapped by a task).

GetQueryTemplate(GetQueryTemplateRequest, ServerCallContext)

public virtual Task<QueryTemplate> GetQueryTemplate(GetQueryTemplateRequest request, ServerCallContext context)

Gets a QueryTemplate

Parameters
Name	Description
`request`	`GetQueryTemplateRequest` The request received from the client.
`context`	`ServerCallContext` The context of the server-side call handler being invoked.

Returns
Type	Description
`TaskQueryTemplate`	The response to send back to the client (wrapped by a task).

GetSubscription(GetSubscriptionRequest, ServerCallContext)

public virtual Task<Subscription> GetSubscription(GetSubscriptionRequest request, ServerCallContext context)

Gets the details of a Subscription.

Parameters
Name	Description
`request`	`GetSubscriptionRequest` The request received from the client.
`context`	`ServerCallContext` The context of the server-side call handler being invoked.

Returns
Type	Description
`TaskSubscription`	The response to send back to the client (wrapped by a task).

ListDataExchanges(ListDataExchangesRequest, ServerCallContext)

public virtual Task<ListDataExchangesResponse> ListDataExchanges(ListDataExchangesRequest request, ServerCallContext context)

Lists all data exchanges in a given project and location.

Parameters
Name	Description
`request`	`ListDataExchangesRequest` The request received from the client.
`context`	`ServerCallContext` The context of the server-side call handler being invoked.

Returns
Type	Description
`TaskListDataExchangesResponse`	The response to send back to the client (wrapped by a task).

ListListings(ListListingsRequest, ServerCallContext)

public virtual Task<ListListingsResponse> ListListings(ListListingsRequest request, ServerCallContext context)

Lists all listings in a given project and location.

Parameters
Name	Description
`request`	`ListListingsRequest` The request received from the client.
`context`	`ServerCallContext` The context of the server-side call handler being invoked.

Returns
Type	Description
`TaskListListingsResponse`	The response to send back to the client (wrapped by a task).

ListOrgDataExchanges(ListOrgDataExchangesRequest, ServerCallContext)

public virtual Task<ListOrgDataExchangesResponse> ListOrgDataExchanges(ListOrgDataExchangesRequest request, ServerCallContext context)

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

Parameters
Name	Description
`request`	`ListOrgDataExchangesRequest` The request received from the client.
`context`	`ServerCallContext` The context of the server-side call handler being invoked.

Returns
Type	Description
`TaskListOrgDataExchangesResponse`	The response to send back to the client (wrapped by a task).

ListQueryTemplates(ListQueryTemplatesRequest, ServerCallContext)

public virtual Task<ListQueryTemplatesResponse> ListQueryTemplates(ListQueryTemplatesRequest request, ServerCallContext context)

Lists all QueryTemplates in a given project and location.

Parameters
Name	Description
`request`	`ListQueryTemplatesRequest` The request received from the client.
`context`	`ServerCallContext` The context of the server-side call handler being invoked.

Returns
Type	Description
`TaskListQueryTemplatesResponse`	The response to send back to the client (wrapped by a task).

ListSharedResourceSubscriptions(ListSharedResourceSubscriptionsRequest, ServerCallContext)

public virtual Task<ListSharedResourceSubscriptionsResponse> ListSharedResourceSubscriptions(ListSharedResourceSubscriptionsRequest request, ServerCallContext context)

Lists all subscriptions on a given Data Exchange or Listing.

Parameters
Name	Description
`request`	`ListSharedResourceSubscriptionsRequest` The request received from the client.
`context`	`ServerCallContext` The context of the server-side call handler being invoked.

Returns
Type	Description
`TaskListSharedResourceSubscriptionsResponse`	The response to send back to the client (wrapped by a task).

ListSubscriptions(ListSubscriptionsRequest, ServerCallContext)

public virtual Task<ListSubscriptionsResponse> ListSubscriptions(ListSubscriptionsRequest request, ServerCallContext context)

Lists all subscriptions in a given project and location.

Parameters
Name	Description
`request`	`ListSubscriptionsRequest` The request received from the client.
`context`	`ServerCallContext` The context of the server-side call handler being invoked.

Returns
Type	Description
`TaskListSubscriptionsResponse`	The response to send back to the client (wrapped by a task).

RefreshSubscription(RefreshSubscriptionRequest, ServerCallContext)

public virtual Task<Operation> RefreshSubscription(RefreshSubscriptionRequest request, ServerCallContext context)

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`	`RefreshSubscriptionRequest` The request received from the client.
`context`	`ServerCallContext` The context of the server-side call handler being invoked.

Returns
Type	Description
`TaskOperation`	The response to send back to the client (wrapped by a task).

RevokeSubscription(RevokeSubscriptionRequest, ServerCallContext)

public virtual Task<RevokeSubscriptionResponse> RevokeSubscription(RevokeSubscriptionRequest request, ServerCallContext context)

Revokes a given subscription.

Parameters
Name	Description
`request`	`RevokeSubscriptionRequest` The request received from the client.
`context`	`ServerCallContext` The context of the server-side call handler being invoked.

Returns
Type	Description
`TaskRevokeSubscriptionResponse`	The response to send back to the client (wrapped by a task).

SetIamPolicy(SetIamPolicyRequest, ServerCallContext)

public virtual Task<Policy> SetIamPolicy(SetIamPolicyRequest request, ServerCallContext context)

Sets the IAM policy.

Parameters
Name	Description
`request`	`SetIamPolicyRequest` The request received from the client.
`context`	`ServerCallContext` The context of the server-side call handler being invoked.

Returns
Type	Description
`TaskPolicy`	The response to send back to the client (wrapped by a task).

SubmitQueryTemplate(SubmitQueryTemplateRequest, ServerCallContext)

public virtual Task<QueryTemplate> SubmitQueryTemplate(SubmitQueryTemplateRequest request, ServerCallContext context)

Submits a query template for approval.

Parameters
Name	Description
`request`	`SubmitQueryTemplateRequest` The request received from the client.
`context`	`ServerCallContext` The context of the server-side call handler being invoked.

Returns
Type	Description
`TaskQueryTemplate`	The response to send back to the client (wrapped by a task).

SubscribeDataExchange(SubscribeDataExchangeRequest, ServerCallContext)

public virtual Task<Operation> SubscribeDataExchange(SubscribeDataExchangeRequest request, ServerCallContext context)

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.

Parameters
Name	Description
`request`	`SubscribeDataExchangeRequest` The request received from the client.
`context`	`ServerCallContext` The context of the server-side call handler being invoked.

Returns
Type	Description
`TaskOperation`	The response to send back to the client (wrapped by a task).

SubscribeListing(SubscribeListingRequest, ServerCallContext)

public virtual Task<SubscribeListingResponse> SubscribeListing(SubscribeListingRequest request, ServerCallContext context)

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
`request`	`SubscribeListingRequest` The request received from the client.
`context`	`ServerCallContext` The context of the server-side call handler being invoked.

Returns
Type	Description
`TaskSubscribeListingResponse`	The response to send back to the client (wrapped by a task).

TestIamPermissions(TestIamPermissionsRequest, ServerCallContext)

public virtual Task<TestIamPermissionsResponse> TestIamPermissions(TestIamPermissionsRequest request, ServerCallContext context)

Returns the permissions that a caller has.

Parameters
Name	Description
`request`	`TestIamPermissionsRequest` The request received from the client.
`context`	`ServerCallContext` The context of the server-side call handler being invoked.

Returns
Type	Description
`TaskTestIamPermissionsResponse`	The response to send back to the client (wrapped by a task).

UpdateDataExchange(UpdateDataExchangeRequest, ServerCallContext)

public virtual Task<DataExchange> UpdateDataExchange(UpdateDataExchangeRequest request, ServerCallContext context)

Updates an existing data exchange.

Parameters
Name	Description
`request`	`UpdateDataExchangeRequest` The request received from the client.
`context`	`ServerCallContext` The context of the server-side call handler being invoked.

Returns
Type	Description
`TaskDataExchange`	The response to send back to the client (wrapped by a task).

UpdateListing(UpdateListingRequest, ServerCallContext)

public virtual Task<Listing> UpdateListing(UpdateListingRequest request, ServerCallContext context)

Updates an existing listing.

Parameters
Name	Description
`request`	`UpdateListingRequest` The request received from the client.
`context`	`ServerCallContext` The context of the server-side call handler being invoked.

Returns
Type	Description
`TaskListing`	The response to send back to the client (wrapped by a task).

UpdateQueryTemplate(UpdateQueryTemplateRequest, ServerCallContext)

public virtual Task<QueryTemplate> UpdateQueryTemplate(UpdateQueryTemplateRequest request, ServerCallContext context)

Updates an existing QueryTemplate

Parameters
Name	Description
`request`	`UpdateQueryTemplateRequest` The request received from the client.
`context`	`ServerCallContext` The context of the server-side call handler being invoked.

Returns
Type	Description
`TaskQueryTemplate`	The response to send back to the client (wrapped by a task).