Class AgentsClient (1.0.0) 

public abstract class AgentsClient

Agents client wrapper, for convenient use.

Inheritance

System.Object > AgentsClient

Namespace

Google.Cloud.Dialogflow.Cx.V3

Assembly

Google.Cloud.Dialogflow.Cx.V3.dll

Remarks

Service for managing [Agents][google.cloud.dialogflow.cx.v3.Agent].

Properties

DefaultEndpoint

public static string DefaultEndpoint { get; }

The default endpoint for the Agents service, which is a host of "dialogflow.googleapis.com" and a port of 443.

Property Value
Type Description
System.String

DefaultScopes

public static IReadOnlyList<string> DefaultScopes { get; }

The default Agents scopes.

Property Value
Type Description
System.Collections.Generic.IReadOnlyList<System.String>
Remarks

The default Agents scopes are:

ExportAgentOperationsClient

public virtual OperationsClient ExportAgentOperationsClient { get; }

The long-running operations client for ExportAgent.

Property Value
Type Description
Google.LongRunning.OperationsClient

GrpcClient

public virtual Agents.AgentsClient GrpcClient { get; }

The underlying gRPC Agents client

Property Value
Type Description
Agents.AgentsClient

RestoreAgentOperationsClient

public virtual OperationsClient RestoreAgentOperationsClient { get; }

The long-running operations client for RestoreAgent.

Property Value
Type Description
Google.LongRunning.OperationsClient

Methods

Create()

public static AgentsClient Create()

Synchronously creates a AgentsClient using the default credentials, endpoint and settings. To specify custom credentials or other settings, use AgentsClientBuilder.

Returns
Type Description
AgentsClient

The created AgentsClient.

CreateAgent(LocationName, Agent, CallSettings)

public virtual Agent CreateAgent(LocationName parent, Agent agent, CallSettings callSettings = null)

Creates an agent in the specified location.

Parameters
Name Description
parent Google.Api.Gax.ResourceNames.LocationName

Required. The location to create a agent for. Format: projects/&amp;lt;Project ID&amp;gt;/locations/&amp;lt;Location ID&amp;gt;.
agent Agent

Required. The agent to create.
callSettings Google.Api.Gax.Grpc.CallSettings

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

The RPC response.

CreateAgent(CreateAgentRequest, CallSettings)

public virtual Agent CreateAgent(CreateAgentRequest request, CallSettings callSettings = null)

Creates an agent in the specified location.

Parameters
Name Description
request CreateAgentRequest

The request object containing all of the parameters for the API call.
callSettings Google.Api.Gax.Grpc.CallSettings

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

The RPC response.

CreateAgent(String, Agent, CallSettings)

public virtual Agent CreateAgent(string parent, Agent agent, CallSettings callSettings = null)

Creates an agent in the specified location.

Parameters
Name Description
parent System.String

Required. The location to create a agent for. Format: projects/&amp;lt;Project ID&amp;gt;/locations/&amp;lt;Location ID&amp;gt;.
agent Agent

Required. The agent to create.
callSettings Google.Api.Gax.Grpc.CallSettings

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

The RPC response.

CreateAgentAsync(LocationName, Agent, CallSettings)

public virtual Task<Agent> CreateAgentAsync(LocationName parent, Agent agent, CallSettings callSettings = null)

Creates an agent in the specified location.

Parameters
Name Description
parent Google.Api.Gax.ResourceNames.LocationName

Required. The location to create a agent for. Format: projects/&amp;lt;Project ID&amp;gt;/locations/&amp;lt;Location ID&amp;gt;.
agent Agent

Required. The agent to create.
callSettings Google.Api.Gax.Grpc.CallSettings

If not null, applies overrides to this RPC call.
Returns
Type Description
System.Threading.Tasks.Task<Agent>

A Task containing the RPC response.

CreateAgentAsync(LocationName, Agent, CancellationToken)

public virtual Task<Agent> CreateAgentAsync(LocationName parent, Agent agent, CancellationToken cancellationToken)

Creates an agent in the specified location.

Parameters
Name Description
parent Google.Api.Gax.ResourceNames.LocationName

Required. The location to create a agent for. Format: projects/&amp;lt;Project ID&amp;gt;/locations/&amp;lt;Location ID&amp;gt;.
agent Agent

Required. The agent to create.
cancellationToken System.Threading.CancellationToken

A System.Threading.CancellationToken to use for this RPC.
Returns
Type Description
System.Threading.Tasks.Task<Agent>

A Task containing the RPC response.

CreateAgentAsync(CreateAgentRequest, CallSettings)

public virtual Task<Agent> CreateAgentAsync(CreateAgentRequest request, CallSettings callSettings = null)

Creates an agent in the specified location.

Parameters
Name Description
request CreateAgentRequest

The request object containing all of the parameters for the API call.
callSettings Google.Api.Gax.Grpc.CallSettings

If not null, applies overrides to this RPC call.
Returns
Type Description
System.Threading.Tasks.Task<Agent>

A Task containing the RPC response.

CreateAgentAsync(CreateAgentRequest, CancellationToken)

public virtual Task<Agent> CreateAgentAsync(CreateAgentRequest request, CancellationToken cancellationToken)

Creates an agent in the specified location.

Parameters
Name Description
request CreateAgentRequest

The request object containing all of the parameters for the API call.
cancellationToken System.Threading.CancellationToken

A System.Threading.CancellationToken to use for this RPC.
Returns
Type Description
System.Threading.Tasks.Task<Agent>

A Task containing the RPC response.

CreateAgentAsync(String, Agent, CallSettings)

public virtual Task<Agent> CreateAgentAsync(string parent, Agent agent, CallSettings callSettings = null)

Creates an agent in the specified location.

Parameters
Name Description
parent System.String

Required. The location to create a agent for. Format: projects/&amp;lt;Project ID&amp;gt;/locations/&amp;lt;Location ID&amp;gt;.
agent Agent

Required. The agent to create.
callSettings Google.Api.Gax.Grpc.CallSettings

If not null, applies overrides to this RPC call.
Returns
Type Description
System.Threading.Tasks.Task<Agent>

A Task containing the RPC response.

CreateAgentAsync(String, Agent, CancellationToken)

public virtual Task<Agent> CreateAgentAsync(string parent, Agent agent, CancellationToken cancellationToken)

Creates an agent in the specified location.

Parameters
Name Description
parent System.String

Required. The location to create a agent for. Format: projects/&amp;lt;Project ID&amp;gt;/locations/&amp;lt;Location ID&amp;gt;.
agent Agent

Required. The agent to create.
cancellationToken System.Threading.CancellationToken

A System.Threading.CancellationToken to use for this RPC.
Returns
Type Description
System.Threading.Tasks.Task<Agent>

A Task containing the RPC response.

CreateAsync(CancellationToken)

public static Task<AgentsClient> CreateAsync(CancellationToken cancellationToken = default(CancellationToken))

Asynchronously creates a AgentsClient using the default credentials, endpoint and settings. To specify custom credentials or other settings, use AgentsClientBuilder.

Parameter
Name Description
cancellationToken System.Threading.CancellationToken

The System.Threading.CancellationToken to use while creating the client.
Returns
Type Description
System.Threading.Tasks.Task<AgentsClient>

The task representing the created AgentsClient.

DeleteAgent(AgentName, CallSettings)

public virtual void DeleteAgent(AgentName name, CallSettings callSettings = null)

Deletes the specified agent.

Parameters
Name Description
name AgentName

Required. The name of the agent to delete. Format: projects/&amp;lt;Project ID&amp;gt;/locations/&amp;lt;Location ID&amp;gt;/agents/&amp;lt;Agent ID&amp;gt;.
callSettings Google.Api.Gax.Grpc.CallSettings

If not null, applies overrides to this RPC call.

DeleteAgent(DeleteAgentRequest, CallSettings)

public virtual void DeleteAgent(DeleteAgentRequest request, CallSettings callSettings = null)

Deletes the specified agent.

Parameters
Name Description
request DeleteAgentRequest

The request object containing all of the parameters for the API call.
callSettings Google.Api.Gax.Grpc.CallSettings

If not null, applies overrides to this RPC call.

DeleteAgent(String, CallSettings)

public virtual void DeleteAgent(string name, CallSettings callSettings = null)

Deletes the specified agent.

Parameters
Name Description
name System.String

Required. The name of the agent to delete. Format: projects/&amp;lt;Project ID&amp;gt;/locations/&amp;lt;Location ID&amp;gt;/agents/&amp;lt;Agent ID&amp;gt;.
callSettings Google.Api.Gax.Grpc.CallSettings

If not null, applies overrides to this RPC call.

DeleteAgentAsync(AgentName, CallSettings)

public virtual Task DeleteAgentAsync(AgentName name, CallSettings callSettings = null)

Deletes the specified agent.

Parameters
Name Description
name AgentName

Required. The name of the agent to delete. Format: projects/&amp;lt;Project ID&amp;gt;/locations/&amp;lt;Location ID&amp;gt;/agents/&amp;lt;Agent ID&amp;gt;.
callSettings Google.Api.Gax.Grpc.CallSettings

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

A Task containing the RPC response.

DeleteAgentAsync(AgentName, CancellationToken)

public virtual Task DeleteAgentAsync(AgentName name, CancellationToken cancellationToken)

Deletes the specified agent.

Parameters
Name Description
name AgentName

Required. The name of the agent to delete. Format: projects/&amp;lt;Project ID&amp;gt;/locations/&amp;lt;Location ID&amp;gt;/agents/&amp;lt;Agent ID&amp;gt;.
cancellationToken System.Threading.CancellationToken

A System.Threading.CancellationToken to use for this RPC.
Returns
Type Description
System.Threading.Tasks.Task

A Task containing the RPC response.

DeleteAgentAsync(DeleteAgentRequest, CallSettings)

public virtual Task DeleteAgentAsync(DeleteAgentRequest request, CallSettings callSettings = null)

Deletes the specified agent.

Parameters
Name Description
request DeleteAgentRequest

The request object containing all of the parameters for the API call.
callSettings Google.Api.Gax.Grpc.CallSettings

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

A Task containing the RPC response.

DeleteAgentAsync(DeleteAgentRequest, CancellationToken)

public virtual Task DeleteAgentAsync(DeleteAgentRequest request, CancellationToken cancellationToken)

Deletes the specified agent.

Parameters
Name Description
request DeleteAgentRequest

The request object containing all of the parameters for the API call.
cancellationToken System.Threading.CancellationToken

A System.Threading.CancellationToken to use for this RPC.
Returns
Type Description
System.Threading.Tasks.Task

A Task containing the RPC response.

DeleteAgentAsync(String, CallSettings)

public virtual Task DeleteAgentAsync(string name, CallSettings callSettings = null)

Deletes the specified agent.

Parameters
Name Description
name System.String

Required. The name of the agent to delete. Format: projects/&amp;lt;Project ID&amp;gt;/locations/&amp;lt;Location ID&amp;gt;/agents/&amp;lt;Agent ID&amp;gt;.
callSettings Google.Api.Gax.Grpc.CallSettings

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

A Task containing the RPC response.

DeleteAgentAsync(String, CancellationToken)

public virtual Task DeleteAgentAsync(string name, CancellationToken cancellationToken)

Deletes the specified agent.

Parameters
Name Description
name System.String

Required. The name of the agent to delete. Format: projects/&amp;lt;Project ID&amp;gt;/locations/&amp;lt;Location ID&amp;gt;/agents/&amp;lt;Agent ID&amp;gt;.
cancellationToken System.Threading.CancellationToken

A System.Threading.CancellationToken to use for this RPC.
Returns
Type Description
System.Threading.Tasks.Task

A Task containing the RPC response.

ExportAgent(ExportAgentRequest, CallSettings)

public virtual Operation<ExportAgentResponse, Struct> ExportAgent(ExportAgentRequest request, CallSettings callSettings = null)

Exports the specified agent to a binary file.

Parameters
Name Description
request ExportAgentRequest

The request object containing all of the parameters for the API call.
callSettings Google.Api.Gax.Grpc.CallSettings

If not null, applies overrides to this RPC call.
Returns
Type Description
Google.LongRunning.Operation<ExportAgentResponse, Google.Protobuf.WellKnownTypes.Struct>

The RPC response.

ExportAgentAsync(ExportAgentRequest, CallSettings)

public virtual Task<Operation<ExportAgentResponse, Struct>> ExportAgentAsync(ExportAgentRequest request, CallSettings callSettings = null)

Exports the specified agent to a binary file.

Parameters
Name Description
request ExportAgentRequest

The request object containing all of the parameters for the API call.
callSettings Google.Api.Gax.Grpc.CallSettings

If not null, applies overrides to this RPC call.
Returns
Type Description
System.Threading.Tasks.Task<Google.LongRunning.Operation<ExportAgentResponse, Google.Protobuf.WellKnownTypes.Struct>>

A Task containing the RPC response.

ExportAgentAsync(ExportAgentRequest, CancellationToken)

public virtual Task<Operation<ExportAgentResponse, Struct>> ExportAgentAsync(ExportAgentRequest request, CancellationToken cancellationToken)

Exports the specified agent to a binary file.

Parameters
Name Description
request ExportAgentRequest

The request object containing all of the parameters for the API call.
cancellationToken System.Threading.CancellationToken

A System.Threading.CancellationToken to use for this RPC.
Returns
Type Description
System.Threading.Tasks.Task<Google.LongRunning.Operation<ExportAgentResponse, Google.Protobuf.WellKnownTypes.Struct>>

A Task containing the RPC response.

GetAgent(AgentName, CallSettings)

public virtual Agent GetAgent(AgentName name, CallSettings callSettings = null)

Retrieves the specified agent.

Parameters
Name Description
name AgentName

Required. The name of the agent. Format: projects/&amp;lt;Project ID&amp;gt;/locations/&amp;lt;Location ID&amp;gt;/agents/&amp;lt;Agent ID&amp;gt;.
callSettings Google.Api.Gax.Grpc.CallSettings

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

The RPC response.

GetAgent(GetAgentRequest, CallSettings)

public virtual Agent GetAgent(GetAgentRequest request, CallSettings callSettings = null)

Retrieves the specified agent.

Parameters
Name Description
request GetAgentRequest

The request object containing all of the parameters for the API call.
callSettings Google.Api.Gax.Grpc.CallSettings

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

The RPC response.

GetAgent(String, CallSettings)

public virtual Agent GetAgent(string name, CallSettings callSettings = null)

Retrieves the specified agent.

Parameters
Name Description
name System.String

Required. The name of the agent. Format: projects/&amp;lt;Project ID&amp;gt;/locations/&amp;lt;Location ID&amp;gt;/agents/&amp;lt;Agent ID&amp;gt;.
callSettings Google.Api.Gax.Grpc.CallSettings

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

The RPC response.

GetAgentAsync(AgentName, CallSettings)

public virtual Task<Agent> GetAgentAsync(AgentName name, CallSettings callSettings = null)

Retrieves the specified agent.

Parameters
Name Description
name AgentName

Required. The name of the agent. Format: projects/&amp;lt;Project ID&amp;gt;/locations/&amp;lt;Location ID&amp;gt;/agents/&amp;lt;Agent ID&amp;gt;.
callSettings Google.Api.Gax.Grpc.CallSettings

If not null, applies overrides to this RPC call.
Returns
Type Description
System.Threading.Tasks.Task<Agent>

A Task containing the RPC response.

GetAgentAsync(AgentName, CancellationToken)

public virtual Task<Agent> GetAgentAsync(AgentName name, CancellationToken cancellationToken)

Retrieves the specified agent.

Parameters
Name Description
name AgentName

Required. The name of the agent. Format: projects/&amp;lt;Project ID&amp;gt;/locations/&amp;lt;Location ID&amp;gt;/agents/&amp;lt;Agent ID&amp;gt;.
cancellationToken System.Threading.CancellationToken

A System.Threading.CancellationToken to use for this RPC.
Returns
Type Description
System.Threading.Tasks.Task<Agent>

A Task containing the RPC response.

GetAgentAsync(GetAgentRequest, CallSettings)

public virtual Task<Agent> GetAgentAsync(GetAgentRequest request, CallSettings callSettings = null)

Retrieves the specified agent.

Parameters
Name Description
request GetAgentRequest

The request object containing all of the parameters for the API call.
callSettings Google.Api.Gax.Grpc.CallSettings

If not null, applies overrides to this RPC call.
Returns
Type Description
System.Threading.Tasks.Task<Agent>

A Task containing the RPC response.

GetAgentAsync(GetAgentRequest, CancellationToken)

public virtual Task<Agent> GetAgentAsync(GetAgentRequest request, CancellationToken cancellationToken)

Retrieves the specified agent.

Parameters
Name Description
request GetAgentRequest

The request object containing all of the parameters for the API call.
cancellationToken System.Threading.CancellationToken

A System.Threading.CancellationToken to use for this RPC.
Returns
Type Description
System.Threading.Tasks.Task<Agent>

A Task containing the RPC response.

GetAgentAsync(String, CallSettings)

public virtual Task<Agent> GetAgentAsync(string name, CallSettings callSettings = null)

Retrieves the specified agent.

Parameters
Name Description
name System.String

Required. The name of the agent. Format: projects/&amp;lt;Project ID&amp;gt;/locations/&amp;lt;Location ID&amp;gt;/agents/&amp;lt;Agent ID&amp;gt;.
callSettings Google.Api.Gax.Grpc.CallSettings

If not null, applies overrides to this RPC call.
Returns
Type Description
System.Threading.Tasks.Task<Agent>

A Task containing the RPC response.

GetAgentAsync(String, CancellationToken)

public virtual Task<Agent> GetAgentAsync(string name, CancellationToken cancellationToken)

Retrieves the specified agent.

Parameters
Name Description
name System.String

Required. The name of the agent. Format: projects/&amp;lt;Project ID&amp;gt;/locations/&amp;lt;Location ID&amp;gt;/agents/&amp;lt;Agent ID&amp;gt;.
cancellationToken System.Threading.CancellationToken

A System.Threading.CancellationToken to use for this RPC.
Returns
Type Description
System.Threading.Tasks.Task<Agent>

A Task containing the RPC response.

ListAgents(LocationName, String, Nullable<Int32>, CallSettings)

public virtual PagedEnumerable<ListAgentsResponse, Agent> ListAgents(LocationName parent, string pageToken = null, int? pageSize = default(int? ), CallSettings callSettings = null)

Returns the list of all agents in the specified location.

Parameters
Name Description
parent Google.Api.Gax.ResourceNames.LocationName

Required. The location to list all agents for. Format: projects/&amp;lt;Project ID&amp;gt;/locations/&amp;lt;Location ID&amp;gt;.
pageToken System.String

The token returned from the previous request. A value of null or an empty string retrieves the first page.
pageSize System.Nullable<System.Int32>

The size of page to request. The response will not be larger than this, but may be smaller. A value of null or 0 uses a server-defined page size.
callSettings Google.Api.Gax.Grpc.CallSettings

If not null, applies overrides to this RPC call.
Returns
Type Description
Google.Api.Gax.PagedEnumerable<ListAgentsResponse, Agent>

A pageable sequence of Agent resources.

ListAgents(ListAgentsRequest, CallSettings)

public virtual PagedEnumerable<ListAgentsResponse, Agent> ListAgents(ListAgentsRequest request, CallSettings callSettings = null)

Returns the list of all agents in the specified location.

Parameters
Name Description
request ListAgentsRequest

The request object containing all of the parameters for the API call.
callSettings Google.Api.Gax.Grpc.CallSettings

If not null, applies overrides to this RPC call.
Returns
Type Description
Google.Api.Gax.PagedEnumerable<ListAgentsResponse, Agent>

A pageable sequence of Agent resources.

ListAgents(String, String, Nullable<Int32>, CallSettings)

public virtual PagedEnumerable<ListAgentsResponse, Agent> ListAgents(string parent, string pageToken = null, int? pageSize = default(int? ), CallSettings callSettings = null)

Returns the list of all agents in the specified location.

Parameters
Name Description
parent System.String

Required. The location to list all agents for. Format: projects/&amp;lt;Project ID&amp;gt;/locations/&amp;lt;Location ID&amp;gt;.
pageToken System.String

The token returned from the previous request. A value of null or an empty string retrieves the first page.
pageSize System.Nullable<System.Int32>

The size of page to request. The response will not be larger than this, but may be smaller. A value of null or 0 uses a server-defined page size.
callSettings Google.Api.Gax.Grpc.CallSettings

If not null, applies overrides to this RPC call.
Returns
Type Description
Google.Api.Gax.PagedEnumerable<ListAgentsResponse, Agent>

A pageable sequence of Agent resources.

ListAgentsAsync(LocationName, String, Nullable<Int32>, CallSettings)

public virtual PagedAsyncEnumerable<ListAgentsResponse, Agent> ListAgentsAsync(LocationName parent, string pageToken = null, int? pageSize = default(int? ), CallSettings callSettings = null)

Returns the list of all agents in the specified location.

Parameters
Name Description
parent Google.Api.Gax.ResourceNames.LocationName

Required. The location to list all agents for. Format: projects/&amp;lt;Project ID&amp;gt;/locations/&amp;lt;Location ID&amp;gt;.
pageToken System.String

The token returned from the previous request. A value of null or an empty string retrieves the first page.
pageSize System.Nullable<System.Int32>

The size of page to request. The response will not be larger than this, but may be smaller. A value of null or 0 uses a server-defined page size.
callSettings Google.Api.Gax.Grpc.CallSettings

If not null, applies overrides to this RPC call.
Returns
Type Description
Google.Api.Gax.PagedAsyncEnumerable<ListAgentsResponse, Agent>

A pageable asynchronous sequence of Agent resources.

ListAgentsAsync(ListAgentsRequest, CallSettings)

public virtual PagedAsyncEnumerable<ListAgentsResponse, Agent> ListAgentsAsync(ListAgentsRequest request, CallSettings callSettings = null)

Returns the list of all agents in the specified location.

Parameters
Name Description
request ListAgentsRequest

The request object containing all of the parameters for the API call.
callSettings Google.Api.Gax.Grpc.CallSettings

If not null, applies overrides to this RPC call.
Returns
Type Description
Google.Api.Gax.PagedAsyncEnumerable<ListAgentsResponse, Agent>

A pageable asynchronous sequence of Agent resources.

ListAgentsAsync(String, String, Nullable<Int32>, CallSettings)

public virtual PagedAsyncEnumerable<ListAgentsResponse, Agent> ListAgentsAsync(string parent, string pageToken = null, int? pageSize = default(int? ), CallSettings callSettings = null)

Returns the list of all agents in the specified location.

Parameters
Name Description
parent System.String

Required. The location to list all agents for. Format: projects/&amp;lt;Project ID&amp;gt;/locations/&amp;lt;Location ID&amp;gt;.
pageToken System.String

The token returned from the previous request. A value of null or an empty string retrieves the first page.
pageSize System.Nullable<System.Int32>

The size of page to request. The response will not be larger than this, but may be smaller. A value of null or 0 uses a server-defined page size.
callSettings Google.Api.Gax.Grpc.CallSettings

If not null, applies overrides to this RPC call.
Returns
Type Description
Google.Api.Gax.PagedAsyncEnumerable<ListAgentsResponse, Agent>

A pageable asynchronous sequence of Agent resources.

PollOnceExportAgent(String, CallSettings)

public virtual Operation<ExportAgentResponse, Struct> PollOnceExportAgent(string operationName, CallSettings callSettings = null)

Poll an operation once, using an operationName from a previous invocation of ExportAgent.

Parameters
Name Description
operationName System.String

The name of a previously invoked operation. Must not be null or empty.
callSettings Google.Api.Gax.Grpc.CallSettings

If not null, applies overrides to this RPC call.
Returns
Type Description
Google.LongRunning.Operation<ExportAgentResponse, Google.Protobuf.WellKnownTypes.Struct>

The result of polling the operation.

PollOnceExportAgentAsync(String, CallSettings)

public virtual Task<Operation<ExportAgentResponse, Struct>> PollOnceExportAgentAsync(string operationName, CallSettings callSettings = null)

Asynchronously poll an operation once, using an operationName from a previous invocation of ExportAgent.

Parameters
Name Description
operationName System.String

The name of a previously invoked operation. Must not be null or empty.
callSettings Google.Api.Gax.Grpc.CallSettings

If not null, applies overrides to this RPC call.
Returns
Type Description
System.Threading.Tasks.Task<Google.LongRunning.Operation<ExportAgentResponse, Google.Protobuf.WellKnownTypes.Struct>>

A task representing the result of polling the operation.

PollOnceRestoreAgent(String, CallSettings)

public virtual Operation<Empty, Struct> PollOnceRestoreAgent(string operationName, CallSettings callSettings = null)

Poll an operation once, using an operationName from a previous invocation of RestoreAgent.

Parameters
Name Description
operationName System.String

The name of a previously invoked operation. Must not be null or empty.
callSettings Google.Api.Gax.Grpc.CallSettings

If not null, applies overrides to this RPC call.
Returns
Type Description
Google.LongRunning.Operation<Google.Protobuf.WellKnownTypes.Empty, Google.Protobuf.WellKnownTypes.Struct>

The result of polling the operation.

PollOnceRestoreAgentAsync(String, CallSettings)

public virtual Task<Operation<Empty, Struct>> PollOnceRestoreAgentAsync(string operationName, CallSettings callSettings = null)

Asynchronously poll an operation once, using an operationName from a previous invocation of RestoreAgent.

Parameters
Name Description
operationName System.String

The name of a previously invoked operation. Must not be null or empty.
callSettings Google.Api.Gax.Grpc.CallSettings

If not null, applies overrides to this RPC call.
Returns
Type Description
System.Threading.Tasks.Task<Google.LongRunning.Operation<Google.Protobuf.WellKnownTypes.Empty, Google.Protobuf.WellKnownTypes.Struct>>

A task representing the result of polling the operation.

RestoreAgent(RestoreAgentRequest, CallSettings)

public virtual Operation<Empty, Struct> RestoreAgent(RestoreAgentRequest request, CallSettings callSettings = null)

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

If not null, applies overrides to this RPC call.
Returns
Type Description
Google.LongRunning.Operation<Google.Protobuf.WellKnownTypes.Empty, Google.Protobuf.WellKnownTypes.Struct>

The RPC response.

RestoreAgentAsync(RestoreAgentRequest, CallSettings)

public virtual Task<Operation<Empty, Struct>> RestoreAgentAsync(RestoreAgentRequest request, CallSettings callSettings = null)

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

If not null, applies overrides to this RPC call.
Returns
Type Description
System.Threading.Tasks.Task<Google.LongRunning.Operation<Google.Protobuf.WellKnownTypes.Empty, Google.Protobuf.WellKnownTypes.Struct>>

A Task containing the RPC response.

RestoreAgentAsync(RestoreAgentRequest, CancellationToken)

public virtual Task<Operation<Empty, Struct>> RestoreAgentAsync(RestoreAgentRequest request, CancellationToken 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 object containing all of the parameters for the API call.
cancellationToken System.Threading.CancellationToken

A System.Threading.CancellationToken to use for this RPC.
Returns
Type Description
System.Threading.Tasks.Task<Google.LongRunning.Operation<Google.Protobuf.WellKnownTypes.Empty, Google.Protobuf.WellKnownTypes.Struct>>

A Task containing the RPC response.

ShutdownDefaultChannelsAsync()

public static Task ShutdownDefaultChannelsAsync()

Shuts down any channels automatically created by Create() and CreateAsync(CancellationToken). Channels which weren't automatically created are not affected.

Returns
Type Description
System.Threading.Tasks.Task

A task representing the asynchronous shutdown operation.
Remarks

After calling this method, further calls to Create() and CreateAsync(CancellationToken) will create new channels, which could in turn be shut down by another call to this method.

UpdateAgent(Agent, FieldMask, CallSettings)

public virtual Agent UpdateAgent(Agent agent, FieldMask updateMask, CallSettings callSettings = null)

Updates the specified agent.

Parameters
Name Description
agent Agent

Required. The agent to update.
updateMask Google.Protobuf.WellKnownTypes.FieldMask

The mask to control which fields get updated. If the mask is not present, all fields will be updated.
callSettings Google.Api.Gax.Grpc.CallSettings

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

The RPC response.

UpdateAgent(UpdateAgentRequest, CallSettings)

public virtual Agent UpdateAgent(UpdateAgentRequest request, CallSettings callSettings = null)

Updates the specified agent.

Parameters
Name Description
request UpdateAgentRequest

The request object containing all of the parameters for the API call.
callSettings Google.Api.Gax.Grpc.CallSettings

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

The RPC response.

UpdateAgentAsync(Agent, FieldMask, CallSettings)

public virtual Task<Agent> UpdateAgentAsync(Agent agent, FieldMask updateMask, CallSettings callSettings = null)

Updates the specified agent.

Parameters
Name Description
agent Agent

Required. The agent to update.
updateMask Google.Protobuf.WellKnownTypes.FieldMask

The mask to control which fields get updated. If the mask is not present, all fields will be updated.
callSettings Google.Api.Gax.Grpc.CallSettings

If not null, applies overrides to this RPC call.
Returns
Type Description
System.Threading.Tasks.Task<Agent>

A Task containing the RPC response.

UpdateAgentAsync(Agent, FieldMask, CancellationToken)

public virtual Task<Agent> UpdateAgentAsync(Agent agent, FieldMask updateMask, CancellationToken cancellationToken)

Updates the specified agent.

Parameters
Name Description
agent Agent

Required. The agent to update.
updateMask Google.Protobuf.WellKnownTypes.FieldMask

The mask to control which fields get updated. If the mask is not present, all fields will be updated.
cancellationToken System.Threading.CancellationToken

A System.Threading.CancellationToken to use for this RPC.
Returns
Type Description
System.Threading.Tasks.Task<Agent>

A Task containing the RPC response.

UpdateAgentAsync(UpdateAgentRequest, CallSettings)

public virtual Task<Agent> UpdateAgentAsync(UpdateAgentRequest request, CallSettings callSettings = null)

Updates the specified agent.

Parameters
Name Description
request UpdateAgentRequest

The request object containing all of the parameters for the API call.
callSettings Google.Api.Gax.Grpc.CallSettings

If not null, applies overrides to this RPC call.
Returns
Type Description
System.Threading.Tasks.Task<Agent>

A Task containing the RPC response.

UpdateAgentAsync(UpdateAgentRequest, CancellationToken)

public virtual Task<Agent> UpdateAgentAsync(UpdateAgentRequest request, CancellationToken cancellationToken)

Updates the specified agent.

Parameters
Name Description
request UpdateAgentRequest

The request object containing all of the parameters for the API call.
cancellationToken System.Threading.CancellationToken

A System.Threading.CancellationToken to use for this RPC.
Returns
Type Description
System.Threading.Tasks.Task<Agent>

A Task containing the RPC response.