Data Analytics API with Gemini v1beta API - Class ContextRetrievalService.ContextRetrievalServiceClient (1.0.0-beta01) 

public class ContextRetrievalService.ContextRetrievalServiceClient : ClientBase<ContextRetrievalService.ContextRetrievalServiceClient>

Reference documentation and code samples for the Data Analytics API with Gemini v1beta API class ContextRetrievalService.ContextRetrievalServiceClient.

Client for ContextRetrievalService

Inheritance

object > ClientBase > ClientBaseContextRetrievalServiceContextRetrievalServiceClient > ContextRetrievalService.ContextRetrievalServiceClient

Namespace

Google.Cloud.GeminiDataAnalytics.V1Beta

Assembly

Google.Cloud.GeminiDataAnalytics.V1Beta.dll

Constructors

ContextRetrievalServiceClient()

protected ContextRetrievalServiceClient()

Protected parameterless constructor to allow creation of test doubles.

ContextRetrievalServiceClient(CallInvoker)

public ContextRetrievalServiceClient(CallInvoker callInvoker)

Creates a new client for ContextRetrievalService that uses a custom CallInvoker.

Parameter
Name Description
callInvoker CallInvoker

The callInvoker to use to make remote calls.

ContextRetrievalServiceClient(ChannelBase)

public ContextRetrievalServiceClient(ChannelBase channel)

Creates a new client for ContextRetrievalService

Parameter
Name Description
channel ChannelBase

The channel to use to make remote calls.

ContextRetrievalServiceClient(ClientBaseConfiguration)

protected ContextRetrievalServiceClient(ClientBase.ClientBaseConfiguration configuration)

Protected constructor to allow creation of configured clients.

Parameter
Name Description
configuration ClientBaseClientBaseConfiguration

The client configuration.

Methods

CreateLocationsClient()

public virtual Locations.LocationsClient CreateLocationsClient()

Creates a new instance of Locations.LocationsClient using the same call invoker as this client.

Returns
Type Description
LocationsLocationsClient

A new Locations.LocationsClient for the same target as this client.

NewInstance(ClientBaseConfiguration)

protected override ContextRetrievalService.ContextRetrievalServiceClient NewInstance(ClientBase.ClientBaseConfiguration configuration)

Creates a new instance of client from given ClientBaseConfiguration.

Parameter
Name Description
configuration ClientBaseClientBaseConfiguration
Returns
Type Description
ContextRetrievalServiceContextRetrievalServiceClient
Overrides
Grpc.Core.ClientBase<Google.Cloud.GeminiDataAnalytics.V1Beta.ContextRetrievalService.ContextRetrievalServiceClient>.NewInstance(Grpc.Core.ClientBase.ClientBaseConfiguration)

RetrieveBigQueryRecentRelevantTables(RetrieveBigQueryRecentRelevantTablesRequest, CallOptions)

public virtual RetrieveBigQueryRecentRelevantTablesResponse RetrieveBigQueryRecentRelevantTables(RetrieveBigQueryRecentRelevantTablesRequest request, CallOptions options)

Retrieves BigQuery table references from recently accessed tables.

Parameters
Name Description
request RetrieveBigQueryRecentRelevantTablesRequest

The request to send to the server.
options CallOptions

The options for the call.
Returns
Type Description
RetrieveBigQueryRecentRelevantTablesResponse

The response received from the server.

RetrieveBigQueryRecentRelevantTables(RetrieveBigQueryRecentRelevantTablesRequest, Metadata, DateTime?, CancellationToken)

public virtual RetrieveBigQueryRecentRelevantTablesResponse RetrieveBigQueryRecentRelevantTables(RetrieveBigQueryRecentRelevantTablesRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default)

Retrieves BigQuery table references from recently accessed tables.

Parameters
Name Description
request RetrieveBigQueryRecentRelevantTablesRequest

The request to send to the server.
headers Metadata

The initial metadata to send with the call. This parameter is optional.
deadline System.DateTime

An optional deadline for the call. The call will be cancelled if deadline is hit.
cancellationToken CancellationToken

An optional token for canceling the call.
Returns
Type Description
RetrieveBigQueryRecentRelevantTablesResponse

The response received from the server.

RetrieveBigQueryRecentRelevantTablesAsync(RetrieveBigQueryRecentRelevantTablesRequest, CallOptions)

public virtual AsyncUnaryCall<RetrieveBigQueryRecentRelevantTablesResponse> RetrieveBigQueryRecentRelevantTablesAsync(RetrieveBigQueryRecentRelevantTablesRequest request, CallOptions options)

Retrieves BigQuery table references from recently accessed tables.

Parameters
Name Description
request RetrieveBigQueryRecentRelevantTablesRequest

The request to send to the server.
options CallOptions

The options for the call.
Returns
Type Description
AsyncUnaryCallRetrieveBigQueryRecentRelevantTablesResponse

The call object.

RetrieveBigQueryRecentRelevantTablesAsync(RetrieveBigQueryRecentRelevantTablesRequest, Metadata, DateTime?, CancellationToken)

public virtual AsyncUnaryCall<RetrieveBigQueryRecentRelevantTablesResponse> RetrieveBigQueryRecentRelevantTablesAsync(RetrieveBigQueryRecentRelevantTablesRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default)

Retrieves BigQuery table references from recently accessed tables.

Parameters
Name Description
request RetrieveBigQueryRecentRelevantTablesRequest

The request to send to the server.
headers Metadata

The initial metadata to send with the call. This parameter is optional.
deadline System.DateTime

An optional deadline for the call. The call will be cancelled if deadline is hit.
cancellationToken CancellationToken

An optional token for canceling the call.
Returns
Type Description
AsyncUnaryCallRetrieveBigQueryRecentRelevantTablesResponse

The call object.

RetrieveBigQueryTableContext(RetrieveBigQueryTableContextRequest, CallOptions)

public virtual RetrieveBigQueryTableContextResponse RetrieveBigQueryTableContext(RetrieveBigQueryTableContextRequest request, CallOptions options)

Retrieves BigQuery table contextual data for provided table references. Contextual data includes table schema information as well as sample values.

Parameters
Name Description
request RetrieveBigQueryTableContextRequest

The request to send to the server.
options CallOptions

The options for the call.
Returns
Type Description
RetrieveBigQueryTableContextResponse

The response received from the server.

RetrieveBigQueryTableContext(RetrieveBigQueryTableContextRequest, Metadata, DateTime?, CancellationToken)

public virtual RetrieveBigQueryTableContextResponse RetrieveBigQueryTableContext(RetrieveBigQueryTableContextRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default)

Retrieves BigQuery table contextual data for provided table references. Contextual data includes table schema information as well as sample values.

Parameters
Name Description
request RetrieveBigQueryTableContextRequest

The request to send to the server.
headers Metadata

The initial metadata to send with the call. This parameter is optional.
deadline System.DateTime

An optional deadline for the call. The call will be cancelled if deadline is hit.
cancellationToken CancellationToken

An optional token for canceling the call.
Returns
Type Description
RetrieveBigQueryTableContextResponse

The response received from the server.

RetrieveBigQueryTableContextAsync(RetrieveBigQueryTableContextRequest, CallOptions)

public virtual AsyncUnaryCall<RetrieveBigQueryTableContextResponse> RetrieveBigQueryTableContextAsync(RetrieveBigQueryTableContextRequest request, CallOptions options)

Retrieves BigQuery table contextual data for provided table references. Contextual data includes table schema information as well as sample values.

Parameters
Name Description
request RetrieveBigQueryTableContextRequest

The request to send to the server.
options CallOptions

The options for the call.
Returns
Type Description
AsyncUnaryCallRetrieveBigQueryTableContextResponse

The call object.

RetrieveBigQueryTableContextAsync(RetrieveBigQueryTableContextRequest, Metadata, DateTime?, CancellationToken)

public virtual AsyncUnaryCall<RetrieveBigQueryTableContextResponse> RetrieveBigQueryTableContextAsync(RetrieveBigQueryTableContextRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default)

Retrieves BigQuery table contextual data for provided table references. Contextual data includes table schema information as well as sample values.

Parameters
Name Description
request RetrieveBigQueryTableContextRequest

The request to send to the server.
headers Metadata

The initial metadata to send with the call. This parameter is optional.
deadline System.DateTime

An optional deadline for the call. The call will be cancelled if deadline is hit.
cancellationToken CancellationToken

An optional token for canceling the call.
Returns
Type Description
AsyncUnaryCallRetrieveBigQueryTableContextResponse

The call object.

RetrieveBigQueryTableContexts(RetrieveBigQueryTableContextsRequest, CallOptions)

public virtual RetrieveBigQueryTableContextsResponse RetrieveBigQueryTableContexts(RetrieveBigQueryTableContextsRequest request, CallOptions options)

Retrieves BigQuery table contextual data for provided table references. Contextual data includes table schema information as well as sample values.

Parameters
Name Description
request RetrieveBigQueryTableContextsRequest

The request to send to the server.
options CallOptions

The options for the call.
Returns
Type Description
RetrieveBigQueryTableContextsResponse

The response received from the server.

RetrieveBigQueryTableContexts(RetrieveBigQueryTableContextsRequest, Metadata, DateTime?, CancellationToken)

public virtual RetrieveBigQueryTableContextsResponse RetrieveBigQueryTableContexts(RetrieveBigQueryTableContextsRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default)

Retrieves BigQuery table contextual data for provided table references. Contextual data includes table schema information as well as sample values.

Parameters
Name Description
request RetrieveBigQueryTableContextsRequest

The request to send to the server.
headers Metadata

The initial metadata to send with the call. This parameter is optional.
deadline System.DateTime

An optional deadline for the call. The call will be cancelled if deadline is hit.
cancellationToken CancellationToken

An optional token for canceling the call.
Returns
Type Description
RetrieveBigQueryTableContextsResponse

The response received from the server.

RetrieveBigQueryTableContextsAsync(RetrieveBigQueryTableContextsRequest, CallOptions)

public virtual AsyncUnaryCall<RetrieveBigQueryTableContextsResponse> RetrieveBigQueryTableContextsAsync(RetrieveBigQueryTableContextsRequest request, CallOptions options)

Retrieves BigQuery table contextual data for provided table references. Contextual data includes table schema information as well as sample values.

Parameters
Name Description
request RetrieveBigQueryTableContextsRequest

The request to send to the server.
options CallOptions

The options for the call.
Returns
Type Description
AsyncUnaryCallRetrieveBigQueryTableContextsResponse

The call object.

RetrieveBigQueryTableContextsAsync(RetrieveBigQueryTableContextsRequest, Metadata, DateTime?, CancellationToken)

public virtual AsyncUnaryCall<RetrieveBigQueryTableContextsResponse> RetrieveBigQueryTableContextsAsync(RetrieveBigQueryTableContextsRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default)

Retrieves BigQuery table contextual data for provided table references. Contextual data includes table schema information as well as sample values.

Parameters
Name Description
request RetrieveBigQueryTableContextsRequest

The request to send to the server.
headers Metadata

The initial metadata to send with the call. This parameter is optional.
deadline System.DateTime

An optional deadline for the call. The call will be cancelled if deadline is hit.
cancellationToken CancellationToken

An optional token for canceling the call.
Returns
Type Description
AsyncUnaryCallRetrieveBigQueryTableContextsResponse

The call object.

RetrieveBigQueryTableContextsFromRecentTables(RetrieveBigQueryTableContextsFromRecentTablesRequest, CallOptions)

public virtual RetrieveBigQueryTableContextsFromRecentTablesResponse RetrieveBigQueryTableContextsFromRecentTables(RetrieveBigQueryTableContextsFromRecentTablesRequest request, CallOptions options)

Retrieves BigQuery table contextual data from recently accessed tables. Contextual data includes table schema information as well as sample values.

Parameters
Name Description
request RetrieveBigQueryTableContextsFromRecentTablesRequest

The request to send to the server.
options CallOptions

The options for the call.
Returns
Type Description
RetrieveBigQueryTableContextsFromRecentTablesResponse

The response received from the server.

RetrieveBigQueryTableContextsFromRecentTables(RetrieveBigQueryTableContextsFromRecentTablesRequest, Metadata, DateTime?, CancellationToken)

public virtual RetrieveBigQueryTableContextsFromRecentTablesResponse RetrieveBigQueryTableContextsFromRecentTables(RetrieveBigQueryTableContextsFromRecentTablesRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default)

Retrieves BigQuery table contextual data from recently accessed tables. Contextual data includes table schema information as well as sample values.

Parameters
Name Description
request RetrieveBigQueryTableContextsFromRecentTablesRequest

The request to send to the server.
headers Metadata

The initial metadata to send with the call. This parameter is optional.
deadline System.DateTime

An optional deadline for the call. The call will be cancelled if deadline is hit.
cancellationToken CancellationToken

An optional token for canceling the call.
Returns
Type Description
RetrieveBigQueryTableContextsFromRecentTablesResponse

The response received from the server.

RetrieveBigQueryTableContextsFromRecentTablesAsync(RetrieveBigQueryTableContextsFromRecentTablesRequest, CallOptions)

public virtual AsyncUnaryCall<RetrieveBigQueryTableContextsFromRecentTablesResponse> RetrieveBigQueryTableContextsFromRecentTablesAsync(RetrieveBigQueryTableContextsFromRecentTablesRequest request, CallOptions options)

Retrieves BigQuery table contextual data from recently accessed tables. Contextual data includes table schema information as well as sample values.

Parameters
Name Description
request RetrieveBigQueryTableContextsFromRecentTablesRequest

The request to send to the server.
options CallOptions

The options for the call.
Returns
Type Description
AsyncUnaryCallRetrieveBigQueryTableContextsFromRecentTablesResponse

The call object.

RetrieveBigQueryTableContextsFromRecentTablesAsync(RetrieveBigQueryTableContextsFromRecentTablesRequest, Metadata, DateTime?, CancellationToken)

public virtual AsyncUnaryCall<RetrieveBigQueryTableContextsFromRecentTablesResponse> RetrieveBigQueryTableContextsFromRecentTablesAsync(RetrieveBigQueryTableContextsFromRecentTablesRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default)

Retrieves BigQuery table contextual data from recently accessed tables. Contextual data includes table schema information as well as sample values.

Parameters
Name Description
request RetrieveBigQueryTableContextsFromRecentTablesRequest

The request to send to the server.
headers Metadata

The initial metadata to send with the call. This parameter is optional.
deadline System.DateTime

An optional deadline for the call. The call will be cancelled if deadline is hit.
cancellationToken CancellationToken

An optional token for canceling the call.
Returns
Type Description
AsyncUnaryCallRetrieveBigQueryTableContextsFromRecentTablesResponse

The call object.

RetrieveBigQueryTableSuggestedDescriptions(RetrieveBigQueryTableSuggestedDescriptionsRequest, CallOptions)

public virtual RetrieveBigQueryTableSuggestedDescriptionsResponse RetrieveBigQueryTableSuggestedDescriptions(RetrieveBigQueryTableSuggestedDescriptionsRequest request, CallOptions options)

Retrieves BigQuery table schema with suggested table and column descriptions.

Parameters
Name Description
request RetrieveBigQueryTableSuggestedDescriptionsRequest

The request to send to the server.
options CallOptions

The options for the call.
Returns
Type Description
RetrieveBigQueryTableSuggestedDescriptionsResponse

The response received from the server.

RetrieveBigQueryTableSuggestedDescriptions(RetrieveBigQueryTableSuggestedDescriptionsRequest, Metadata, DateTime?, CancellationToken)

public virtual RetrieveBigQueryTableSuggestedDescriptionsResponse RetrieveBigQueryTableSuggestedDescriptions(RetrieveBigQueryTableSuggestedDescriptionsRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default)

Retrieves BigQuery table schema with suggested table and column descriptions.

Parameters
Name Description
request RetrieveBigQueryTableSuggestedDescriptionsRequest

The request to send to the server.
headers Metadata

The initial metadata to send with the call. This parameter is optional.
deadline System.DateTime

An optional deadline for the call. The call will be cancelled if deadline is hit.
cancellationToken CancellationToken

An optional token for canceling the call.
Returns
Type Description
RetrieveBigQueryTableSuggestedDescriptionsResponse

The response received from the server.

RetrieveBigQueryTableSuggestedDescriptionsAsync(RetrieveBigQueryTableSuggestedDescriptionsRequest, CallOptions)

public virtual AsyncUnaryCall<RetrieveBigQueryTableSuggestedDescriptionsResponse> RetrieveBigQueryTableSuggestedDescriptionsAsync(RetrieveBigQueryTableSuggestedDescriptionsRequest request, CallOptions options)

Retrieves BigQuery table schema with suggested table and column descriptions.

Parameters
Name Description
request RetrieveBigQueryTableSuggestedDescriptionsRequest

The request to send to the server.
options CallOptions

The options for the call.
Returns
Type Description
AsyncUnaryCallRetrieveBigQueryTableSuggestedDescriptionsResponse

The call object.

RetrieveBigQueryTableSuggestedDescriptionsAsync(RetrieveBigQueryTableSuggestedDescriptionsRequest, Metadata, DateTime?, CancellationToken)

public virtual AsyncUnaryCall<RetrieveBigQueryTableSuggestedDescriptionsResponse> RetrieveBigQueryTableSuggestedDescriptionsAsync(RetrieveBigQueryTableSuggestedDescriptionsRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default)

Retrieves BigQuery table schema with suggested table and column descriptions.

Parameters
Name Description
request RetrieveBigQueryTableSuggestedDescriptionsRequest

The request to send to the server.
headers Metadata

The initial metadata to send with the call. This parameter is optional.
deadline System.DateTime

An optional deadline for the call. The call will be cancelled if deadline is hit.
cancellationToken CancellationToken

An optional token for canceling the call.
Returns
Type Description
AsyncUnaryCallRetrieveBigQueryTableSuggestedDescriptionsResponse

The call object.

RetrieveBigQueryTableSuggestedExamples(RetrieveBigQueryTableSuggestedExamplesRequest, CallOptions)

public virtual RetrieveBigQueryTableSuggestedExamplesResponse RetrieveBigQueryTableSuggestedExamples(RetrieveBigQueryTableSuggestedExamplesRequest request, CallOptions options)

Retrieves BigQuery table schema with suggested NL-SQL examples.

Parameters
Name Description
request RetrieveBigQueryTableSuggestedExamplesRequest

The request to send to the server.
options CallOptions

The options for the call.
Returns
Type Description
RetrieveBigQueryTableSuggestedExamplesResponse

The response received from the server.

RetrieveBigQueryTableSuggestedExamples(RetrieveBigQueryTableSuggestedExamplesRequest, Metadata, DateTime?, CancellationToken)

public virtual RetrieveBigQueryTableSuggestedExamplesResponse RetrieveBigQueryTableSuggestedExamples(RetrieveBigQueryTableSuggestedExamplesRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default)

Retrieves BigQuery table schema with suggested NL-SQL examples.

Parameters
Name Description
request RetrieveBigQueryTableSuggestedExamplesRequest

The request to send to the server.
headers Metadata

The initial metadata to send with the call. This parameter is optional.
deadline System.DateTime

An optional deadline for the call. The call will be cancelled if deadline is hit.
cancellationToken CancellationToken

An optional token for canceling the call.
Returns
Type Description
RetrieveBigQueryTableSuggestedExamplesResponse

The response received from the server.

RetrieveBigQueryTableSuggestedExamplesAsync(RetrieveBigQueryTableSuggestedExamplesRequest, CallOptions)

public virtual AsyncUnaryCall<RetrieveBigQueryTableSuggestedExamplesResponse> RetrieveBigQueryTableSuggestedExamplesAsync(RetrieveBigQueryTableSuggestedExamplesRequest request, CallOptions options)

Retrieves BigQuery table schema with suggested NL-SQL examples.

Parameters
Name Description
request RetrieveBigQueryTableSuggestedExamplesRequest

The request to send to the server.
options CallOptions

The options for the call.
Returns
Type Description
AsyncUnaryCallRetrieveBigQueryTableSuggestedExamplesResponse

The call object.

RetrieveBigQueryTableSuggestedExamplesAsync(RetrieveBigQueryTableSuggestedExamplesRequest, Metadata, DateTime?, CancellationToken)

public virtual AsyncUnaryCall<RetrieveBigQueryTableSuggestedExamplesResponse> RetrieveBigQueryTableSuggestedExamplesAsync(RetrieveBigQueryTableSuggestedExamplesRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default)

Retrieves BigQuery table schema with suggested NL-SQL examples.

Parameters
Name Description
request RetrieveBigQueryTableSuggestedExamplesRequest

The request to send to the server.
headers Metadata

The initial metadata to send with the call. This parameter is optional.
deadline System.DateTime

An optional deadline for the call. The call will be cancelled if deadline is hit.
cancellationToken CancellationToken

An optional token for canceling the call.
Returns
Type Description
AsyncUnaryCallRetrieveBigQueryTableSuggestedExamplesResponse

The call object.