Analytics Hub v1 API - Class AnalyticsHubServiceClientImpl (1.5.0)

public sealed class AnalyticsHubServiceClientImpl : AnalyticsHubServiceClient

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

AnalyticsHubService client wrapper implementation, for convenient use.

Inheritance

object > AnalyticsHubServiceClient > AnalyticsHubServiceClientImpl

Namespace

Google.Cloud.BigQuery.AnalyticsHub.V1

Assembly

Google.Cloud.BigQuery.AnalyticsHub.V1.dll

Remarks

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.

Constructors

AnalyticsHubServiceClientImpl(AnalyticsHubServiceClient, AnalyticsHubServiceSettings, ILogger)

public AnalyticsHubServiceClientImpl(AnalyticsHubService.AnalyticsHubServiceClient grpcClient, AnalyticsHubServiceSettings settings, ILogger logger)

Constructs a client wrapper for the AnalyticsHubService service, with the specified gRPC client and settings.

Parameters
Name Description
grpcClient AnalyticsHubServiceAnalyticsHubServiceClient

The underlying gRPC client.
settings AnalyticsHubServiceSettings

The base AnalyticsHubServiceSettings used within this client.
logger ILogger

Optional ILogger to use within this client.

Properties

DeleteSubscriptionOperationsClient

public override OperationsClient DeleteSubscriptionOperationsClient { get; }

The long-running operations client for DeleteSubscription.

Property Value
Type Description
OperationsClient
Overrides

GrpcClient

public override AnalyticsHubService.AnalyticsHubServiceClient GrpcClient { get; }

The underlying gRPC AnalyticsHubService client

Property Value
Type Description
AnalyticsHubServiceAnalyticsHubServiceClient
Overrides

RefreshSubscriptionOperationsClient

public override OperationsClient RefreshSubscriptionOperationsClient { get; }

The long-running operations client for RefreshSubscription.

Property Value
Type Description
OperationsClient
Overrides

SubscribeDataExchangeOperationsClient

public override OperationsClient SubscribeDataExchangeOperationsClient { get; }

The long-running operations client for SubscribeDataExchange.

Property Value
Type Description
OperationsClient
Overrides

Methods

CreateDataExchange(CreateDataExchangeRequest, CallSettings)

public override DataExchange CreateDataExchange(CreateDataExchangeRequest request, CallSettings callSettings = null)

Creates a new data exchange.

Parameters
Name Description
request CreateDataExchangeRequest

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

If not null, applies overrides to this RPC call.
Returns
Type Description
DataExchange

The RPC response.
Overrides

CreateDataExchangeAsync(CreateDataExchangeRequest, CallSettings)

public override Task<DataExchange> CreateDataExchangeAsync(CreateDataExchangeRequest request, CallSettings callSettings = null)

Creates a new data exchange.

Parameters
Name Description
request CreateDataExchangeRequest

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

If not null, applies overrides to this RPC call.
Returns
Type Description
TaskDataExchange

A Task containing the RPC response.
Overrides

CreateListing(CreateListingRequest, CallSettings)

public override Listing CreateListing(CreateListingRequest request, CallSettings callSettings = null)

Creates a new listing.

Parameters
Name Description
request CreateListingRequest

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

If not null, applies overrides to this RPC call.
Returns
Type Description
Listing

The RPC response.
Overrides

CreateListingAsync(CreateListingRequest, CallSettings)

public override Task<Listing> CreateListingAsync(CreateListingRequest request, CallSettings callSettings = null)

Creates a new listing.

Parameters
Name Description
request CreateListingRequest

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

If not null, applies overrides to this RPC call.
Returns
Type Description
TaskListing

A Task containing the RPC response.
Overrides

DeleteDataExchange(DeleteDataExchangeRequest, CallSettings)

public override void DeleteDataExchange(DeleteDataExchangeRequest request, CallSettings callSettings = null)

Deletes an existing data exchange.

Parameters
Name Description
request DeleteDataExchangeRequest

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

If not null, applies overrides to this RPC call.
Overrides

DeleteDataExchangeAsync(DeleteDataExchangeRequest, CallSettings)

public override Task DeleteDataExchangeAsync(DeleteDataExchangeRequest request, CallSettings callSettings = null)

Deletes an existing data exchange.

Parameters
Name Description
request DeleteDataExchangeRequest

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

If not null, applies overrides to this RPC call.
Returns
Type Description
Task

A Task containing the RPC response.
Overrides

DeleteListing(DeleteListingRequest, CallSettings)

public override void DeleteListing(DeleteListingRequest request, CallSettings callSettings = null)

Deletes a listing.

Parameters
Name Description
request DeleteListingRequest

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

If not null, applies overrides to this RPC call.
Overrides

DeleteListingAsync(DeleteListingRequest, CallSettings)

public override Task DeleteListingAsync(DeleteListingRequest request, CallSettings callSettings = null)

Deletes a listing.

Parameters
Name Description
request DeleteListingRequest

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

If not null, applies overrides to this RPC call.
Returns
Type Description
Task

A Task containing the RPC response.
Overrides

DeleteSubscription(DeleteSubscriptionRequest, CallSettings)

public override Operation<Empty, OperationMetadata> DeleteSubscription(DeleteSubscriptionRequest request, CallSettings callSettings = null)

Deletes a subscription.

Parameters
Name Description
request DeleteSubscriptionRequest

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

If not null, applies overrides to this RPC call.
Returns
Type Description
OperationEmptyOperationMetadata

The RPC response.
Overrides

DeleteSubscriptionAsync(DeleteSubscriptionRequest, CallSettings)

public override Task<Operation<Empty, OperationMetadata>> DeleteSubscriptionAsync(DeleteSubscriptionRequest request, CallSettings callSettings = null)

Deletes a subscription.

Parameters
Name Description
request DeleteSubscriptionRequest

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

If not null, applies overrides to this RPC call.
Returns
Type Description
TaskOperationEmptyOperationMetadata

A Task containing the RPC response.
Overrides

GetDataExchange(GetDataExchangeRequest, CallSettings)

public override DataExchange GetDataExchange(GetDataExchangeRequest request, CallSettings callSettings = null)

Gets the details of a data exchange.

Parameters
Name Description
request GetDataExchangeRequest

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

If not null, applies overrides to this RPC call.
Returns
Type Description
DataExchange

The RPC response.
Overrides

GetDataExchangeAsync(GetDataExchangeRequest, CallSettings)

public override Task<DataExchange> GetDataExchangeAsync(GetDataExchangeRequest request, CallSettings callSettings = null)

Gets the details of a data exchange.

Parameters
Name Description
request GetDataExchangeRequest

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

If not null, applies overrides to this RPC call.
Returns
Type Description
TaskDataExchange

A Task containing the RPC response.
Overrides

GetIamPolicy(GetIamPolicyRequest, CallSettings)

public override Policy GetIamPolicy(GetIamPolicyRequest request, CallSettings callSettings = null)

Gets the IAM policy.

Parameters
Name Description
request GetIamPolicyRequest

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

If not null, applies overrides to this RPC call.
Returns
Type Description
Policy

The RPC response.
Overrides

GetIamPolicyAsync(GetIamPolicyRequest, CallSettings)

public override Task<Policy> GetIamPolicyAsync(GetIamPolicyRequest request, CallSettings callSettings = null)

Gets the IAM policy.

Parameters
Name Description
request GetIamPolicyRequest

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

If not null, applies overrides to this RPC call.
Returns
Type Description
TaskPolicy

A Task containing the RPC response.
Overrides

GetListing(GetListingRequest, CallSettings)

public override Listing GetListing(GetListingRequest request, CallSettings callSettings = null)

Gets the details of a listing.

Parameters
Name Description
request GetListingRequest

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

If not null, applies overrides to this RPC call.
Returns
Type Description
Listing

The RPC response.
Overrides

GetListingAsync(GetListingRequest, CallSettings)

public override Task<Listing> GetListingAsync(GetListingRequest request, CallSettings callSettings = null)

Gets the details of a listing.

Parameters
Name Description
request GetListingRequest

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

If not null, applies overrides to this RPC call.
Returns
Type Description
TaskListing

A Task containing the RPC response.
Overrides

GetSubscription(GetSubscriptionRequest, CallSettings)

public override Subscription GetSubscription(GetSubscriptionRequest request, CallSettings callSettings = null)

Gets the details of a Subscription.

Parameters
Name Description
request GetSubscriptionRequest

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

If not null, applies overrides to this RPC call.
Returns
Type Description
Subscription

The RPC response.
Overrides

GetSubscriptionAsync(GetSubscriptionRequest, CallSettings)

public override Task<Subscription> GetSubscriptionAsync(GetSubscriptionRequest request, CallSettings callSettings = null)

Gets the details of a Subscription.

Parameters
Name Description
request GetSubscriptionRequest

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

If not null, applies overrides to this RPC call.
Returns
Type Description
TaskSubscription

A Task containing the RPC response.
Overrides

ListDataExchanges(ListDataExchangesRequest, CallSettings)

public override PagedEnumerable<ListDataExchangesResponse, DataExchange> ListDataExchanges(ListDataExchangesRequest request, CallSettings callSettings = null)

Lists all data exchanges in a given project and location.

Parameters
Name Description
request ListDataExchangesRequest

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

If not null, applies overrides to this RPC call.
Returns
Type Description
PagedEnumerableListDataExchangesResponseDataExchange

A pageable sequence of DataExchange resources.
Overrides

ListDataExchangesAsync(ListDataExchangesRequest, CallSettings)

public override PagedAsyncEnumerable<ListDataExchangesResponse, DataExchange> ListDataExchangesAsync(ListDataExchangesRequest request, CallSettings callSettings = null)

Lists all data exchanges in a given project and location.

Parameters
Name Description
request ListDataExchangesRequest

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

If not null, applies overrides to this RPC call.
Returns
Type Description
PagedAsyncEnumerableListDataExchangesResponseDataExchange

A pageable asynchronous sequence of DataExchange resources.
Overrides

ListListings(ListListingsRequest, CallSettings)

public override PagedEnumerable<ListListingsResponse, Listing> ListListings(ListListingsRequest request, CallSettings callSettings = null)

Lists all listings in a given project and location.

Parameters
Name Description
request ListListingsRequest

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

If not null, applies overrides to this RPC call.
Returns
Type Description
PagedEnumerableListListingsResponseListing

A pageable sequence of Listing resources.
Overrides

ListListingsAsync(ListListingsRequest, CallSettings)

public override PagedAsyncEnumerable<ListListingsResponse, Listing> ListListingsAsync(ListListingsRequest request, CallSettings callSettings = null)

Lists all listings in a given project and location.

Parameters
Name Description
request ListListingsRequest

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

If not null, applies overrides to this RPC call.
Returns
Type Description
PagedAsyncEnumerableListListingsResponseListing

A pageable asynchronous sequence of Listing resources.
Overrides

ListOrgDataExchanges(ListOrgDataExchangesRequest, CallSettings)

public override PagedEnumerable<ListOrgDataExchangesResponse, DataExchange> ListOrgDataExchanges(ListOrgDataExchangesRequest request, CallSettings callSettings = null)

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

Parameters
Name Description
request ListOrgDataExchangesRequest

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

If not null, applies overrides to this RPC call.
Returns
Type Description
PagedEnumerableListOrgDataExchangesResponseDataExchange

A pageable sequence of DataExchange resources.
Overrides

ListOrgDataExchangesAsync(ListOrgDataExchangesRequest, CallSettings)

public override PagedAsyncEnumerable<ListOrgDataExchangesResponse, DataExchange> ListOrgDataExchangesAsync(ListOrgDataExchangesRequest request, CallSettings callSettings = null)

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

Parameters
Name Description
request ListOrgDataExchangesRequest

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

If not null, applies overrides to this RPC call.
Returns
Type Description
PagedAsyncEnumerableListOrgDataExchangesResponseDataExchange

A pageable asynchronous sequence of DataExchange resources.
Overrides

ListSharedResourceSubscriptions(ListSharedResourceSubscriptionsRequest, CallSettings)

public override PagedEnumerable<ListSharedResourceSubscriptionsResponse, Subscription> ListSharedResourceSubscriptions(ListSharedResourceSubscriptionsRequest request, CallSettings callSettings = null)

Lists all subscriptions on a given Data Exchange or Listing.

Parameters
Name Description
request ListSharedResourceSubscriptionsRequest

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

If not null, applies overrides to this RPC call.
Returns
Type Description
PagedEnumerableListSharedResourceSubscriptionsResponseSubscription

A pageable sequence of Subscription resources.
Overrides

ListSharedResourceSubscriptionsAsync(ListSharedResourceSubscriptionsRequest, CallSettings)

public override PagedAsyncEnumerable<ListSharedResourceSubscriptionsResponse, Subscription> ListSharedResourceSubscriptionsAsync(ListSharedResourceSubscriptionsRequest request, CallSettings callSettings = null)

Lists all subscriptions on a given Data Exchange or Listing.

Parameters
Name Description
request ListSharedResourceSubscriptionsRequest

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

If not null, applies overrides to this RPC call.
Returns
Type Description
PagedAsyncEnumerableListSharedResourceSubscriptionsResponseSubscription

A pageable asynchronous sequence of Subscription resources.
Overrides

ListSubscriptions(ListSubscriptionsRequest, CallSettings)

public override PagedEnumerable<ListSubscriptionsResponse, Subscription> ListSubscriptions(ListSubscriptionsRequest request, CallSettings callSettings = null)

Lists all subscriptions in a given project and location.

Parameters
Name Description
request ListSubscriptionsRequest

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

If not null, applies overrides to this RPC call.
Returns
Type Description
PagedEnumerableListSubscriptionsResponseSubscription

A pageable sequence of Subscription resources.
Overrides

ListSubscriptionsAsync(ListSubscriptionsRequest, CallSettings)

public override PagedAsyncEnumerable<ListSubscriptionsResponse, Subscription> ListSubscriptionsAsync(ListSubscriptionsRequest request, CallSettings callSettings = null)

Lists all subscriptions in a given project and location.

Parameters
Name Description
request ListSubscriptionsRequest

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

If not null, applies overrides to this RPC call.
Returns
Type Description
PagedAsyncEnumerableListSubscriptionsResponseSubscription

A pageable asynchronous sequence of Subscription resources.
Overrides

RefreshSubscription(RefreshSubscriptionRequest, CallSettings)

public override Operation<RefreshSubscriptionResponse, OperationMetadata> RefreshSubscription(RefreshSubscriptionRequest request, CallSettings callSettings = null)

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 object containing all of the parameters for the API call.
callSettings CallSettings

If not null, applies overrides to this RPC call.
Returns
Type Description
OperationRefreshSubscriptionResponseOperationMetadata

The RPC response.
Overrides

RefreshSubscriptionAsync(RefreshSubscriptionRequest, CallSettings)

public override Task<Operation<RefreshSubscriptionResponse, OperationMetadata>> RefreshSubscriptionAsync(RefreshSubscriptionRequest request, CallSettings callSettings = null)

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 object containing all of the parameters for the API call.
callSettings CallSettings

If not null, applies overrides to this RPC call.
Returns
Type Description
TaskOperationRefreshSubscriptionResponseOperationMetadata

A Task containing the RPC response.
Overrides

RevokeSubscription(RevokeSubscriptionRequest, CallSettings)

public override RevokeSubscriptionResponse RevokeSubscription(RevokeSubscriptionRequest request, CallSettings callSettings = null)

Revokes a given subscription.

Parameters
Name Description
request RevokeSubscriptionRequest

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

If not null, applies overrides to this RPC call.
Returns
Type Description
RevokeSubscriptionResponse

The RPC response.
Overrides

RevokeSubscriptionAsync(RevokeSubscriptionRequest, CallSettings)

public override Task<RevokeSubscriptionResponse> RevokeSubscriptionAsync(RevokeSubscriptionRequest request, CallSettings callSettings = null)

Revokes a given subscription.

Parameters
Name Description
request RevokeSubscriptionRequest

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

If not null, applies overrides to this RPC call.
Returns
Type Description
TaskRevokeSubscriptionResponse

A Task containing the RPC response.
Overrides

SetIamPolicy(SetIamPolicyRequest, CallSettings)

public override Policy SetIamPolicy(SetIamPolicyRequest request, CallSettings callSettings = null)

Sets the IAM policy.

Parameters
Name Description
request SetIamPolicyRequest

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

If not null, applies overrides to this RPC call.
Returns
Type Description
Policy

The RPC response.
Overrides

SetIamPolicyAsync(SetIamPolicyRequest, CallSettings)

public override Task<Policy> SetIamPolicyAsync(SetIamPolicyRequest request, CallSettings callSettings = null)

Sets the IAM policy.

Parameters
Name Description
request SetIamPolicyRequest

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

If not null, applies overrides to this RPC call.
Returns
Type Description
TaskPolicy

A Task containing the RPC response.
Overrides

SubscribeDataExchange(SubscribeDataExchangeRequest, CallSettings)

public override Operation<SubscribeDataExchangeResponse, OperationMetadata> SubscribeDataExchange(SubscribeDataExchangeRequest request, CallSettings callSettings = null)

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 SubscribeDataExchangeRequest

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

If not null, applies overrides to this RPC call.
Returns
Type Description
OperationSubscribeDataExchangeResponseOperationMetadata

The RPC response.
Overrides

SubscribeDataExchangeAsync(SubscribeDataExchangeRequest, CallSettings)

public override Task<Operation<SubscribeDataExchangeResponse, OperationMetadata>> SubscribeDataExchangeAsync(SubscribeDataExchangeRequest request, CallSettings callSettings = null)

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 SubscribeDataExchangeRequest

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

If not null, applies overrides to this RPC call.
Returns
Type Description
TaskOperationSubscribeDataExchangeResponseOperationMetadata

A Task containing the RPC response.
Overrides

SubscribeListing(SubscribeListingRequest, CallSettings)

public override SubscribeListingResponse SubscribeListing(SubscribeListingRequest request, CallSettings callSettings = null)

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 object containing all of the parameters for the API call.
callSettings CallSettings

If not null, applies overrides to this RPC call.
Returns
Type Description
SubscribeListingResponse

The RPC response.
Overrides

SubscribeListingAsync(SubscribeListingRequest, CallSettings)

public override Task<SubscribeListingResponse> SubscribeListingAsync(SubscribeListingRequest request, CallSettings callSettings = null)

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 object containing all of the parameters for the API call.
callSettings CallSettings

If not null, applies overrides to this RPC call.
Returns
Type Description
TaskSubscribeListingResponse

A Task containing the RPC response.
Overrides

TestIamPermissions(TestIamPermissionsRequest, CallSettings)

public override TestIamPermissionsResponse TestIamPermissions(TestIamPermissionsRequest request, CallSettings callSettings = null)

Returns the permissions that a caller has.

Parameters
Name Description
request TestIamPermissionsRequest

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

If not null, applies overrides to this RPC call.
Returns
Type Description
TestIamPermissionsResponse

The RPC response.
Overrides

TestIamPermissionsAsync(TestIamPermissionsRequest, CallSettings)

public override Task<TestIamPermissionsResponse> TestIamPermissionsAsync(TestIamPermissionsRequest request, CallSettings callSettings = null)

Returns the permissions that a caller has.

Parameters
Name Description
request TestIamPermissionsRequest

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

If not null, applies overrides to this RPC call.
Returns
Type Description
TaskTestIamPermissionsResponse

A Task containing the RPC response.
Overrides

UpdateDataExchange(UpdateDataExchangeRequest, CallSettings)

public override DataExchange UpdateDataExchange(UpdateDataExchangeRequest request, CallSettings callSettings = null)

Updates an existing data exchange.

Parameters
Name Description
request UpdateDataExchangeRequest

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

If not null, applies overrides to this RPC call.
Returns
Type Description
DataExchange

The RPC response.
Overrides

UpdateDataExchangeAsync(UpdateDataExchangeRequest, CallSettings)

public override Task<DataExchange> UpdateDataExchangeAsync(UpdateDataExchangeRequest request, CallSettings callSettings = null)

Updates an existing data exchange.

Parameters
Name Description
request UpdateDataExchangeRequest

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

If not null, applies overrides to this RPC call.
Returns
Type Description
TaskDataExchange

A Task containing the RPC response.
Overrides

UpdateListing(UpdateListingRequest, CallSettings)

public override Listing UpdateListing(UpdateListingRequest request, CallSettings callSettings = null)

Updates an existing listing.

Parameters
Name Description
request UpdateListingRequest

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

If not null, applies overrides to this RPC call.
Returns
Type Description
Listing

The RPC response.
Overrides

UpdateListingAsync(UpdateListingRequest, CallSettings)

public override Task<Listing> UpdateListingAsync(UpdateListingRequest request, CallSettings callSettings = null)

Updates an existing listing.

Parameters
Name Description
request UpdateListingRequest

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

If not null, applies overrides to this RPC call.
Returns
Type Description
TaskListing

A Task containing the RPC response.
Overrides