Google Cloud Dialogflow v2 API - Class ConversationProfiles.ConversationProfilesClient (4.15.0)

public class ConversationProfiles.ConversationProfilesClient : ClientBase<ConversationProfiles.ConversationProfilesClient>

Reference documentation and code samples for the Google Cloud Dialogflow v2 API class ConversationProfiles.ConversationProfilesClient.

Client for ConversationProfiles

Inheritance

object > ClientBase > ClientBaseConversationProfilesConversationProfilesClient > ConversationProfiles.ConversationProfilesClient

Namespace

Google.Cloud.Dialogflow.V2

Assembly

Google.Cloud.Dialogflow.V2.dll

Constructors

ConversationProfilesClient()

protected ConversationProfilesClient()

Protected parameterless constructor to allow creation of test doubles.

ConversationProfilesClient(CallInvoker)

public ConversationProfilesClient(CallInvoker callInvoker)

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

Parameter
NameDescription
callInvokerCallInvoker

The callInvoker to use to make remote calls.

ConversationProfilesClient(ChannelBase)

public ConversationProfilesClient(ChannelBase channel)

Creates a new client for ConversationProfiles

Parameter
NameDescription
channelChannelBase

The channel to use to make remote calls.

ConversationProfilesClient(ClientBaseConfiguration)

protected ConversationProfilesClient(ClientBase.ClientBaseConfiguration configuration)

Protected constructor to allow creation of configured clients.

Parameter
NameDescription
configurationClientBaseClientBaseConfiguration

The client configuration.

Methods

ClearSuggestionFeatureConfig(ClearSuggestionFeatureConfigRequest, CallOptions)

public virtual Operation ClearSuggestionFeatureConfig(ClearSuggestionFeatureConfigRequest request, CallOptions options)

Clears a suggestion feature from a conversation profile for the given participant role.

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

  • metadata: [ClearSuggestionFeatureConfigOperationMetadata][google.cloud.dialogflow.v2.ClearSuggestionFeatureConfigOperationMetadata]
  • response: [ConversationProfile][google.cloud.dialogflow.v2.ConversationProfile]
Parameters
NameDescription
requestClearSuggestionFeatureConfigRequest

The request to send to the server.

optionsCallOptions

The options for the call.

Returns
TypeDescription
Operation

The response received from the server.

ClearSuggestionFeatureConfig(ClearSuggestionFeatureConfigRequest, Metadata, DateTime?, CancellationToken)

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

Clears a suggestion feature from a conversation profile for the given participant role.

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

  • metadata: [ClearSuggestionFeatureConfigOperationMetadata][google.cloud.dialogflow.v2.ClearSuggestionFeatureConfigOperationMetadata]
  • response: [ConversationProfile][google.cloud.dialogflow.v2.ConversationProfile]
Parameters
NameDescription
requestClearSuggestionFeatureConfigRequest

The request to send to the server.

headersMetadata

The initial metadata to send with the call. This parameter is optional.

deadlineDateTime

An optional deadline for the call. The call will be cancelled if deadline is hit.

cancellationTokenCancellationToken

An optional token for canceling the call.

Returns
TypeDescription
Operation

The response received from the server.

ClearSuggestionFeatureConfigAsync(ClearSuggestionFeatureConfigRequest, CallOptions)

public virtual AsyncUnaryCall<Operation> ClearSuggestionFeatureConfigAsync(ClearSuggestionFeatureConfigRequest request, CallOptions options)

Clears a suggestion feature from a conversation profile for the given participant role.

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

  • metadata: [ClearSuggestionFeatureConfigOperationMetadata][google.cloud.dialogflow.v2.ClearSuggestionFeatureConfigOperationMetadata]
  • response: [ConversationProfile][google.cloud.dialogflow.v2.ConversationProfile]
Parameters
NameDescription
requestClearSuggestionFeatureConfigRequest

The request to send to the server.

optionsCallOptions

The options for the call.

Returns
TypeDescription
AsyncUnaryCallOperation

The call object.

ClearSuggestionFeatureConfigAsync(ClearSuggestionFeatureConfigRequest, Metadata, DateTime?, CancellationToken)

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

Clears a suggestion feature from a conversation profile for the given participant role.

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

  • metadata: [ClearSuggestionFeatureConfigOperationMetadata][google.cloud.dialogflow.v2.ClearSuggestionFeatureConfigOperationMetadata]
  • response: [ConversationProfile][google.cloud.dialogflow.v2.ConversationProfile]
Parameters
NameDescription
requestClearSuggestionFeatureConfigRequest

The request to send to the server.

headersMetadata

The initial metadata to send with the call. This parameter is optional.

deadlineDateTime

An optional deadline for the call. The call will be cancelled if deadline is hit.

cancellationTokenCancellationToken

An optional token for canceling the call.

Returns
TypeDescription
AsyncUnaryCallOperation

The call object.

CreateConversationProfile(CreateConversationProfileRequest, CallOptions)

public virtual ConversationProfile CreateConversationProfile(CreateConversationProfileRequest request, CallOptions options)

Creates a conversation profile in the specified project.

[ConversationProfile.CreateTime][] and [ConversationProfile.UpdateTime][] aren't populated in the response. You can retrieve them via [GetConversationProfile][google.cloud.dialogflow.v2.ConversationProfiles.GetConversationProfile] API.

Parameters
NameDescription
requestCreateConversationProfileRequest

The request to send to the server.

optionsCallOptions

The options for the call.

Returns
TypeDescription
ConversationProfile

The response received from the server.

CreateConversationProfile(CreateConversationProfileRequest, Metadata, DateTime?, CancellationToken)

public virtual ConversationProfile CreateConversationProfile(CreateConversationProfileRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default)

Creates a conversation profile in the specified project.

[ConversationProfile.CreateTime][] and [ConversationProfile.UpdateTime][] aren't populated in the response. You can retrieve them via [GetConversationProfile][google.cloud.dialogflow.v2.ConversationProfiles.GetConversationProfile] API.

Parameters
NameDescription
requestCreateConversationProfileRequest

The request to send to the server.

headersMetadata

The initial metadata to send with the call. This parameter is optional.

deadlineDateTime

An optional deadline for the call. The call will be cancelled if deadline is hit.

cancellationTokenCancellationToken

An optional token for canceling the call.

Returns
TypeDescription
ConversationProfile

The response received from the server.

CreateConversationProfileAsync(CreateConversationProfileRequest, CallOptions)

public virtual AsyncUnaryCall<ConversationProfile> CreateConversationProfileAsync(CreateConversationProfileRequest request, CallOptions options)

Creates a conversation profile in the specified project.

[ConversationProfile.CreateTime][] and [ConversationProfile.UpdateTime][] aren't populated in the response. You can retrieve them via [GetConversationProfile][google.cloud.dialogflow.v2.ConversationProfiles.GetConversationProfile] API.

Parameters
NameDescription
requestCreateConversationProfileRequest

The request to send to the server.

optionsCallOptions

The options for the call.

Returns
TypeDescription
AsyncUnaryCallConversationProfile

The call object.

CreateConversationProfileAsync(CreateConversationProfileRequest, Metadata, DateTime?, CancellationToken)

public virtual AsyncUnaryCall<ConversationProfile> CreateConversationProfileAsync(CreateConversationProfileRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default)

Creates a conversation profile in the specified project.

[ConversationProfile.CreateTime][] and [ConversationProfile.UpdateTime][] aren't populated in the response. You can retrieve them via [GetConversationProfile][google.cloud.dialogflow.v2.ConversationProfiles.GetConversationProfile] API.

Parameters
NameDescription
requestCreateConversationProfileRequest

The request to send to the server.

headersMetadata

The initial metadata to send with the call. This parameter is optional.

deadlineDateTime

An optional deadline for the call. The call will be cancelled if deadline is hit.

cancellationTokenCancellationToken

An optional token for canceling the call.

Returns
TypeDescription
AsyncUnaryCallConversationProfile

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
TypeDescription
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
TypeDescription
OperationsOperationsClient

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

DeleteConversationProfile(DeleteConversationProfileRequest, CallOptions)

public virtual Empty DeleteConversationProfile(DeleteConversationProfileRequest request, CallOptions options)

Deletes the specified conversation profile.

Parameters
NameDescription
requestDeleteConversationProfileRequest

The request to send to the server.

optionsCallOptions

The options for the call.

Returns
TypeDescription
Empty

The response received from the server.

DeleteConversationProfile(DeleteConversationProfileRequest, Metadata, DateTime?, CancellationToken)

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

Deletes the specified conversation profile.

Parameters
NameDescription
requestDeleteConversationProfileRequest

The request to send to the server.

headersMetadata

The initial metadata to send with the call. This parameter is optional.

deadlineDateTime

An optional deadline for the call. The call will be cancelled if deadline is hit.

cancellationTokenCancellationToken

An optional token for canceling the call.

Returns
TypeDescription
Empty

The response received from the server.

DeleteConversationProfileAsync(DeleteConversationProfileRequest, CallOptions)

public virtual AsyncUnaryCall<Empty> DeleteConversationProfileAsync(DeleteConversationProfileRequest request, CallOptions options)

Deletes the specified conversation profile.

Parameters
NameDescription
requestDeleteConversationProfileRequest

The request to send to the server.

optionsCallOptions

The options for the call.

Returns
TypeDescription
AsyncUnaryCallEmpty

The call object.

DeleteConversationProfileAsync(DeleteConversationProfileRequest, Metadata, DateTime?, CancellationToken)

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

Deletes the specified conversation profile.

Parameters
NameDescription
requestDeleteConversationProfileRequest

The request to send to the server.

headersMetadata

The initial metadata to send with the call. This parameter is optional.

deadlineDateTime

An optional deadline for the call. The call will be cancelled if deadline is hit.

cancellationTokenCancellationToken

An optional token for canceling the call.

Returns
TypeDescription
AsyncUnaryCallEmpty

The call object.

GetConversationProfile(GetConversationProfileRequest, CallOptions)

public virtual ConversationProfile GetConversationProfile(GetConversationProfileRequest request, CallOptions options)

Retrieves the specified conversation profile.

Parameters
NameDescription
requestGetConversationProfileRequest

The request to send to the server.

optionsCallOptions

The options for the call.

Returns
TypeDescription
ConversationProfile

The response received from the server.

GetConversationProfile(GetConversationProfileRequest, Metadata, DateTime?, CancellationToken)

public virtual ConversationProfile GetConversationProfile(GetConversationProfileRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default)

Retrieves the specified conversation profile.

Parameters
NameDescription
requestGetConversationProfileRequest

The request to send to the server.

headersMetadata

The initial metadata to send with the call. This parameter is optional.

deadlineDateTime

An optional deadline for the call. The call will be cancelled if deadline is hit.

cancellationTokenCancellationToken

An optional token for canceling the call.

Returns
TypeDescription
ConversationProfile

The response received from the server.

GetConversationProfileAsync(GetConversationProfileRequest, CallOptions)

public virtual AsyncUnaryCall<ConversationProfile> GetConversationProfileAsync(GetConversationProfileRequest request, CallOptions options)

Retrieves the specified conversation profile.

Parameters
NameDescription
requestGetConversationProfileRequest

The request to send to the server.

optionsCallOptions

The options for the call.

Returns
TypeDescription
AsyncUnaryCallConversationProfile

The call object.

GetConversationProfileAsync(GetConversationProfileRequest, Metadata, DateTime?, CancellationToken)

public virtual AsyncUnaryCall<ConversationProfile> GetConversationProfileAsync(GetConversationProfileRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default)

Retrieves the specified conversation profile.

Parameters
NameDescription
requestGetConversationProfileRequest

The request to send to the server.

headersMetadata

The initial metadata to send with the call. This parameter is optional.

deadlineDateTime

An optional deadline for the call. The call will be cancelled if deadline is hit.

cancellationTokenCancellationToken

An optional token for canceling the call.

Returns
TypeDescription
AsyncUnaryCallConversationProfile

The call object.

ListConversationProfiles(ListConversationProfilesRequest, CallOptions)

public virtual ListConversationProfilesResponse ListConversationProfiles(ListConversationProfilesRequest request, CallOptions options)

Returns the list of all conversation profiles in the specified project.

Parameters
NameDescription
requestListConversationProfilesRequest

The request to send to the server.

optionsCallOptions

The options for the call.

Returns
TypeDescription
ListConversationProfilesResponse

The response received from the server.

ListConversationProfiles(ListConversationProfilesRequest, Metadata, DateTime?, CancellationToken)

public virtual ListConversationProfilesResponse ListConversationProfiles(ListConversationProfilesRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default)

Returns the list of all conversation profiles in the specified project.

Parameters
NameDescription
requestListConversationProfilesRequest

The request to send to the server.

headersMetadata

The initial metadata to send with the call. This parameter is optional.

deadlineDateTime

An optional deadline for the call. The call will be cancelled if deadline is hit.

cancellationTokenCancellationToken

An optional token for canceling the call.

Returns
TypeDescription
ListConversationProfilesResponse

The response received from the server.

ListConversationProfilesAsync(ListConversationProfilesRequest, CallOptions)

public virtual AsyncUnaryCall<ListConversationProfilesResponse> ListConversationProfilesAsync(ListConversationProfilesRequest request, CallOptions options)

Returns the list of all conversation profiles in the specified project.

Parameters
NameDescription
requestListConversationProfilesRequest

The request to send to the server.

optionsCallOptions

The options for the call.

Returns
TypeDescription
AsyncUnaryCallListConversationProfilesResponse

The call object.

ListConversationProfilesAsync(ListConversationProfilesRequest, Metadata, DateTime?, CancellationToken)

public virtual AsyncUnaryCall<ListConversationProfilesResponse> ListConversationProfilesAsync(ListConversationProfilesRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default)

Returns the list of all conversation profiles in the specified project.

Parameters
NameDescription
requestListConversationProfilesRequest

The request to send to the server.

headersMetadata

The initial metadata to send with the call. This parameter is optional.

deadlineDateTime

An optional deadline for the call. The call will be cancelled if deadline is hit.

cancellationTokenCancellationToken

An optional token for canceling the call.

Returns
TypeDescription
AsyncUnaryCallListConversationProfilesResponse

The call object.

NewInstance(ClientBaseConfiguration)

protected override ConversationProfiles.ConversationProfilesClient NewInstance(ClientBase.ClientBaseConfiguration configuration)

Creates a new instance of client from given ClientBaseConfiguration.

Parameter
NameDescription
configurationClientBaseClientBaseConfiguration
Returns
TypeDescription
ConversationProfilesConversationProfilesClient
Overrides

SetSuggestionFeatureConfig(SetSuggestionFeatureConfigRequest, CallOptions)

public virtual Operation SetSuggestionFeatureConfig(SetSuggestionFeatureConfigRequest request, CallOptions options)

Adds or updates a suggestion feature in a conversation profile. If the conversation profile contains the type of suggestion feature for the participant role, it will update it. Otherwise it will insert the suggestion feature.

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

  • metadata: [SetSuggestionFeatureConfigOperationMetadata][google.cloud.dialogflow.v2.SetSuggestionFeatureConfigOperationMetadata]
  • response: [ConversationProfile][google.cloud.dialogflow.v2.ConversationProfile]

If a long running operation to add or update suggestion feature config for the same conversation profile, participant role and suggestion feature type exists, please cancel the existing long running operation before sending such request, otherwise the request will be rejected.

Parameters
NameDescription
requestSetSuggestionFeatureConfigRequest

The request to send to the server.

optionsCallOptions

The options for the call.

Returns
TypeDescription
Operation

The response received from the server.

SetSuggestionFeatureConfig(SetSuggestionFeatureConfigRequest, Metadata, DateTime?, CancellationToken)

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

Adds or updates a suggestion feature in a conversation profile. If the conversation profile contains the type of suggestion feature for the participant role, it will update it. Otherwise it will insert the suggestion feature.

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

  • metadata: [SetSuggestionFeatureConfigOperationMetadata][google.cloud.dialogflow.v2.SetSuggestionFeatureConfigOperationMetadata]
  • response: [ConversationProfile][google.cloud.dialogflow.v2.ConversationProfile]

If a long running operation to add or update suggestion feature config for the same conversation profile, participant role and suggestion feature type exists, please cancel the existing long running operation before sending such request, otherwise the request will be rejected.

Parameters
NameDescription
requestSetSuggestionFeatureConfigRequest

The request to send to the server.

headersMetadata

The initial metadata to send with the call. This parameter is optional.

deadlineDateTime

An optional deadline for the call. The call will be cancelled if deadline is hit.

cancellationTokenCancellationToken

An optional token for canceling the call.

Returns
TypeDescription
Operation

The response received from the server.

SetSuggestionFeatureConfigAsync(SetSuggestionFeatureConfigRequest, CallOptions)

public virtual AsyncUnaryCall<Operation> SetSuggestionFeatureConfigAsync(SetSuggestionFeatureConfigRequest request, CallOptions options)

Adds or updates a suggestion feature in a conversation profile. If the conversation profile contains the type of suggestion feature for the participant role, it will update it. Otherwise it will insert the suggestion feature.

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

  • metadata: [SetSuggestionFeatureConfigOperationMetadata][google.cloud.dialogflow.v2.SetSuggestionFeatureConfigOperationMetadata]
  • response: [ConversationProfile][google.cloud.dialogflow.v2.ConversationProfile]

If a long running operation to add or update suggestion feature config for the same conversation profile, participant role and suggestion feature type exists, please cancel the existing long running operation before sending such request, otherwise the request will be rejected.

Parameters
NameDescription
requestSetSuggestionFeatureConfigRequest

The request to send to the server.

optionsCallOptions

The options for the call.

Returns
TypeDescription
AsyncUnaryCallOperation

The call object.

SetSuggestionFeatureConfigAsync(SetSuggestionFeatureConfigRequest, Metadata, DateTime?, CancellationToken)

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

Adds or updates a suggestion feature in a conversation profile. If the conversation profile contains the type of suggestion feature for the participant role, it will update it. Otherwise it will insert the suggestion feature.

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

  • metadata: [SetSuggestionFeatureConfigOperationMetadata][google.cloud.dialogflow.v2.SetSuggestionFeatureConfigOperationMetadata]
  • response: [ConversationProfile][google.cloud.dialogflow.v2.ConversationProfile]

If a long running operation to add or update suggestion feature config for the same conversation profile, participant role and suggestion feature type exists, please cancel the existing long running operation before sending such request, otherwise the request will be rejected.

Parameters
NameDescription
requestSetSuggestionFeatureConfigRequest

The request to send to the server.

headersMetadata

The initial metadata to send with the call. This parameter is optional.

deadlineDateTime

An optional deadline for the call. The call will be cancelled if deadline is hit.

cancellationTokenCancellationToken

An optional token for canceling the call.

Returns
TypeDescription
AsyncUnaryCallOperation

The call object.

UpdateConversationProfile(UpdateConversationProfileRequest, CallOptions)

public virtual ConversationProfile UpdateConversationProfile(UpdateConversationProfileRequest request, CallOptions options)

Updates the specified conversation profile.

[ConversationProfile.CreateTime][] and [ConversationProfile.UpdateTime][] aren't populated in the response. You can retrieve them via [GetConversationProfile][google.cloud.dialogflow.v2.ConversationProfiles.GetConversationProfile] API.

Parameters
NameDescription
requestUpdateConversationProfileRequest

The request to send to the server.

optionsCallOptions

The options for the call.

Returns
TypeDescription
ConversationProfile

The response received from the server.

UpdateConversationProfile(UpdateConversationProfileRequest, Metadata, DateTime?, CancellationToken)

public virtual ConversationProfile UpdateConversationProfile(UpdateConversationProfileRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default)

Updates the specified conversation profile.

[ConversationProfile.CreateTime][] and [ConversationProfile.UpdateTime][] aren't populated in the response. You can retrieve them via [GetConversationProfile][google.cloud.dialogflow.v2.ConversationProfiles.GetConversationProfile] API.

Parameters
NameDescription
requestUpdateConversationProfileRequest

The request to send to the server.

headersMetadata

The initial metadata to send with the call. This parameter is optional.

deadlineDateTime

An optional deadline for the call. The call will be cancelled if deadline is hit.

cancellationTokenCancellationToken

An optional token for canceling the call.

Returns
TypeDescription
ConversationProfile

The response received from the server.

UpdateConversationProfileAsync(UpdateConversationProfileRequest, CallOptions)

public virtual AsyncUnaryCall<ConversationProfile> UpdateConversationProfileAsync(UpdateConversationProfileRequest request, CallOptions options)

Updates the specified conversation profile.

[ConversationProfile.CreateTime][] and [ConversationProfile.UpdateTime][] aren't populated in the response. You can retrieve them via [GetConversationProfile][google.cloud.dialogflow.v2.ConversationProfiles.GetConversationProfile] API.

Parameters
NameDescription
requestUpdateConversationProfileRequest

The request to send to the server.

optionsCallOptions

The options for the call.

Returns
TypeDescription
AsyncUnaryCallConversationProfile

The call object.

UpdateConversationProfileAsync(UpdateConversationProfileRequest, Metadata, DateTime?, CancellationToken)

public virtual AsyncUnaryCall<ConversationProfile> UpdateConversationProfileAsync(UpdateConversationProfileRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default)

Updates the specified conversation profile.

[ConversationProfile.CreateTime][] and [ConversationProfile.UpdateTime][] aren't populated in the response. You can retrieve them via [GetConversationProfile][google.cloud.dialogflow.v2.ConversationProfiles.GetConversationProfile] API.

Parameters
NameDescription
requestUpdateConversationProfileRequest

The request to send to the server.

headersMetadata

The initial metadata to send with the call. This parameter is optional.

deadlineDateTime

An optional deadline for the call. The call will be cancelled if deadline is hit.

cancellationTokenCancellationToken

An optional token for canceling the call.

Returns
TypeDescription
AsyncUnaryCallConversationProfile

The call object.