Class Agents.AgentsClient (1.0.0)

public class AgentsClient : ClientBase<Agents.AgentsClient>

Client for Agents

Inheritance

System.Object > Grpc.Core.ClientBase > Grpc.Core.ClientBase<Agents.AgentsClient> > Agents.AgentsClient

Inherited Members

Grpc.Core.ClientBase<Google.Cloud.Dialogflow.Cx.V3.Agents.AgentsClient>.WithHost(System.String)

Grpc.Core.ClientBase.CallInvoker

System.Object.ToString()

System.Object.GetHashCode()

System.Object.GetType()

System.Object.MemberwiseClone()

Namespace

Google.Cloud.Dialogflow.Cx.V3

Assembly

Google.Cloud.Dialogflow.Cx.V3.dll

Constructors

AgentsClient()

protected AgentsClient()

Protected parameterless constructor to allow creation of test doubles.

AgentsClient(CallInvoker)

public AgentsClient(CallInvoker callInvoker)

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

Parameter
Name	Description
`callInvoker`	`Grpc.Core.CallInvoker` The callInvoker to use to make remote calls.

AgentsClient(ChannelBase)

public AgentsClient(ChannelBase channel)

Creates a new client for Agents

Parameter
Name	Description
`channel`	`Grpc.Core.ChannelBase` The channel to use to make remote calls.

AgentsClient(ClientBase.ClientBaseConfiguration)

protected AgentsClient(ClientBase.ClientBaseConfiguration configuration)

Protected constructor to allow creation of configured clients.

Parameter
Name	Description
`configuration`	`Grpc.Core.ClientBase.ClientBaseConfiguration` The client configuration.

Methods

CreateAgent(CreateAgentRequest, CallOptions)

public virtual Agent CreateAgent(CreateAgentRequest request, CallOptions options)

Creates an agent in the specified location.

Parameters
Name	Description
`request`	`CreateAgentRequest` The request to send to the server.
`options`	`Grpc.Core.CallOptions` The options for the call.

Returns
Type	Description
`Agent`	The response received from the server.

CreateAgent(CreateAgentRequest, Metadata, Nullable<DateTime>, CancellationToken)

public virtual Agent CreateAgent(CreateAgentRequest request, Metadata headers = null, DateTime? deadline = default(DateTime? ), CancellationToken cancellationToken = default(CancellationToken))

Creates an agent in the specified location.

Parameters
Name	Description
`request`	`CreateAgentRequest` The request to send to the server.
`headers`	`Grpc.Core.Metadata` The initial metadata to send with the call. This parameter is optional.
`deadline`	`System.Nullable<System.DateTime>` An optional deadline for the call. The call will be cancelled if deadline is hit.
`cancellationToken`	`System.Threading.CancellationToken` An optional token for canceling the call.

Returns
Type	Description
`Agent`	The response received from the server.

CreateAgentAsync(CreateAgentRequest, CallOptions)

public virtual AsyncUnaryCall<Agent> CreateAgentAsync(CreateAgentRequest request, CallOptions options)

Creates an agent in the specified location.

Parameters
Name	Description
`request`	`CreateAgentRequest` The request to send to the server.
`options`	`Grpc.Core.CallOptions` The options for the call.

Returns
Type	Description
`Grpc.Core.AsyncUnaryCall<Agent>`	The call object.

CreateAgentAsync(CreateAgentRequest, Metadata, Nullable<DateTime>, CancellationToken)

public virtual AsyncUnaryCall<Agent> CreateAgentAsync(CreateAgentRequest request, Metadata headers = null, DateTime? deadline = default(DateTime? ), CancellationToken cancellationToken = default(CancellationToken))

Creates an agent in the specified location.

Parameters
Name	Description
`request`	`CreateAgentRequest` The request to send to the server.
`headers`	`Grpc.Core.Metadata` The initial metadata to send with the call. This parameter is optional.
`deadline`	`System.Nullable<System.DateTime>` An optional deadline for the call. The call will be cancelled if deadline is hit.
`cancellationToken`	`System.Threading.CancellationToken` An optional token for canceling the call.

Returns
Type	Description
`Grpc.Core.AsyncUnaryCall<Agent>`	The call object.

CreateOperationsClient()

public virtual Operations.OperationsClient CreateOperationsClient()

Creates a new instance of Google.LongRunning.Operations.OperationsClient using the same call invoker as this client.

Returns
Type	Description
`Google.LongRunning.Operations.OperationsClient`	A new Operations client for the same target as this client.

DeleteAgent(DeleteAgentRequest, CallOptions)

public virtual Empty DeleteAgent(DeleteAgentRequest request, CallOptions options)

Deletes the specified agent.

Parameters
Name	Description
`request`	`DeleteAgentRequest` The request to send to the server.
`options`	`Grpc.Core.CallOptions` The options for the call.

Returns
Type	Description
`Google.Protobuf.WellKnownTypes.Empty`	The response received from the server.

DeleteAgent(DeleteAgentRequest, Metadata, Nullable<DateTime>, CancellationToken)

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

Deletes the specified agent.

Parameters
Name	Description
`request`	`DeleteAgentRequest` The request to send to the server.
`headers`	`Grpc.Core.Metadata` The initial metadata to send with the call. This parameter is optional.
`deadline`	`System.Nullable<System.DateTime>` An optional deadline for the call. The call will be cancelled if deadline is hit.
`cancellationToken`	`System.Threading.CancellationToken` An optional token for canceling the call.

Returns
Type	Description
`Google.Protobuf.WellKnownTypes.Empty`	The response received from the server.

DeleteAgentAsync(DeleteAgentRequest, CallOptions)

public virtual AsyncUnaryCall<Empty> DeleteAgentAsync(DeleteAgentRequest request, CallOptions options)

Deletes the specified agent.

Parameters
Name	Description
`request`	`DeleteAgentRequest` The request to send to the server.
`options`	`Grpc.Core.CallOptions` The options for the call.

Returns
Type	Description
`Grpc.Core.AsyncUnaryCall<Google.Protobuf.WellKnownTypes.Empty>`	The call object.

DeleteAgentAsync(DeleteAgentRequest, Metadata, Nullable<DateTime>, CancellationToken)

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

Deletes the specified agent.

Parameters
Name	Description
`request`	`DeleteAgentRequest` The request to send to the server.
`headers`	`Grpc.Core.Metadata` The initial metadata to send with the call. This parameter is optional.
`deadline`	`System.Nullable<System.DateTime>` An optional deadline for the call. The call will be cancelled if deadline is hit.
`cancellationToken`	`System.Threading.CancellationToken` An optional token for canceling the call.

Returns
Type	Description
`Grpc.Core.AsyncUnaryCall<Google.Protobuf.WellKnownTypes.Empty>`	The call object.

ExportAgent(ExportAgentRequest, CallOptions)

public virtual Operation ExportAgent(ExportAgentRequest request, CallOptions options)

Exports the specified agent to a binary file.

Parameters
Name	Description
`request`	`ExportAgentRequest` The request to send to the server.
`options`	`Grpc.Core.CallOptions` The options for the call.

Returns
Type	Description
`Google.LongRunning.Operation`	The response received from the server.

ExportAgent(ExportAgentRequest, Metadata, Nullable<DateTime>, CancellationToken)

public virtual Operation ExportAgent(ExportAgentRequest request, Metadata headers = null, DateTime? deadline = default(DateTime? ), CancellationToken cancellationToken = default(CancellationToken))

Exports the specified agent to a binary file.

Parameters
Name	Description
`request`	`ExportAgentRequest` The request to send to the server.
`headers`	`Grpc.Core.Metadata` The initial metadata to send with the call. This parameter is optional.
`deadline`	`System.Nullable<System.DateTime>` An optional deadline for the call. The call will be cancelled if deadline is hit.
`cancellationToken`	`System.Threading.CancellationToken` An optional token for canceling the call.

Returns
Type	Description
`Google.LongRunning.Operation`	The response received from the server.

ExportAgentAsync(ExportAgentRequest, CallOptions)

public virtual AsyncUnaryCall<Operation> ExportAgentAsync(ExportAgentRequest request, CallOptions options)

Exports the specified agent to a binary file.

Parameters
Name	Description
`request`	`ExportAgentRequest` The request to send to the server.
`options`	`Grpc.Core.CallOptions` The options for the call.

Returns
Type	Description
`Grpc.Core.AsyncUnaryCall<Google.LongRunning.Operation>`	The call object.

ExportAgentAsync(ExportAgentRequest, Metadata, Nullable<DateTime>, CancellationToken)

public virtual AsyncUnaryCall<Operation> ExportAgentAsync(ExportAgentRequest request, Metadata headers = null, DateTime? deadline = default(DateTime? ), CancellationToken cancellationToken = default(CancellationToken))

Exports the specified agent to a binary file.

Parameters
Name	Description
`request`	`ExportAgentRequest` The request to send to the server.
`headers`	`Grpc.Core.Metadata` The initial metadata to send with the call. This parameter is optional.
`deadline`	`System.Nullable<System.DateTime>` An optional deadline for the call. The call will be cancelled if deadline is hit.
`cancellationToken`	`System.Threading.CancellationToken` An optional token for canceling the call.

Returns
Type	Description
`Grpc.Core.AsyncUnaryCall<Google.LongRunning.Operation>`	The call object.

GetAgent(GetAgentRequest, CallOptions)

public virtual Agent GetAgent(GetAgentRequest request, CallOptions options)

Retrieves the specified agent.

Parameters
Name	Description
`request`	`GetAgentRequest` The request to send to the server.
`options`	`Grpc.Core.CallOptions` The options for the call.

Returns
Type	Description
`Agent`	The response received from the server.

GetAgent(GetAgentRequest, Metadata, Nullable<DateTime>, CancellationToken)

public virtual Agent GetAgent(GetAgentRequest request, Metadata headers = null, DateTime? deadline = default(DateTime? ), CancellationToken cancellationToken = default(CancellationToken))

Retrieves the specified agent.

Parameters
Name	Description
`request`	`GetAgentRequest` The request to send to the server.
`headers`	`Grpc.Core.Metadata` The initial metadata to send with the call. This parameter is optional.
`deadline`	`System.Nullable<System.DateTime>` An optional deadline for the call. The call will be cancelled if deadline is hit.
`cancellationToken`	`System.Threading.CancellationToken` An optional token for canceling the call.

Returns
Type	Description
`Agent`	The response received from the server.

GetAgentAsync(GetAgentRequest, CallOptions)

public virtual AsyncUnaryCall<Agent> GetAgentAsync(GetAgentRequest request, CallOptions options)

Retrieves the specified agent.

Parameters
Name	Description
`request`	`GetAgentRequest` The request to send to the server.
`options`	`Grpc.Core.CallOptions` The options for the call.

Returns
Type	Description
`Grpc.Core.AsyncUnaryCall<Agent>`	The call object.

GetAgentAsync(GetAgentRequest, Metadata, Nullable<DateTime>, CancellationToken)

public virtual AsyncUnaryCall<Agent> GetAgentAsync(GetAgentRequest request, Metadata headers = null, DateTime? deadline = default(DateTime? ), CancellationToken cancellationToken = default(CancellationToken))

Retrieves the specified agent.

Parameters
Name	Description
`request`	`GetAgentRequest` The request to send to the server.
`headers`	`Grpc.Core.Metadata` The initial metadata to send with the call. This parameter is optional.
`deadline`	`System.Nullable<System.DateTime>` An optional deadline for the call. The call will be cancelled if deadline is hit.
`cancellationToken`	`System.Threading.CancellationToken` An optional token for canceling the call.

Returns
Type	Description
`Grpc.Core.AsyncUnaryCall<Agent>`	The call object.

ListAgents(ListAgentsRequest, CallOptions)

public virtual ListAgentsResponse ListAgents(ListAgentsRequest request, CallOptions options)

Returns the list of all agents in the specified location.

Parameters
Name	Description
`request`	`ListAgentsRequest` The request to send to the server.
`options`	`Grpc.Core.CallOptions` The options for the call.

Returns
Type	Description
`ListAgentsResponse`	The response received from the server.

ListAgents(ListAgentsRequest, Metadata, Nullable<DateTime>, CancellationToken)

public virtual ListAgentsResponse ListAgents(ListAgentsRequest request, Metadata headers = null, DateTime? deadline = default(DateTime? ), CancellationToken cancellationToken = default(CancellationToken))

Returns the list of all agents in the specified location.

Parameters
Name	Description
`request`	`ListAgentsRequest` The request to send to the server.
`headers`	`Grpc.Core.Metadata` The initial metadata to send with the call. This parameter is optional.
`deadline`	`System.Nullable<System.DateTime>` An optional deadline for the call. The call will be cancelled if deadline is hit.
`cancellationToken`	`System.Threading.CancellationToken` An optional token for canceling the call.

Returns
Type	Description
`ListAgentsResponse`	The response received from the server.

ListAgentsAsync(ListAgentsRequest, CallOptions)

public virtual AsyncUnaryCall<ListAgentsResponse> ListAgentsAsync(ListAgentsRequest request, CallOptions options)

Returns the list of all agents in the specified location.

Parameters
Name	Description
`request`	`ListAgentsRequest` The request to send to the server.
`options`	`Grpc.Core.CallOptions` The options for the call.

Returns
Type	Description
`Grpc.Core.AsyncUnaryCall<ListAgentsResponse>`	The call object.

ListAgentsAsync(ListAgentsRequest, Metadata, Nullable<DateTime>, CancellationToken)

public virtual AsyncUnaryCall<ListAgentsResponse> ListAgentsAsync(ListAgentsRequest request, Metadata headers = null, DateTime? deadline = default(DateTime? ), CancellationToken cancellationToken = default(CancellationToken))

Returns the list of all agents in the specified location.

Parameters
Name	Description
`request`	`ListAgentsRequest` The request to send to the server.
`headers`	`Grpc.Core.Metadata` The initial metadata to send with the call. This parameter is optional.
`deadline`	`System.Nullable<System.DateTime>` An optional deadline for the call. The call will be cancelled if deadline is hit.
`cancellationToken`	`System.Threading.CancellationToken` An optional token for canceling the call.

Returns
Type	Description
`Grpc.Core.AsyncUnaryCall<ListAgentsResponse>`	The call object.

NewInstance(ClientBase.ClientBaseConfiguration)

protected override Agents.AgentsClient NewInstance(ClientBase.ClientBaseConfiguration configuration)

Creates a new instance of client from given ClientBaseConfiguration.

Parameter
Name	Description
`configuration`	`Grpc.Core.ClientBase.ClientBaseConfiguration`

Returns
Type	Description
`Agents.AgentsClient`

Overrides

Grpc.Core.ClientBase<Google.Cloud.Dialogflow.Cx.V3.Agents.AgentsClient>.NewInstance(Grpc.Core.ClientBase.ClientBaseConfiguration)

RestoreAgent(RestoreAgentRequest, CallOptions)

public virtual Operation RestoreAgent(RestoreAgentRequest request, CallOptions options)

Restores the specified agent from a binary file.

Replaces the current agent with a new one. Note that all existing resources in agent (e.g. intents, entity types, flows) will be removed.

Parameters
Name	Description
`request`	`RestoreAgentRequest` The request to send to the server.
`options`	`Grpc.Core.CallOptions` The options for the call.

Returns
Type	Description
`Google.LongRunning.Operation`	The response received from the server.

RestoreAgent(RestoreAgentRequest, Metadata, Nullable<DateTime>, CancellationToken)

public virtual Operation RestoreAgent(RestoreAgentRequest request, Metadata headers = null, DateTime? deadline = default(DateTime? ), CancellationToken cancellationToken = default(CancellationToken))

Restores the specified agent from a binary file.

Replaces the current agent with a new one. Note that all existing resources in agent (e.g. intents, entity types, flows) will be removed.

Parameters
Name	Description
`request`	`RestoreAgentRequest` The request to send to the server.
`headers`	`Grpc.Core.Metadata` The initial metadata to send with the call. This parameter is optional.
`deadline`	`System.Nullable<System.DateTime>` An optional deadline for the call. The call will be cancelled if deadline is hit.
`cancellationToken`	`System.Threading.CancellationToken` An optional token for canceling the call.

Returns
Type	Description
`Google.LongRunning.Operation`	The response received from the server.

RestoreAgentAsync(RestoreAgentRequest, CallOptions)

public virtual AsyncUnaryCall<Operation> RestoreAgentAsync(RestoreAgentRequest request, CallOptions options)

Restores the specified agent from a binary file.

Replaces the current agent with a new one. Note that all existing resources in agent (e.g. intents, entity types, flows) will be removed.

Parameters
Name	Description
`request`	`RestoreAgentRequest` The request to send to the server.
`options`	`Grpc.Core.CallOptions` The options for the call.

Returns
Type	Description
`Grpc.Core.AsyncUnaryCall<Google.LongRunning.Operation>`	The call object.

RestoreAgentAsync(RestoreAgentRequest, Metadata, Nullable<DateTime>, CancellationToken)

public virtual AsyncUnaryCall<Operation> RestoreAgentAsync(RestoreAgentRequest request, Metadata headers = null, DateTime? deadline = default(DateTime? ), CancellationToken cancellationToken = default(CancellationToken))

Restores the specified agent from a binary file.

Replaces the current agent with a new one. Note that all existing resources in agent (e.g. intents, entity types, flows) will be removed.

Parameters
Name	Description
`request`	`RestoreAgentRequest` The request to send to the server.
`headers`	`Grpc.Core.Metadata` The initial metadata to send with the call. This parameter is optional.
`deadline`	`System.Nullable<System.DateTime>` An optional deadline for the call. The call will be cancelled if deadline is hit.
`cancellationToken`	`System.Threading.CancellationToken` An optional token for canceling the call.

Returns
Type	Description
`Grpc.Core.AsyncUnaryCall<Google.LongRunning.Operation>`	The call object.

UpdateAgent(UpdateAgentRequest, CallOptions)

public virtual Agent UpdateAgent(UpdateAgentRequest request, CallOptions options)

Updates the specified agent.

Parameters
Name	Description
`request`	`UpdateAgentRequest` The request to send to the server.
`options`	`Grpc.Core.CallOptions` The options for the call.

Returns
Type	Description
`Agent`	The response received from the server.

UpdateAgent(UpdateAgentRequest, Metadata, Nullable<DateTime>, CancellationToken)

public virtual Agent UpdateAgent(UpdateAgentRequest request, Metadata headers = null, DateTime? deadline = default(DateTime? ), CancellationToken cancellationToken = default(CancellationToken))

Updates the specified agent.

Parameters
Name	Description
`request`	`UpdateAgentRequest` The request to send to the server.
`headers`	`Grpc.Core.Metadata` The initial metadata to send with the call. This parameter is optional.
`deadline`	`System.Nullable<System.DateTime>` An optional deadline for the call. The call will be cancelled if deadline is hit.
`cancellationToken`	`System.Threading.CancellationToken` An optional token for canceling the call.

Returns
Type	Description
`Agent`	The response received from the server.

UpdateAgentAsync(UpdateAgentRequest, CallOptions)

public virtual AsyncUnaryCall<Agent> UpdateAgentAsync(UpdateAgentRequest request, CallOptions options)

Updates the specified agent.

Parameters
Name	Description
`request`	`UpdateAgentRequest` The request to send to the server.
`options`	`Grpc.Core.CallOptions` The options for the call.

Returns
Type	Description
`Grpc.Core.AsyncUnaryCall<Agent>`	The call object.

UpdateAgentAsync(UpdateAgentRequest, Metadata, Nullable<DateTime>, CancellationToken)

public virtual AsyncUnaryCall<Agent> UpdateAgentAsync(UpdateAgentRequest request, Metadata headers = null, DateTime? deadline = default(DateTime? ), CancellationToken cancellationToken = default(CancellationToken))

Updates the specified agent.

Parameters
Name	Description
`request`	`UpdateAgentRequest` The request to send to the server.
`headers`	`Grpc.Core.Metadata` The initial metadata to send with the call. This parameter is optional.
`deadline`	`System.Nullable<System.DateTime>` An optional deadline for the call. The call will be cancelled if deadline is hit.
`cancellationToken`	`System.Threading.CancellationToken` An optional token for canceling the call.

Returns
Type	Description
`Grpc.Core.AsyncUnaryCall<Agent>`	The call object.