Google Cloud Dialogflow v2 API - Class Intents.IntentsClient (4.25.0)

public class Intents.IntentsClient : ClientBase<Intents.IntentsClient>

Reference documentation and code samples for the Google Cloud Dialogflow v2 API class Intents.IntentsClient.

Client for Intents

Inheritance

object > ClientBase > ClientBaseIntentsIntentsClient > Intents.IntentsClient

Namespace

Google.Cloud.Dialogflow.V2

Assembly

Google.Cloud.Dialogflow.V2.dll

Constructors

IntentsClient()

protected IntentsClient()

Protected parameterless constructor to allow creation of test doubles.

IntentsClient(CallInvoker)

public IntentsClient(CallInvoker callInvoker)

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

Parameter
Name Description
callInvoker CallInvoker

The callInvoker to use to make remote calls.

IntentsClient(ChannelBase)

public IntentsClient(ChannelBase channel)

Creates a new client for Intents

Parameter
Name Description
channel ChannelBase

The channel to use to make remote calls.

IntentsClient(ClientBaseConfiguration)

protected IntentsClient(ClientBase.ClientBaseConfiguration configuration)

Protected constructor to allow creation of configured clients.

Parameter
Name Description
configuration ClientBaseClientBaseConfiguration

The client configuration.

Methods

BatchDeleteIntents(BatchDeleteIntentsRequest, CallOptions)

public virtual Operation BatchDeleteIntents(BatchDeleteIntentsRequest request, CallOptions options)

Deletes intents in the specified agent.

This method is a long-running operation. The returned Operation type has the following method-specific fields:

Note: You should always train an agent prior to sending it queries. See the training documentation.

Parameters
Name Description
request BatchDeleteIntentsRequest

The request to send to the server.

options CallOptions

The options for the call.

Returns
Type Description
Operation

The response received from the server.

BatchDeleteIntents(BatchDeleteIntentsRequest, Metadata, DateTime?, CancellationToken)

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

Deletes intents in the specified agent.

This method is a long-running operation. The returned Operation type has the following method-specific fields:

Note: You should always train an agent prior to sending it queries. See the training documentation.

Parameters
Name Description
request BatchDeleteIntentsRequest

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
Operation

The response received from the server.

BatchDeleteIntentsAsync(BatchDeleteIntentsRequest, CallOptions)

public virtual AsyncUnaryCall<Operation> BatchDeleteIntentsAsync(BatchDeleteIntentsRequest request, CallOptions options)

Deletes intents in the specified agent.

This method is a long-running operation. The returned Operation type has the following method-specific fields:

Note: You should always train an agent prior to sending it queries. See the training documentation.

Parameters
Name Description
request BatchDeleteIntentsRequest

The request to send to the server.

options CallOptions

The options for the call.

Returns
Type Description
AsyncUnaryCallOperation

The call object.

BatchDeleteIntentsAsync(BatchDeleteIntentsRequest, Metadata, DateTime?, CancellationToken)

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

Deletes intents in the specified agent.

This method is a long-running operation. The returned Operation type has the following method-specific fields:

Note: You should always train an agent prior to sending it queries. See the training documentation.

Parameters
Name Description
request BatchDeleteIntentsRequest

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
AsyncUnaryCallOperation

The call object.

BatchUpdateIntents(BatchUpdateIntentsRequest, CallOptions)

public virtual Operation BatchUpdateIntents(BatchUpdateIntentsRequest request, CallOptions options)

Updates/Creates multiple intents in the specified agent.

This method is a long-running operation. The returned Operation type has the following method-specific fields:

  • metadata: An empty Struct message
  • response: [BatchUpdateIntentsResponse][google.cloud.dialogflow.v2.BatchUpdateIntentsResponse]

Note: You should always train an agent prior to sending it queries. See the training documentation.

Parameters
Name Description
request BatchUpdateIntentsRequest

The request to send to the server.

options CallOptions

The options for the call.

Returns
Type Description
Operation

The response received from the server.

BatchUpdateIntents(BatchUpdateIntentsRequest, Metadata, DateTime?, CancellationToken)

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

Updates/Creates multiple intents in the specified agent.

This method is a long-running operation. The returned Operation type has the following method-specific fields:

  • metadata: An empty Struct message
  • response: [BatchUpdateIntentsResponse][google.cloud.dialogflow.v2.BatchUpdateIntentsResponse]

Note: You should always train an agent prior to sending it queries. See the training documentation.

Parameters
Name Description
request BatchUpdateIntentsRequest

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
Operation

The response received from the server.

BatchUpdateIntentsAsync(BatchUpdateIntentsRequest, CallOptions)

public virtual AsyncUnaryCall<Operation> BatchUpdateIntentsAsync(BatchUpdateIntentsRequest request, CallOptions options)

Updates/Creates multiple intents in the specified agent.

This method is a long-running operation. The returned Operation type has the following method-specific fields:

  • metadata: An empty Struct message
  • response: [BatchUpdateIntentsResponse][google.cloud.dialogflow.v2.BatchUpdateIntentsResponse]

Note: You should always train an agent prior to sending it queries. See the training documentation.

Parameters
Name Description
request BatchUpdateIntentsRequest

The request to send to the server.

options CallOptions

The options for the call.

Returns
Type Description
AsyncUnaryCallOperation

The call object.

BatchUpdateIntentsAsync(BatchUpdateIntentsRequest, Metadata, DateTime?, CancellationToken)

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

Updates/Creates multiple intents in the specified agent.

This method is a long-running operation. The returned Operation type has the following method-specific fields:

  • metadata: An empty Struct message
  • response: [BatchUpdateIntentsResponse][google.cloud.dialogflow.v2.BatchUpdateIntentsResponse]

Note: You should always train an agent prior to sending it queries. See the training documentation.

Parameters
Name Description
request BatchUpdateIntentsRequest

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
AsyncUnaryCallOperation

The call object.

CreateIntent(CreateIntentRequest, CallOptions)

public virtual Intent CreateIntent(CreateIntentRequest request, CallOptions options)

Creates an intent in the specified agent.

Note: You should always train an agent prior to sending it queries. See the training documentation.

Parameters
Name Description
request CreateIntentRequest

The request to send to the server.

options CallOptions

The options for the call.

Returns
Type Description
Intent

The response received from the server.

CreateIntent(CreateIntentRequest, Metadata, DateTime?, CancellationToken)

public virtual Intent CreateIntent(CreateIntentRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default)

Creates an intent in the specified agent.

Note: You should always train an agent prior to sending it queries. See the training documentation.

Parameters
Name Description
request CreateIntentRequest

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
Intent

The response received from the server.

CreateIntentAsync(CreateIntentRequest, CallOptions)

public virtual AsyncUnaryCall<Intent> CreateIntentAsync(CreateIntentRequest request, CallOptions options)

Creates an intent in the specified agent.

Note: You should always train an agent prior to sending it queries. See the training documentation.

Parameters
Name Description
request CreateIntentRequest

The request to send to the server.

options CallOptions

The options for the call.

Returns
Type Description
AsyncUnaryCallIntent

The call object.

CreateIntentAsync(CreateIntentRequest, Metadata, DateTime?, CancellationToken)

public virtual AsyncUnaryCall<Intent> CreateIntentAsync(CreateIntentRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default)

Creates an intent in the specified agent.

Note: You should always train an agent prior to sending it queries. See the training documentation.

Parameters
Name Description
request CreateIntentRequest

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
AsyncUnaryCallIntent

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.

CreateOperationsClient()

public virtual Operations.OperationsClient CreateOperationsClient()

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

Returns
Type Description
OperationsOperationsClient

A new Operations client for the same target as this client.

DeleteIntent(DeleteIntentRequest, CallOptions)

public virtual Empty DeleteIntent(DeleteIntentRequest request, CallOptions options)

Deletes the specified intent and its direct or indirect followup intents.

Note: You should always train an agent prior to sending it queries. See the training documentation.

Parameters
Name Description
request DeleteIntentRequest

The request to send to the server.

options CallOptions

The options for the call.

Returns
Type Description
Empty

The response received from the server.

DeleteIntent(DeleteIntentRequest, Metadata, DateTime?, CancellationToken)

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

Deletes the specified intent and its direct or indirect followup intents.

Note: You should always train an agent prior to sending it queries. See the training documentation.

Parameters
Name Description
request DeleteIntentRequest

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.

DeleteIntentAsync(DeleteIntentRequest, CallOptions)

public virtual AsyncUnaryCall<Empty> DeleteIntentAsync(DeleteIntentRequest request, CallOptions options)

Deletes the specified intent and its direct or indirect followup intents.

Note: You should always train an agent prior to sending it queries. See the training documentation.

Parameters
Name Description
request DeleteIntentRequest

The request to send to the server.

options CallOptions

The options for the call.

Returns
Type Description
AsyncUnaryCallEmpty

The call object.

DeleteIntentAsync(DeleteIntentRequest, Metadata, DateTime?, CancellationToken)

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

Deletes the specified intent and its direct or indirect followup intents.

Note: You should always train an agent prior to sending it queries. See the training documentation.

Parameters
Name Description
request DeleteIntentRequest

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.

GetIntent(GetIntentRequest, CallOptions)

public virtual Intent GetIntent(GetIntentRequest request, CallOptions options)

Retrieves the specified intent.

Parameters
Name Description
request GetIntentRequest

The request to send to the server.

options CallOptions

The options for the call.

Returns
Type Description
Intent

The response received from the server.

GetIntent(GetIntentRequest, Metadata, DateTime?, CancellationToken)

public virtual Intent GetIntent(GetIntentRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default)

Retrieves the specified intent.

Parameters
Name Description
request GetIntentRequest

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
Intent

The response received from the server.

GetIntentAsync(GetIntentRequest, CallOptions)

public virtual AsyncUnaryCall<Intent> GetIntentAsync(GetIntentRequest request, CallOptions options)

Retrieves the specified intent.

Parameters
Name Description
request GetIntentRequest

The request to send to the server.

options CallOptions

The options for the call.

Returns
Type Description
AsyncUnaryCallIntent

The call object.

GetIntentAsync(GetIntentRequest, Metadata, DateTime?, CancellationToken)

public virtual AsyncUnaryCall<Intent> GetIntentAsync(GetIntentRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default)

Retrieves the specified intent.

Parameters
Name Description
request GetIntentRequest

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
AsyncUnaryCallIntent

The call object.

ListIntents(ListIntentsRequest, CallOptions)

public virtual ListIntentsResponse ListIntents(ListIntentsRequest request, CallOptions options)

Returns the list of all intents in the specified agent.

Parameters
Name Description
request ListIntentsRequest

The request to send to the server.

options CallOptions

The options for the call.

Returns
Type Description
ListIntentsResponse

The response received from the server.

ListIntents(ListIntentsRequest, Metadata, DateTime?, CancellationToken)

public virtual ListIntentsResponse ListIntents(ListIntentsRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default)

Returns the list of all intents in the specified agent.

Parameters
Name Description
request ListIntentsRequest

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
ListIntentsResponse

The response received from the server.

ListIntentsAsync(ListIntentsRequest, CallOptions)

public virtual AsyncUnaryCall<ListIntentsResponse> ListIntentsAsync(ListIntentsRequest request, CallOptions options)

Returns the list of all intents in the specified agent.

Parameters
Name Description
request ListIntentsRequest

The request to send to the server.

options CallOptions

The options for the call.

Returns
Type Description
AsyncUnaryCallListIntentsResponse

The call object.

ListIntentsAsync(ListIntentsRequest, Metadata, DateTime?, CancellationToken)

public virtual AsyncUnaryCall<ListIntentsResponse> ListIntentsAsync(ListIntentsRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default)

Returns the list of all intents in the specified agent.

Parameters
Name Description
request ListIntentsRequest

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
AsyncUnaryCallListIntentsResponse

The call object.

NewInstance(ClientBaseConfiguration)

protected override Intents.IntentsClient NewInstance(ClientBase.ClientBaseConfiguration configuration)

Creates a new instance of client from given ClientBaseConfiguration.

Parameter
Name Description
configuration ClientBaseClientBaseConfiguration
Returns
Type Description
IntentsIntentsClient
Overrides
Grpc.Core.ClientBase<Google.Cloud.Dialogflow.V2.Intents.IntentsClient>.NewInstance(Grpc.Core.ClientBase.ClientBaseConfiguration)

UpdateIntent(UpdateIntentRequest, CallOptions)

public virtual Intent UpdateIntent(UpdateIntentRequest request, CallOptions options)

Updates the specified intent.

Note: You should always train an agent prior to sending it queries. See the training documentation.

Parameters
Name Description
request UpdateIntentRequest

The request to send to the server.

options CallOptions

The options for the call.

Returns
Type Description
Intent

The response received from the server.

UpdateIntent(UpdateIntentRequest, Metadata, DateTime?, CancellationToken)

public virtual Intent UpdateIntent(UpdateIntentRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default)

Updates the specified intent.

Note: You should always train an agent prior to sending it queries. See the training documentation.

Parameters
Name Description
request UpdateIntentRequest

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
Intent

The response received from the server.

UpdateIntentAsync(UpdateIntentRequest, CallOptions)

public virtual AsyncUnaryCall<Intent> UpdateIntentAsync(UpdateIntentRequest request, CallOptions options)

Updates the specified intent.

Note: You should always train an agent prior to sending it queries. See the training documentation.

Parameters
Name Description
request UpdateIntentRequest

The request to send to the server.

options CallOptions

The options for the call.

Returns
Type Description
AsyncUnaryCallIntent

The call object.

UpdateIntentAsync(UpdateIntentRequest, Metadata, DateTime?, CancellationToken)

public virtual AsyncUnaryCall<Intent> UpdateIntentAsync(UpdateIntentRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default)

Updates the specified intent.

Note: You should always train an agent prior to sending it queries. See the training documentation.

Parameters
Name Description
request UpdateIntentRequest

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
AsyncUnaryCallIntent

The call object.