Google Cloud Dialogflow v2 API - Class ConversationProfilesClientImpl (4.2.0)

Stay organized with collections Save and categorize content based on your preferences.
public sealed class ConversationProfilesClientImpl : ConversationProfilesClient

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

ConversationProfiles client wrapper implementation, for convenient use.

Inheritance

Object > ConversationProfilesClient > ConversationProfilesClientImpl

Namespace

Google.Cloud.Dialogflow.V2

Assembly

Google.Cloud.Dialogflow.V2.dll

Remarks

Service for managing [ConversationProfiles][google.cloud.dialogflow.v2.ConversationProfile].

Constructors

ConversationProfilesClientImpl(ConversationProfiles.ConversationProfilesClient, ConversationProfilesSettings, ILogger)

public ConversationProfilesClientImpl(ConversationProfiles.ConversationProfilesClient grpcClient, ConversationProfilesSettings settings, ILogger logger)

Constructs a client wrapper for the ConversationProfiles service, with the specified gRPC client and settings.

Parameters
NameDescription
grpcClientConversationProfiles.ConversationProfilesClient

The underlying gRPC client.

settingsConversationProfilesSettings

The base ConversationProfilesSettings used within this client.

loggerILogger

Optional ILogger to use within this client.

Properties

ClearSuggestionFeatureConfigOperationsClient

public override OperationsClient ClearSuggestionFeatureConfigOperationsClient { get; }

The long-running operations client for ClearSuggestionFeatureConfig.

Property Value
TypeDescription
OperationsClient
Overrides

GrpcClient

public override ConversationProfiles.ConversationProfilesClient GrpcClient { get; }

The underlying gRPC ConversationProfiles client

Property Value
TypeDescription
ConversationProfiles.ConversationProfilesClient
Overrides

LocationsClient

public override LocationsClient LocationsClient { get; }

The LocationsClient associated with this client.

Property Value
TypeDescription
LocationsClient
Overrides

SetSuggestionFeatureConfigOperationsClient

public override OperationsClient SetSuggestionFeatureConfigOperationsClient { get; }

The long-running operations client for SetSuggestionFeatureConfig.

Property Value
TypeDescription
OperationsClient
Overrides

Methods

ClearSuggestionFeatureConfig(ClearSuggestionFeatureConfigRequest, CallSettings)

public override Operation<ConversationProfile, ClearSuggestionFeatureConfigOperationMetadata> ClearSuggestionFeatureConfig(ClearSuggestionFeatureConfigRequest request, CallSettings callSettings = null)

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 object containing all of the parameters for the API call.

callSettingsCallSettings

If not null, applies overrides to this RPC call.

Returns
TypeDescription
Operation<ConversationProfile, ClearSuggestionFeatureConfigOperationMetadata>

The RPC response.

Overrides

ClearSuggestionFeatureConfigAsync(ClearSuggestionFeatureConfigRequest, CallSettings)

public override async Task<Operation<ConversationProfile, ClearSuggestionFeatureConfigOperationMetadata>> ClearSuggestionFeatureConfigAsync(ClearSuggestionFeatureConfigRequest request, CallSettings callSettings = null)

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 object containing all of the parameters for the API call.

callSettingsCallSettings

If not null, applies overrides to this RPC call.

Returns
TypeDescription
Task<Operation<ConversationProfile, ClearSuggestionFeatureConfigOperationMetadata>>

A Task containing the RPC response.

Overrides

CreateConversationProfile(CreateConversationProfileRequest, CallSettings)

public override ConversationProfile CreateConversationProfile(CreateConversationProfileRequest request, CallSettings callSettings = null)

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 object containing all of the parameters for the API call.

callSettingsCallSettings

If not null, applies overrides to this RPC call.

Returns
TypeDescription
ConversationProfile

The RPC response.

Overrides

CreateConversationProfileAsync(CreateConversationProfileRequest, CallSettings)

public override Task<ConversationProfile> CreateConversationProfileAsync(CreateConversationProfileRequest request, CallSettings callSettings = null)

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 object containing all of the parameters for the API call.

callSettingsCallSettings

If not null, applies overrides to this RPC call.

Returns
TypeDescription
Task<ConversationProfile>

A Task containing the RPC response.

Overrides

DeleteConversationProfile(DeleteConversationProfileRequest, CallSettings)

public override void DeleteConversationProfile(DeleteConversationProfileRequest request, CallSettings callSettings = null)

Deletes the specified conversation profile.

Parameters
NameDescription
requestDeleteConversationProfileRequest

The request object containing all of the parameters for the API call.

callSettingsCallSettings

If not null, applies overrides to this RPC call.

Overrides

DeleteConversationProfileAsync(DeleteConversationProfileRequest, CallSettings)

public override Task DeleteConversationProfileAsync(DeleteConversationProfileRequest request, CallSettings callSettings = null)

Deletes the specified conversation profile.

Parameters
NameDescription
requestDeleteConversationProfileRequest

The request object containing all of the parameters for the API call.

callSettingsCallSettings

If not null, applies overrides to this RPC call.

Returns
TypeDescription
Task

A Task containing the RPC response.

Overrides

GetConversationProfile(GetConversationProfileRequest, CallSettings)

public override ConversationProfile GetConversationProfile(GetConversationProfileRequest request, CallSettings callSettings = null)

Retrieves the specified conversation profile.

Parameters
NameDescription
requestGetConversationProfileRequest

The request object containing all of the parameters for the API call.

callSettingsCallSettings

If not null, applies overrides to this RPC call.

Returns
TypeDescription
ConversationProfile

The RPC response.

Overrides

GetConversationProfileAsync(GetConversationProfileRequest, CallSettings)

public override Task<ConversationProfile> GetConversationProfileAsync(GetConversationProfileRequest request, CallSettings callSettings = null)

Retrieves the specified conversation profile.

Parameters
NameDescription
requestGetConversationProfileRequest

The request object containing all of the parameters for the API call.

callSettingsCallSettings

If not null, applies overrides to this RPC call.

Returns
TypeDescription
Task<ConversationProfile>

A Task containing the RPC response.

Overrides

ListConversationProfiles(ListConversationProfilesRequest, CallSettings)

public override PagedEnumerable<ListConversationProfilesResponse, ConversationProfile> ListConversationProfiles(ListConversationProfilesRequest request, CallSettings callSettings = null)

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

Parameters
NameDescription
requestListConversationProfilesRequest

The request object containing all of the parameters for the API call.

callSettingsCallSettings

If not null, applies overrides to this RPC call.

Returns
TypeDescription
PagedEnumerable<ListConversationProfilesResponse, ConversationProfile>

A pageable sequence of ConversationProfile resources.

Overrides

ListConversationProfilesAsync(ListConversationProfilesRequest, CallSettings)

public override PagedAsyncEnumerable<ListConversationProfilesResponse, ConversationProfile> ListConversationProfilesAsync(ListConversationProfilesRequest request, CallSettings callSettings = null)

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

Parameters
NameDescription
requestListConversationProfilesRequest

The request object containing all of the parameters for the API call.

callSettingsCallSettings

If not null, applies overrides to this RPC call.

Returns
TypeDescription
PagedAsyncEnumerable<ListConversationProfilesResponse, ConversationProfile>

A pageable asynchronous sequence of ConversationProfile resources.

Overrides

SetSuggestionFeatureConfig(SetSuggestionFeatureConfigRequest, CallSettings)

public override Operation<ConversationProfile, SetSuggestionFeatureConfigOperationMetadata> SetSuggestionFeatureConfig(SetSuggestionFeatureConfigRequest request, CallSettings callSettings = null)

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 object containing all of the parameters for the API call.

callSettingsCallSettings

If not null, applies overrides to this RPC call.

Returns
TypeDescription
Operation<ConversationProfile, SetSuggestionFeatureConfigOperationMetadata>

The RPC response.

Overrides

SetSuggestionFeatureConfigAsync(SetSuggestionFeatureConfigRequest, CallSettings)

public override async Task<Operation<ConversationProfile, SetSuggestionFeatureConfigOperationMetadata>> SetSuggestionFeatureConfigAsync(SetSuggestionFeatureConfigRequest request, CallSettings callSettings = null)

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 object containing all of the parameters for the API call.

callSettingsCallSettings

If not null, applies overrides to this RPC call.

Returns
TypeDescription
Task<Operation<ConversationProfile, SetSuggestionFeatureConfigOperationMetadata>>

A Task containing the RPC response.

Overrides

UpdateConversationProfile(UpdateConversationProfileRequest, CallSettings)

public override ConversationProfile UpdateConversationProfile(UpdateConversationProfileRequest request, CallSettings callSettings = null)

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 object containing all of the parameters for the API call.

callSettingsCallSettings

If not null, applies overrides to this RPC call.

Returns
TypeDescription
ConversationProfile

The RPC response.

Overrides

UpdateConversationProfileAsync(UpdateConversationProfileRequest, CallSettings)

public override Task<ConversationProfile> UpdateConversationProfileAsync(UpdateConversationProfileRequest request, CallSettings callSettings = null)

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 object containing all of the parameters for the API call.

callSettingsCallSettings

If not null, applies overrides to this RPC call.

Returns
TypeDescription
Task<ConversationProfile>

A Task containing the RPC response.

Overrides