public abstract class IntentsClient
Intents client wrapper, for convenient use.
Inheritance
System.Object > IntentsClientNamespace
Google.Cloud.Dialogflow.Cx.V3Assembly
Google.Cloud.Dialogflow.Cx.V3.dll
Remarks
Service for managing [Intents][google.cloud.dialogflow.cx.v3.Intent].
Properties
DefaultEndpoint
public static string DefaultEndpoint { get; }
The default endpoint for the Intents 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 Intents scopes.
Property Value | |
---|---|
Type | Description |
System.Collections.Generic.IReadOnlyList<System.String> |
The default Intents scopes are:
GrpcClient
public virtual Intents.IntentsClient GrpcClient { get; }
The underlying gRPC Intents client
Property Value | |
---|---|
Type | Description |
Intents.IntentsClient |
Methods
Create()
public static IntentsClient Create()
Synchronously creates a IntentsClient using the default credentials, endpoint and settings. To specify custom credentials or other settings, use IntentsClientBuilder.
Returns | |
---|---|
Type | Description |
IntentsClient | The created IntentsClient. |
CreateAsync(CancellationToken)
public static Task<IntentsClient> CreateAsync(CancellationToken cancellationToken = default(CancellationToken))
Asynchronously creates a IntentsClient using the default credentials, endpoint and settings. To specify custom credentials or other settings, use IntentsClientBuilder.
Parameter | |
---|---|
Name | Description |
cancellationToken | System.Threading.CancellationToken The System.Threading.CancellationToken to use while creating the client. |
Returns | |
---|---|
Type | Description |
System.Threading.Tasks.Task<IntentsClient> | The task representing the created IntentsClient. |
CreateIntent(AgentName, Intent, CallSettings)
public virtual Intent CreateIntent(AgentName parent, Intent intent, CallSettings callSettings = null)
Creates an intent in the specified agent.
Parameters | |
---|---|
Name | Description |
parent | AgentName Required. The agent to create an intent for.
Format: |
intent | Intent Required. The intent to create. |
callSettings | Google.Api.Gax.Grpc.CallSettings If not null, applies overrides to this RPC call. |
Returns | |
---|---|
Type | Description |
Intent | The RPC response. |
CreateIntent(CreateIntentRequest, CallSettings)
public virtual Intent CreateIntent(CreateIntentRequest request, CallSettings callSettings = null)
Creates an intent in the specified agent.
Parameters | |
---|---|
Name | Description |
request | CreateIntentRequest 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 |
Intent | The RPC response. |
CreateIntent(String, Intent, CallSettings)
public virtual Intent CreateIntent(string parent, Intent intent, CallSettings callSettings = null)
Creates an intent in the specified agent.
Parameters | |
---|---|
Name | Description |
parent | System.String Required. The agent to create an intent for.
Format: |
intent | Intent Required. The intent to create. |
callSettings | Google.Api.Gax.Grpc.CallSettings If not null, applies overrides to this RPC call. |
Returns | |
---|---|
Type | Description |
Intent | The RPC response. |
CreateIntentAsync(AgentName, Intent, CallSettings)
public virtual Task<Intent> CreateIntentAsync(AgentName parent, Intent intent, CallSettings callSettings = null)
Creates an intent in the specified agent.
Parameters | |
---|---|
Name | Description |
parent | AgentName Required. The agent to create an intent for.
Format: |
intent | Intent Required. The intent to create. |
callSettings | Google.Api.Gax.Grpc.CallSettings If not null, applies overrides to this RPC call. |
Returns | |
---|---|
Type | Description |
System.Threading.Tasks.Task<Intent> | A Task containing the RPC response. |
CreateIntentAsync(AgentName, Intent, CancellationToken)
public virtual Task<Intent> CreateIntentAsync(AgentName parent, Intent intent, CancellationToken cancellationToken)
Creates an intent in the specified agent.
Parameters | |
---|---|
Name | Description |
parent | AgentName Required. The agent to create an intent for.
Format: |
intent | Intent Required. The intent to create. |
cancellationToken | System.Threading.CancellationToken A System.Threading.CancellationToken to use for this RPC. |
Returns | |
---|---|
Type | Description |
System.Threading.Tasks.Task<Intent> | A Task containing the RPC response. |
CreateIntentAsync(CreateIntentRequest, CallSettings)
public virtual Task<Intent> CreateIntentAsync(CreateIntentRequest request, CallSettings callSettings = null)
Creates an intent in the specified agent.
Parameters | |
---|---|
Name | Description |
request | CreateIntentRequest 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<Intent> | A Task containing the RPC response. |
CreateIntentAsync(CreateIntentRequest, CancellationToken)
public virtual Task<Intent> CreateIntentAsync(CreateIntentRequest request, CancellationToken cancellationToken)
Creates an intent in the specified agent.
Parameters | |
---|---|
Name | Description |
request | CreateIntentRequest 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<Intent> | A Task containing the RPC response. |
CreateIntentAsync(String, Intent, CallSettings)
public virtual Task<Intent> CreateIntentAsync(string parent, Intent intent, CallSettings callSettings = null)
Creates an intent in the specified agent.
Parameters | |
---|---|
Name | Description |
parent | System.String Required. The agent to create an intent for.
Format: |
intent | Intent Required. The intent to create. |
callSettings | Google.Api.Gax.Grpc.CallSettings If not null, applies overrides to this RPC call. |
Returns | |
---|---|
Type | Description |
System.Threading.Tasks.Task<Intent> | A Task containing the RPC response. |
CreateIntentAsync(String, Intent, CancellationToken)
public virtual Task<Intent> CreateIntentAsync(string parent, Intent intent, CancellationToken cancellationToken)
Creates an intent in the specified agent.
Parameters | |
---|---|
Name | Description |
parent | System.String Required. The agent to create an intent for.
Format: |
intent | Intent Required. The intent to create. |
cancellationToken | System.Threading.CancellationToken A System.Threading.CancellationToken to use for this RPC. |
Returns | |
---|---|
Type | Description |
System.Threading.Tasks.Task<Intent> | A Task containing the RPC response. |
DeleteIntent(DeleteIntentRequest, CallSettings)
public virtual void DeleteIntent(DeleteIntentRequest request, CallSettings callSettings = null)
Deletes the specified intent.
Parameters | |
---|---|
Name | Description |
request | DeleteIntentRequest 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. |
DeleteIntent(IntentName, CallSettings)
public virtual void DeleteIntent(IntentName name, CallSettings callSettings = null)
Deletes the specified intent.
Parameters | |
---|---|
Name | Description |
name | IntentName Required. The name of the intent to delete.
Format: |
callSettings | Google.Api.Gax.Grpc.CallSettings If not null, applies overrides to this RPC call. |
DeleteIntent(String, CallSettings)
public virtual void DeleteIntent(string name, CallSettings callSettings = null)
Deletes the specified intent.
Parameters | |
---|---|
Name | Description |
name | System.String Required. The name of the intent to delete.
Format: |
callSettings | Google.Api.Gax.Grpc.CallSettings If not null, applies overrides to this RPC call. |
DeleteIntentAsync(DeleteIntentRequest, CallSettings)
public virtual Task DeleteIntentAsync(DeleteIntentRequest request, CallSettings callSettings = null)
Deletes the specified intent.
Parameters | |
---|---|
Name | Description |
request | DeleteIntentRequest 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. |
DeleteIntentAsync(DeleteIntentRequest, CancellationToken)
public virtual Task DeleteIntentAsync(DeleteIntentRequest request, CancellationToken cancellationToken)
Deletes the specified intent.
Parameters | |
---|---|
Name | Description |
request | DeleteIntentRequest 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. |
DeleteIntentAsync(IntentName, CallSettings)
public virtual Task DeleteIntentAsync(IntentName name, CallSettings callSettings = null)
Deletes the specified intent.
Parameters | |
---|---|
Name | Description |
name | IntentName Required. The name of the intent to delete.
Format: |
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. |
DeleteIntentAsync(IntentName, CancellationToken)
public virtual Task DeleteIntentAsync(IntentName name, CancellationToken cancellationToken)
Deletes the specified intent.
Parameters | |
---|---|
Name | Description |
name | IntentName Required. The name of the intent to delete.
Format: |
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. |
DeleteIntentAsync(String, CallSettings)
public virtual Task DeleteIntentAsync(string name, CallSettings callSettings = null)
Deletes the specified intent.
Parameters | |
---|---|
Name | Description |
name | System.String Required. The name of the intent to delete.
Format: |
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. |
DeleteIntentAsync(String, CancellationToken)
public virtual Task DeleteIntentAsync(string name, CancellationToken cancellationToken)
Deletes the specified intent.
Parameters | |
---|---|
Name | Description |
name | System.String Required. The name of the intent to delete.
Format: |
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. |
GetIntent(GetIntentRequest, CallSettings)
public virtual Intent GetIntent(GetIntentRequest request, CallSettings callSettings = null)
Retrieves the specified intent.
Parameters | |
---|---|
Name | Description |
request | GetIntentRequest 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 |
Intent | The RPC response. |
GetIntent(IntentName, CallSettings)
public virtual Intent GetIntent(IntentName name, CallSettings callSettings = null)
Retrieves the specified intent.
Parameters | |
---|---|
Name | Description |
name | IntentName Required. The name of the intent.
Format: |
callSettings | Google.Api.Gax.Grpc.CallSettings If not null, applies overrides to this RPC call. |
Returns | |
---|---|
Type | Description |
Intent | The RPC response. |
GetIntent(String, CallSettings)
public virtual Intent GetIntent(string name, CallSettings callSettings = null)
Retrieves the specified intent.
Parameters | |
---|---|
Name | Description |
name | System.String Required. The name of the intent.
Format: |
callSettings | Google.Api.Gax.Grpc.CallSettings If not null, applies overrides to this RPC call. |
Returns | |
---|---|
Type | Description |
Intent | The RPC response. |
GetIntentAsync(GetIntentRequest, CallSettings)
public virtual Task<Intent> GetIntentAsync(GetIntentRequest request, CallSettings callSettings = null)
Retrieves the specified intent.
Parameters | |
---|---|
Name | Description |
request | GetIntentRequest 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<Intent> | A Task containing the RPC response. |
GetIntentAsync(GetIntentRequest, CancellationToken)
public virtual Task<Intent> GetIntentAsync(GetIntentRequest request, CancellationToken cancellationToken)
Retrieves the specified intent.
Parameters | |
---|---|
Name | Description |
request | GetIntentRequest 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<Intent> | A Task containing the RPC response. |
GetIntentAsync(IntentName, CallSettings)
public virtual Task<Intent> GetIntentAsync(IntentName name, CallSettings callSettings = null)
Retrieves the specified intent.
Parameters | |
---|---|
Name | Description |
name | IntentName Required. The name of the intent.
Format: |
callSettings | Google.Api.Gax.Grpc.CallSettings If not null, applies overrides to this RPC call. |
Returns | |
---|---|
Type | Description |
System.Threading.Tasks.Task<Intent> | A Task containing the RPC response. |
GetIntentAsync(IntentName, CancellationToken)
public virtual Task<Intent> GetIntentAsync(IntentName name, CancellationToken cancellationToken)
Retrieves the specified intent.
Parameters | |
---|---|
Name | Description |
name | IntentName Required. The name of the intent.
Format: |
cancellationToken | System.Threading.CancellationToken A System.Threading.CancellationToken to use for this RPC. |
Returns | |
---|---|
Type | Description |
System.Threading.Tasks.Task<Intent> | A Task containing the RPC response. |
GetIntentAsync(String, CallSettings)
public virtual Task<Intent> GetIntentAsync(string name, CallSettings callSettings = null)
Retrieves the specified intent.
Parameters | |
---|---|
Name | Description |
name | System.String Required. The name of the intent.
Format: |
callSettings | Google.Api.Gax.Grpc.CallSettings If not null, applies overrides to this RPC call. |
Returns | |
---|---|
Type | Description |
System.Threading.Tasks.Task<Intent> | A Task containing the RPC response. |
GetIntentAsync(String, CancellationToken)
public virtual Task<Intent> GetIntentAsync(string name, CancellationToken cancellationToken)
Retrieves the specified intent.
Parameters | |
---|---|
Name | Description |
name | System.String Required. The name of the intent.
Format: |
cancellationToken | System.Threading.CancellationToken A System.Threading.CancellationToken to use for this RPC. |
Returns | |
---|---|
Type | Description |
System.Threading.Tasks.Task<Intent> | A Task containing the RPC response. |
ListIntents(AgentName, String, Nullable<Int32>, CallSettings)
public virtual PagedEnumerable<ListIntentsResponse, Intent> ListIntents(AgentName parent, string pageToken = null, int? pageSize = default(int? ), CallSettings callSettings = null)
Returns the list of all intents in the specified agent.
Parameters | |
---|---|
Name | Description |
parent | AgentName Required. The agent to list all intents for.
Format: |
pageToken | System.String The token returned from the previous request. A value of |
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
|
callSettings | Google.Api.Gax.Grpc.CallSettings If not null, applies overrides to this RPC call. |
Returns | |
---|---|
Type | Description |
Google.Api.Gax.PagedEnumerable<ListIntentsResponse, Intent> | A pageable sequence of Intent resources. |
ListIntents(ListIntentsRequest, CallSettings)
public virtual PagedEnumerable<ListIntentsResponse, Intent> ListIntents(ListIntentsRequest request, CallSettings callSettings = null)
Returns the list of all intents in the specified agent.
Parameters | |
---|---|
Name | Description |
request | ListIntentsRequest 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<ListIntentsResponse, Intent> | A pageable sequence of Intent resources. |
ListIntents(String, String, Nullable<Int32>, CallSettings)
public virtual PagedEnumerable<ListIntentsResponse, Intent> ListIntents(string parent, string pageToken = null, int? pageSize = default(int? ), CallSettings callSettings = null)
Returns the list of all intents in the specified agent.
Parameters | |
---|---|
Name | Description |
parent | System.String Required. The agent to list all intents for.
Format: |
pageToken | System.String The token returned from the previous request. A value of |
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
|
callSettings | Google.Api.Gax.Grpc.CallSettings If not null, applies overrides to this RPC call. |
Returns | |
---|---|
Type | Description |
Google.Api.Gax.PagedEnumerable<ListIntentsResponse, Intent> | A pageable sequence of Intent resources. |
ListIntentsAsync(AgentName, String, Nullable<Int32>, CallSettings)
public virtual PagedAsyncEnumerable<ListIntentsResponse, Intent> ListIntentsAsync(AgentName parent, string pageToken = null, int? pageSize = default(int? ), CallSettings callSettings = null)
Returns the list of all intents in the specified agent.
Parameters | |
---|---|
Name | Description |
parent | AgentName Required. The agent to list all intents for.
Format: |
pageToken | System.String The token returned from the previous request. A value of |
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
|
callSettings | Google.Api.Gax.Grpc.CallSettings If not null, applies overrides to this RPC call. |
Returns | |
---|---|
Type | Description |
Google.Api.Gax.PagedAsyncEnumerable<ListIntentsResponse, Intent> | A pageable asynchronous sequence of Intent resources. |
ListIntentsAsync(ListIntentsRequest, CallSettings)
public virtual PagedAsyncEnumerable<ListIntentsResponse, Intent> ListIntentsAsync(ListIntentsRequest request, CallSettings callSettings = null)
Returns the list of all intents in the specified agent.
Parameters | |
---|---|
Name | Description |
request | ListIntentsRequest 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<ListIntentsResponse, Intent> | A pageable asynchronous sequence of Intent resources. |
ListIntentsAsync(String, String, Nullable<Int32>, CallSettings)
public virtual PagedAsyncEnumerable<ListIntentsResponse, Intent> ListIntentsAsync(string parent, string pageToken = null, int? pageSize = default(int? ), CallSettings callSettings = null)
Returns the list of all intents in the specified agent.
Parameters | |
---|---|
Name | Description |
parent | System.String Required. The agent to list all intents for.
Format: |
pageToken | System.String The token returned from the previous request. A value of |
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
|
callSettings | Google.Api.Gax.Grpc.CallSettings If not null, applies overrides to this RPC call. |
Returns | |
---|---|
Type | Description |
Google.Api.Gax.PagedAsyncEnumerable<ListIntentsResponse, Intent> | A pageable asynchronous sequence of Intent resources. |
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. |
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.
UpdateIntent(Intent, FieldMask, CallSettings)
public virtual Intent UpdateIntent(Intent intent, FieldMask updateMask, CallSettings callSettings = null)
Updates the specified intent.
Parameters | |
---|---|
Name | Description |
intent | Intent Required. The intent 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 |
Intent | The RPC response. |
UpdateIntent(UpdateIntentRequest, CallSettings)
public virtual Intent UpdateIntent(UpdateIntentRequest request, CallSettings callSettings = null)
Updates the specified intent.
Parameters | |
---|---|
Name | Description |
request | UpdateIntentRequest 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 |
Intent | The RPC response. |
UpdateIntentAsync(Intent, FieldMask, CallSettings)
public virtual Task<Intent> UpdateIntentAsync(Intent intent, FieldMask updateMask, CallSettings callSettings = null)
Updates the specified intent.
Parameters | |
---|---|
Name | Description |
intent | Intent Required. The intent 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<Intent> | A Task containing the RPC response. |
UpdateIntentAsync(Intent, FieldMask, CancellationToken)
public virtual Task<Intent> UpdateIntentAsync(Intent intent, FieldMask updateMask, CancellationToken cancellationToken)
Updates the specified intent.
Parameters | |
---|---|
Name | Description |
intent | Intent Required. The intent 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<Intent> | A Task containing the RPC response. |
UpdateIntentAsync(UpdateIntentRequest, CallSettings)
public virtual Task<Intent> UpdateIntentAsync(UpdateIntentRequest request, CallSettings callSettings = null)
Updates the specified intent.
Parameters | |
---|---|
Name | Description |
request | UpdateIntentRequest 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<Intent> | A Task containing the RPC response. |
UpdateIntentAsync(UpdateIntentRequest, CancellationToken)
public virtual Task<Intent> UpdateIntentAsync(UpdateIntentRequest request, CancellationToken cancellationToken)
Updates the specified intent.
Parameters | |
---|---|
Name | Description |
request | UpdateIntentRequest 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<Intent> | A Task containing the RPC response. |