Discovery Engine v1 API - Class ConversationalSearchService.ConversationalSearchServiceClient (1.0.0-beta06)

public class ConversationalSearchService.ConversationalSearchServiceClient : ClientBase<ConversationalSearchService.ConversationalSearchServiceClient>

Reference documentation and code samples for the Discovery Engine v1 API class ConversationalSearchService.ConversationalSearchServiceClient.

Client for ConversationalSearchService

Inheritance

object > ClientBase > ClientBaseConversationalSearchServiceConversationalSearchServiceClient > ConversationalSearchService.ConversationalSearchServiceClient

Namespace

Google.Cloud.DiscoveryEngine.V1

Assembly

Google.Cloud.DiscoveryEngine.V1.dll

Constructors

ConversationalSearchServiceClient()

protected ConversationalSearchServiceClient()

Protected parameterless constructor to allow creation of test doubles.

ConversationalSearchServiceClient(CallInvoker)

public ConversationalSearchServiceClient(CallInvoker callInvoker)

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

Parameter
Name Description
callInvoker CallInvoker

The callInvoker to use to make remote calls.

ConversationalSearchServiceClient(ChannelBase)

public ConversationalSearchServiceClient(ChannelBase channel)

Creates a new client for ConversationalSearchService

Parameter
Name Description
channel ChannelBase

The channel to use to make remote calls.

ConversationalSearchServiceClient(ClientBaseConfiguration)

protected ConversationalSearchServiceClient(ClientBase.ClientBaseConfiguration configuration)

Protected constructor to allow creation of configured clients.

Parameter
Name Description
configuration ClientBaseClientBaseConfiguration

The client configuration.

Methods

ConverseConversation(ConverseConversationRequest, CallOptions)

public virtual ConverseConversationResponse ConverseConversation(ConverseConversationRequest request, CallOptions options)

Converses a conversation.

Parameters
Name Description
request ConverseConversationRequest

The request to send to the server.

options CallOptions

The options for the call.

Returns
Type Description
ConverseConversationResponse

The response received from the server.

ConverseConversation(ConverseConversationRequest, Metadata, DateTime?, CancellationToken)

public virtual ConverseConversationResponse ConverseConversation(ConverseConversationRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default)

Converses a conversation.

Parameters
Name Description
request ConverseConversationRequest

The request to send to the server.

headers Metadata

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

deadline 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
ConverseConversationResponse

The response received from the server.

ConverseConversationAsync(ConverseConversationRequest, CallOptions)

public virtual AsyncUnaryCall<ConverseConversationResponse> ConverseConversationAsync(ConverseConversationRequest request, CallOptions options)

Converses a conversation.

Parameters
Name Description
request ConverseConversationRequest

The request to send to the server.

options CallOptions

The options for the call.

Returns
Type Description
AsyncUnaryCallConverseConversationResponse

The call object.

ConverseConversationAsync(ConverseConversationRequest, Metadata, DateTime?, CancellationToken)

public virtual AsyncUnaryCall<ConverseConversationResponse> ConverseConversationAsync(ConverseConversationRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default)

Converses a conversation.

Parameters
Name Description
request ConverseConversationRequest

The request to send to the server.

headers Metadata

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

deadline 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
AsyncUnaryCallConverseConversationResponse

The call object.

CreateConversation(CreateConversationRequest, CallOptions)

public virtual Conversation CreateConversation(CreateConversationRequest request, CallOptions options)

Creates a Conversation.

If the [Conversation][google.cloud.discoveryengine.v1.Conversation] to create already exists, an ALREADY_EXISTS error is returned.

Parameters
Name Description
request CreateConversationRequest

The request to send to the server.

options CallOptions

The options for the call.

Returns
Type Description
Conversation

The response received from the server.

CreateConversation(CreateConversationRequest, Metadata, DateTime?, CancellationToken)

public virtual Conversation CreateConversation(CreateConversationRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default)

Creates a Conversation.

If the [Conversation][google.cloud.discoveryengine.v1.Conversation] to create already exists, an ALREADY_EXISTS error is returned.

Parameters
Name Description
request CreateConversationRequest

The request to send to the server.

headers Metadata

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

deadline 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
Conversation

The response received from the server.

CreateConversationAsync(CreateConversationRequest, CallOptions)

public virtual AsyncUnaryCall<Conversation> CreateConversationAsync(CreateConversationRequest request, CallOptions options)

Creates a Conversation.

If the [Conversation][google.cloud.discoveryengine.v1.Conversation] to create already exists, an ALREADY_EXISTS error is returned.

Parameters
Name Description
request CreateConversationRequest

The request to send to the server.

options CallOptions

The options for the call.

Returns
Type Description
AsyncUnaryCallConversation

The call object.

CreateConversationAsync(CreateConversationRequest, Metadata, DateTime?, CancellationToken)

public virtual AsyncUnaryCall<Conversation> CreateConversationAsync(CreateConversationRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default)

Creates a Conversation.

If the [Conversation][google.cloud.discoveryengine.v1.Conversation] to create already exists, an ALREADY_EXISTS error is returned.

Parameters
Name Description
request CreateConversationRequest

The request to send to the server.

headers Metadata

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

deadline 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
AsyncUnaryCallConversation

The call object.

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.

DeleteConversation(DeleteConversationRequest, CallOptions)

public virtual Empty DeleteConversation(DeleteConversationRequest request, CallOptions options)

Deletes a Conversation.

If the [Conversation][google.cloud.discoveryengine.v1.Conversation] to delete does not exist, a NOT_FOUND error is returned.

Parameters
Name Description
request DeleteConversationRequest

The request to send to the server.

options CallOptions

The options for the call.

Returns
Type Description
Empty

The response received from the server.

DeleteConversation(DeleteConversationRequest, Metadata, DateTime?, CancellationToken)

public virtual Empty DeleteConversation(DeleteConversationRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default)

Deletes a Conversation.

If the [Conversation][google.cloud.discoveryengine.v1.Conversation] to delete does not exist, a NOT_FOUND error is returned.

Parameters
Name Description
request DeleteConversationRequest

The request to send to the server.

headers Metadata

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

deadline 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
Empty

The response received from the server.

DeleteConversationAsync(DeleteConversationRequest, CallOptions)

public virtual AsyncUnaryCall<Empty> DeleteConversationAsync(DeleteConversationRequest request, CallOptions options)

Deletes a Conversation.

If the [Conversation][google.cloud.discoveryengine.v1.Conversation] to delete does not exist, a NOT_FOUND error is returned.

Parameters
Name Description
request DeleteConversationRequest

The request to send to the server.

options CallOptions

The options for the call.

Returns
Type Description
AsyncUnaryCallEmpty

The call object.

DeleteConversationAsync(DeleteConversationRequest, Metadata, DateTime?, CancellationToken)

public virtual AsyncUnaryCall<Empty> DeleteConversationAsync(DeleteConversationRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default)

Deletes a Conversation.

If the [Conversation][google.cloud.discoveryengine.v1.Conversation] to delete does not exist, a NOT_FOUND error is returned.

Parameters
Name Description
request DeleteConversationRequest

The request to send to the server.

headers Metadata

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

deadline 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
AsyncUnaryCallEmpty

The call object.

GetConversation(GetConversationRequest, CallOptions)

public virtual Conversation GetConversation(GetConversationRequest request, CallOptions options)

Gets a Conversation.

Parameters
Name Description
request GetConversationRequest

The request to send to the server.

options CallOptions

The options for the call.

Returns
Type Description
Conversation

The response received from the server.

GetConversation(GetConversationRequest, Metadata, DateTime?, CancellationToken)

public virtual Conversation GetConversation(GetConversationRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default)

Gets a Conversation.

Parameters
Name Description
request GetConversationRequest

The request to send to the server.

headers Metadata

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

deadline 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
Conversation

The response received from the server.

GetConversationAsync(GetConversationRequest, CallOptions)

public virtual AsyncUnaryCall<Conversation> GetConversationAsync(GetConversationRequest request, CallOptions options)

Gets a Conversation.

Parameters
Name Description
request GetConversationRequest

The request to send to the server.

options CallOptions

The options for the call.

Returns
Type Description
AsyncUnaryCallConversation

The call object.

GetConversationAsync(GetConversationRequest, Metadata, DateTime?, CancellationToken)

public virtual AsyncUnaryCall<Conversation> GetConversationAsync(GetConversationRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default)

Gets a Conversation.

Parameters
Name Description
request GetConversationRequest

The request to send to the server.

headers Metadata

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

deadline 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
AsyncUnaryCallConversation

The call object.

ListConversations(ListConversationsRequest, CallOptions)

public virtual ListConversationsResponse ListConversations(ListConversationsRequest request, CallOptions options)

Lists all Conversations by their parent [DataStore][google.cloud.discoveryengine.v1.DataStore].

Parameters
Name Description
request ListConversationsRequest

The request to send to the server.

options CallOptions

The options for the call.

Returns
Type Description
ListConversationsResponse

The response received from the server.

ListConversations(ListConversationsRequest, Metadata, DateTime?, CancellationToken)

public virtual ListConversationsResponse ListConversations(ListConversationsRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default)

Lists all Conversations by their parent [DataStore][google.cloud.discoveryengine.v1.DataStore].

Parameters
Name Description
request ListConversationsRequest

The request to send to the server.

headers Metadata

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

deadline 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
ListConversationsResponse

The response received from the server.

ListConversationsAsync(ListConversationsRequest, CallOptions)

public virtual AsyncUnaryCall<ListConversationsResponse> ListConversationsAsync(ListConversationsRequest request, CallOptions options)

Lists all Conversations by their parent [DataStore][google.cloud.discoveryengine.v1.DataStore].

Parameters
Name Description
request ListConversationsRequest

The request to send to the server.

options CallOptions

The options for the call.

Returns
Type Description
AsyncUnaryCallListConversationsResponse

The call object.

ListConversationsAsync(ListConversationsRequest, Metadata, DateTime?, CancellationToken)

public virtual AsyncUnaryCall<ListConversationsResponse> ListConversationsAsync(ListConversationsRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default)

Lists all Conversations by their parent [DataStore][google.cloud.discoveryengine.v1.DataStore].

Parameters
Name Description
request ListConversationsRequest

The request to send to the server.

headers Metadata

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

deadline 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
AsyncUnaryCallListConversationsResponse

The call object.

NewInstance(ClientBaseConfiguration)

protected override ConversationalSearchService.ConversationalSearchServiceClient NewInstance(ClientBase.ClientBaseConfiguration configuration)

Creates a new instance of client from given ClientBaseConfiguration.

Parameter
Name Description
configuration ClientBaseClientBaseConfiguration
Returns
Type Description
ConversationalSearchServiceConversationalSearchServiceClient
Overrides

UpdateConversation(UpdateConversationRequest, CallOptions)

public virtual Conversation UpdateConversation(UpdateConversationRequest request, CallOptions options)

Updates a Conversation.

[Conversation][google.cloud.discoveryengine.v1.Conversation] action type cannot be changed. If the [Conversation][google.cloud.discoveryengine.v1.Conversation] to update does not exist, a NOT_FOUND error is returned.

Parameters
Name Description
request UpdateConversationRequest

The request to send to the server.

options CallOptions

The options for the call.

Returns
Type Description
Conversation

The response received from the server.

UpdateConversation(UpdateConversationRequest, Metadata, DateTime?, CancellationToken)

public virtual Conversation UpdateConversation(UpdateConversationRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default)

Updates a Conversation.

[Conversation][google.cloud.discoveryengine.v1.Conversation] action type cannot be changed. If the [Conversation][google.cloud.discoveryengine.v1.Conversation] to update does not exist, a NOT_FOUND error is returned.

Parameters
Name Description
request UpdateConversationRequest

The request to send to the server.

headers Metadata

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

deadline 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
Conversation

The response received from the server.

UpdateConversationAsync(UpdateConversationRequest, CallOptions)

public virtual AsyncUnaryCall<Conversation> UpdateConversationAsync(UpdateConversationRequest request, CallOptions options)

Updates a Conversation.

[Conversation][google.cloud.discoveryengine.v1.Conversation] action type cannot be changed. If the [Conversation][google.cloud.discoveryengine.v1.Conversation] to update does not exist, a NOT_FOUND error is returned.

Parameters
Name Description
request UpdateConversationRequest

The request to send to the server.

options CallOptions

The options for the call.

Returns
Type Description
AsyncUnaryCallConversation

The call object.

UpdateConversationAsync(UpdateConversationRequest, Metadata, DateTime?, CancellationToken)

public virtual AsyncUnaryCall<Conversation> UpdateConversationAsync(UpdateConversationRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default)

Updates a Conversation.

[Conversation][google.cloud.discoveryengine.v1.Conversation] action type cannot be changed. If the [Conversation][google.cloud.discoveryengine.v1.Conversation] to update does not exist, a NOT_FOUND error is returned.

Parameters
Name Description
request UpdateConversationRequest

The request to send to the server.

headers Metadata

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

deadline 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
AsyncUnaryCallConversation

The call object.