Google Cloud Dialogflow v2 API - Class CompanionAgents.CompanionAgentsClient (4.32.0)

public class CompanionAgents.CompanionAgentsClient : ClientBase<CompanionAgents.CompanionAgentsClient>

Reference documentation and code samples for the Google Cloud Dialogflow v2 API class CompanionAgents.CompanionAgentsClient.

Client for CompanionAgents

Inheritance

object > ClientBase > ClientBaseCompanionAgentsCompanionAgentsClient > CompanionAgents.CompanionAgentsClient

Namespace

Google.Cloud.Dialogflow.V2

Assembly

Google.Cloud.Dialogflow.V2.dll

Constructors

CompanionAgentsClient()

protected CompanionAgentsClient()

Protected parameterless constructor to allow creation of test doubles.

CompanionAgentsClient(CallInvoker)

public CompanionAgentsClient(CallInvoker callInvoker)

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

Parameter
Name Description
callInvoker CallInvoker

The callInvoker to use to make remote calls.

CompanionAgentsClient(ChannelBase)

public CompanionAgentsClient(ChannelBase channel)

Creates a new client for CompanionAgents

Parameter
Name Description
channel ChannelBase

The channel to use to make remote calls.

CompanionAgentsClient(ClientBaseConfiguration)

protected CompanionAgentsClient(ClientBase.ClientBaseConfiguration configuration)

Protected constructor to allow creation of configured clients.

Parameter
Name Description
configuration ClientBaseClientBaseConfiguration

The client configuration.

Methods

CreateCompanionAgent(CreateCompanionAgentRequest, CallOptions)

public virtual CompanionAgent CreateCompanionAgent(CreateCompanionAgentRequest request, CallOptions options)

Creates a companion agent.

Parameters
Name Description
request CreateCompanionAgentRequest

The request to send to the server.

options CallOptions

The options for the call.

Returns
Type Description
CompanionAgent

The response received from the server.

CreateCompanionAgent(CreateCompanionAgentRequest, Metadata, DateTime?, CancellationToken)

public virtual CompanionAgent CreateCompanionAgent(CreateCompanionAgentRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default)

Creates a companion agent.

Parameters
Name Description
request CreateCompanionAgentRequest

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
CompanionAgent

The response received from the server.

CreateCompanionAgentAsync(CreateCompanionAgentRequest, CallOptions)

public virtual AsyncUnaryCall<CompanionAgent> CreateCompanionAgentAsync(CreateCompanionAgentRequest request, CallOptions options)

Creates a companion agent.

Parameters
Name Description
request CreateCompanionAgentRequest

The request to send to the server.

options CallOptions

The options for the call.

Returns
Type Description
AsyncUnaryCallCompanionAgent

The call object.

CreateCompanionAgentAsync(CreateCompanionAgentRequest, Metadata, DateTime?, CancellationToken)

public virtual AsyncUnaryCall<CompanionAgent> CreateCompanionAgentAsync(CreateCompanionAgentRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default)

Creates a companion agent.

Parameters
Name Description
request CreateCompanionAgentRequest

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
AsyncUnaryCallCompanionAgent

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.

DeleteCompanionAgent(DeleteCompanionAgentRequest, CallOptions)

public virtual Empty DeleteCompanionAgent(DeleteCompanionAgentRequest request, CallOptions options)

Deletes a companion agent.

Parameters
Name Description
request DeleteCompanionAgentRequest

The request to send to the server.

options CallOptions

The options for the call.

Returns
Type Description
Empty

The response received from the server.

DeleteCompanionAgent(DeleteCompanionAgentRequest, Metadata, DateTime?, CancellationToken)

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

Deletes a companion agent.

Parameters
Name Description
request DeleteCompanionAgentRequest

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
Empty

The response received from the server.

DeleteCompanionAgentAsync(DeleteCompanionAgentRequest, CallOptions)

public virtual AsyncUnaryCall<Empty> DeleteCompanionAgentAsync(DeleteCompanionAgentRequest request, CallOptions options)

Deletes a companion agent.

Parameters
Name Description
request DeleteCompanionAgentRequest

The request to send to the server.

options CallOptions

The options for the call.

Returns
Type Description
AsyncUnaryCallEmpty

The call object.

DeleteCompanionAgentAsync(DeleteCompanionAgentRequest, Metadata, DateTime?, CancellationToken)

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

Deletes a companion agent.

Parameters
Name Description
request DeleteCompanionAgentRequest

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
AsyncUnaryCallEmpty

The call object.

GetCompanionAgent(GetCompanionAgentRequest, CallOptions)

public virtual CompanionAgent GetCompanionAgent(GetCompanionAgentRequest request, CallOptions options)

Gets a companion agent.

Parameters
Name Description
request GetCompanionAgentRequest

The request to send to the server.

options CallOptions

The options for the call.

Returns
Type Description
CompanionAgent

The response received from the server.

GetCompanionAgent(GetCompanionAgentRequest, Metadata, DateTime?, CancellationToken)

public virtual CompanionAgent GetCompanionAgent(GetCompanionAgentRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default)

Gets a companion agent.

Parameters
Name Description
request GetCompanionAgentRequest

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
CompanionAgent

The response received from the server.

GetCompanionAgentAsync(GetCompanionAgentRequest, CallOptions)

public virtual AsyncUnaryCall<CompanionAgent> GetCompanionAgentAsync(GetCompanionAgentRequest request, CallOptions options)

Gets a companion agent.

Parameters
Name Description
request GetCompanionAgentRequest

The request to send to the server.

options CallOptions

The options for the call.

Returns
Type Description
AsyncUnaryCallCompanionAgent

The call object.

GetCompanionAgentAsync(GetCompanionAgentRequest, Metadata, DateTime?, CancellationToken)

public virtual AsyncUnaryCall<CompanionAgent> GetCompanionAgentAsync(GetCompanionAgentRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default)

Gets a companion agent.

Parameters
Name Description
request GetCompanionAgentRequest

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
AsyncUnaryCallCompanionAgent

The call object.

ListCompanionAgents(ListCompanionAgentsRequest, CallOptions)

public virtual ListCompanionAgentsResponse ListCompanionAgents(ListCompanionAgentsRequest request, CallOptions options)

Lists companion agents.

Parameters
Name Description
request ListCompanionAgentsRequest

The request to send to the server.

options CallOptions

The options for the call.

Returns
Type Description
ListCompanionAgentsResponse

The response received from the server.

ListCompanionAgents(ListCompanionAgentsRequest, Metadata, DateTime?, CancellationToken)

public virtual ListCompanionAgentsResponse ListCompanionAgents(ListCompanionAgentsRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default)

Lists companion agents.

Parameters
Name Description
request ListCompanionAgentsRequest

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
ListCompanionAgentsResponse

The response received from the server.

ListCompanionAgentsAsync(ListCompanionAgentsRequest, CallOptions)

public virtual AsyncUnaryCall<ListCompanionAgentsResponse> ListCompanionAgentsAsync(ListCompanionAgentsRequest request, CallOptions options)

Lists companion agents.

Parameters
Name Description
request ListCompanionAgentsRequest

The request to send to the server.

options CallOptions

The options for the call.

Returns
Type Description
AsyncUnaryCallListCompanionAgentsResponse

The call object.

ListCompanionAgentsAsync(ListCompanionAgentsRequest, Metadata, DateTime?, CancellationToken)

public virtual AsyncUnaryCall<ListCompanionAgentsResponse> ListCompanionAgentsAsync(ListCompanionAgentsRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default)

Lists companion agents.

Parameters
Name Description
request ListCompanionAgentsRequest

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
AsyncUnaryCallListCompanionAgentsResponse

The call object.

NewInstance(ClientBaseConfiguration)

protected override CompanionAgents.CompanionAgentsClient NewInstance(ClientBase.ClientBaseConfiguration configuration)

Creates a new instance of client from given ClientBaseConfiguration.

Parameter
Name Description
configuration ClientBaseClientBaseConfiguration
Returns
Type Description
CompanionAgentsCompanionAgentsClient
Overrides
Grpc.Core.ClientBase<Google.Cloud.Dialogflow.V2.CompanionAgents.CompanionAgentsClient>.NewInstance(Grpc.Core.ClientBase.ClientBaseConfiguration)

UpdateCompanionAgent(UpdateCompanionAgentRequest, CallOptions)

public virtual CompanionAgent UpdateCompanionAgent(UpdateCompanionAgentRequest request, CallOptions options)

Updates a companion agent.

Parameters
Name Description
request UpdateCompanionAgentRequest

The request to send to the server.

options CallOptions

The options for the call.

Returns
Type Description
CompanionAgent

The response received from the server.

UpdateCompanionAgent(UpdateCompanionAgentRequest, Metadata, DateTime?, CancellationToken)

public virtual CompanionAgent UpdateCompanionAgent(UpdateCompanionAgentRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default)

Updates a companion agent.

Parameters
Name Description
request UpdateCompanionAgentRequest

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
CompanionAgent

The response received from the server.

UpdateCompanionAgentAsync(UpdateCompanionAgentRequest, CallOptions)

public virtual AsyncUnaryCall<CompanionAgent> UpdateCompanionAgentAsync(UpdateCompanionAgentRequest request, CallOptions options)

Updates a companion agent.

Parameters
Name Description
request UpdateCompanionAgentRequest

The request to send to the server.

options CallOptions

The options for the call.

Returns
Type Description
AsyncUnaryCallCompanionAgent

The call object.

UpdateCompanionAgentAsync(UpdateCompanionAgentRequest, Metadata, DateTime?, CancellationToken)

public virtual AsyncUnaryCall<CompanionAgent> UpdateCompanionAgentAsync(UpdateCompanionAgentRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default)

Updates a companion agent.

Parameters
Name Description
request UpdateCompanionAgentRequest

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
AsyncUnaryCallCompanionAgent

The call object.