Class ConversationProfilesClient
- java.lang.Object
-
- com.google.cloud.dialogflow.v2.ConversationProfilesClient
-
- All Implemented Interfaces:
com.google.api.gax.core.BackgroundResource
,AutoCloseable
@Generated("by gapic-generator-java") public class ConversationProfilesClient extends Object implements com.google.api.gax.core.BackgroundResource
Service Description: Service for managing [ConversationProfiles][google.cloud.dialogflow.v2.ConversationProfile].This class provides the ability to make remote calls to the backing service through method calls that map to API methods. Sample code to get started:
// This snippet has been automatically generated and should be regarded as a code template only. // It will require modifications to work: // - It may require correct/in-range values for request initialization. // - It may require specifying regional endpoints when creating the service client as shown in // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library try (ConversationProfilesClient conversationProfilesClient = ConversationProfilesClient.create()) { ConversationProfileName name = ConversationProfileName.ofProjectConversationProfileName( "[PROJECT]", "[CONVERSATION_PROFILE]"); ConversationProfile response = conversationProfilesClient.getConversationProfile(name); }
Note: close() needs to be called on the ConversationProfilesClient object to clean up resources such as threads. In the example above, try-with-resources is used, which automatically calls close().
The surface of this class includes several types of Java methods for each of the API's methods:
- A "flattened" method. With this type of method, the fields of the request type have been converted into function parameters. It may be the case that not all fields are available as parameters, and not every API method will have a flattened method entry point.
- A "request object" method. This type of method only takes one parameter, a request object, which must be constructed before the call. Not every API method will have a request object method.
- A "callable" method. This type of method takes no parameters and returns an immutable API callable object, which can be used to initiate calls to the service.
See the individual methods for example code.
Many parameters require resource names to be formatted in a particular way. To assist with these names, this class includes a format method for each type of name, and additionally a parse method to extract the individual identifiers contained within names that are returned.
This class can be customized by passing in a custom instance of ConversationProfilesSettings to create(). For example:
To customize credentials:
// This snippet has been automatically generated and should be regarded as a code template only. // It will require modifications to work: // - It may require correct/in-range values for request initialization. // - It may require specifying regional endpoints when creating the service client as shown in // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library ConversationProfilesSettings conversationProfilesSettings = ConversationProfilesSettings.newBuilder() .setCredentialsProvider(FixedCredentialsProvider.create(myCredentials)) .build(); ConversationProfilesClient conversationProfilesClient = ConversationProfilesClient.create(conversationProfilesSettings);
To customize the endpoint:
// This snippet has been automatically generated and should be regarded as a code template only. // It will require modifications to work: // - It may require correct/in-range values for request initialization. // - It may require specifying regional endpoints when creating the service client as shown in // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library ConversationProfilesSettings conversationProfilesSettings = ConversationProfilesSettings.newBuilder().setEndpoint(myEndpoint).build(); ConversationProfilesClient conversationProfilesClient = ConversationProfilesClient.create(conversationProfilesSettings);
To use REST (HTTP1.1/JSON) transport (instead of gRPC) for sending and receiving requests over the wire:
// This snippet has been automatically generated and should be regarded as a code template only. // It will require modifications to work: // - It may require correct/in-range values for request initialization. // - It may require specifying regional endpoints when creating the service client as shown in // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library ConversationProfilesSettings conversationProfilesSettings = ConversationProfilesSettings.newHttpJsonBuilder().build(); ConversationProfilesClient conversationProfilesClient = ConversationProfilesClient.create(conversationProfilesSettings);
Please refer to the GitHub repository's samples for more quickstart code snippets.
-
-
Nested Class Summary
Nested Classes Modifier and Type Class Description static class
ConversationProfilesClient.ListConversationProfilesFixedSizeCollection
static class
ConversationProfilesClient.ListConversationProfilesPage
static class
ConversationProfilesClient.ListConversationProfilesPagedResponse
static class
ConversationProfilesClient.ListLocationsFixedSizeCollection
static class
ConversationProfilesClient.ListLocationsPage
static class
ConversationProfilesClient.ListLocationsPagedResponse
-
Constructor Summary
Constructors Modifier Constructor Description protected
ConversationProfilesClient(ConversationProfilesSettings settings)
Constructs an instance of ConversationProfilesClient, using the given settings.protected
ConversationProfilesClient(ConversationProfilesStub stub)
-
Method Summary
All Methods Static Methods Instance Methods Concrete Methods Modifier and Type Method Description boolean
awaitTermination(long duration, TimeUnit unit)
com.google.api.gax.longrunning.OperationFuture<ConversationProfile,ClearSuggestionFeatureConfigOperationMetadata>
clearSuggestionFeatureConfigAsync(ClearSuggestionFeatureConfigRequest request)
Clears a suggestion feature from a conversation profile for the given participant role.com.google.api.gax.longrunning.OperationFuture<ConversationProfile,ClearSuggestionFeatureConfigOperationMetadata>
clearSuggestionFeatureConfigAsync(String conversationProfile)
Clears a suggestion feature from a conversation profile for the given participant role.com.google.api.gax.longrunning.OperationFuture<ConversationProfile,ClearSuggestionFeatureConfigOperationMetadata>
clearSuggestionFeatureConfigAsync(String conversationProfile, Participant.Role participantRole, SuggestionFeature.Type suggestionFeatureType)
Clears a suggestion feature from a conversation profile for the given participant role.com.google.api.gax.rpc.UnaryCallable<ClearSuggestionFeatureConfigRequest,com.google.longrunning.Operation>
clearSuggestionFeatureConfigCallable()
Clears a suggestion feature from a conversation profile for the given participant role.com.google.api.gax.rpc.OperationCallable<ClearSuggestionFeatureConfigRequest,ConversationProfile,ClearSuggestionFeatureConfigOperationMetadata>
clearSuggestionFeatureConfigOperationCallable()
Clears a suggestion feature from a conversation profile for the given participant role.void
close()
static ConversationProfilesClient
create()
Constructs an instance of ConversationProfilesClient with default settings.static ConversationProfilesClient
create(ConversationProfilesSettings settings)
Constructs an instance of ConversationProfilesClient, using the given settings.static ConversationProfilesClient
create(ConversationProfilesStub stub)
Constructs an instance of ConversationProfilesClient, using the given stub for making calls.ConversationProfile
createConversationProfile(CreateConversationProfileRequest request)
Creates a conversation profile in the specified project.ConversationProfile
createConversationProfile(LocationName parent, ConversationProfile conversationProfile)
Creates a conversation profile in the specified project.ConversationProfile
createConversationProfile(ProjectName parent, ConversationProfile conversationProfile)
Creates a conversation profile in the specified project.ConversationProfile
createConversationProfile(String parent, ConversationProfile conversationProfile)
Creates a conversation profile in the specified project.com.google.api.gax.rpc.UnaryCallable<CreateConversationProfileRequest,ConversationProfile>
createConversationProfileCallable()
Creates a conversation profile in the specified project.void
deleteConversationProfile(ConversationProfileName name)
Deletes the specified conversation profile.void
deleteConversationProfile(DeleteConversationProfileRequest request)
Deletes the specified conversation profile.void
deleteConversationProfile(String name)
Deletes the specified conversation profile.com.google.api.gax.rpc.UnaryCallable<DeleteConversationProfileRequest,com.google.protobuf.Empty>
deleteConversationProfileCallable()
Deletes the specified conversation profile.ConversationProfile
getConversationProfile(ConversationProfileName name)
Retrieves the specified conversation profile.ConversationProfile
getConversationProfile(GetConversationProfileRequest request)
Retrieves the specified conversation profile.ConversationProfile
getConversationProfile(String name)
Retrieves the specified conversation profile.com.google.api.gax.rpc.UnaryCallable<GetConversationProfileRequest,ConversationProfile>
getConversationProfileCallable()
Retrieves the specified conversation profile.com.google.api.gax.httpjson.longrunning.OperationsClient
getHttpJsonOperationsClient()
Returns the OperationsClient that can be used to query the status of a long-running operation returned by another API method call.com.google.cloud.location.Location
getLocation(com.google.cloud.location.GetLocationRequest request)
Gets information about a location.com.google.api.gax.rpc.UnaryCallable<com.google.cloud.location.GetLocationRequest,com.google.cloud.location.Location>
getLocationCallable()
Gets information about a location.com.google.longrunning.OperationsClient
getOperationsClient()
Returns the OperationsClient that can be used to query the status of a long-running operation returned by another API method call.ConversationProfilesSettings
getSettings()
ConversationProfilesStub
getStub()
boolean
isShutdown()
boolean
isTerminated()
ConversationProfilesClient.ListConversationProfilesPagedResponse
listConversationProfiles(ListConversationProfilesRequest request)
Returns the list of all conversation profiles in the specified project.ConversationProfilesClient.ListConversationProfilesPagedResponse
listConversationProfiles(LocationName parent)
Returns the list of all conversation profiles in the specified project.ConversationProfilesClient.ListConversationProfilesPagedResponse
listConversationProfiles(ProjectName parent)
Returns the list of all conversation profiles in the specified project.ConversationProfilesClient.ListConversationProfilesPagedResponse
listConversationProfiles(String parent)
Returns the list of all conversation profiles in the specified project.com.google.api.gax.rpc.UnaryCallable<ListConversationProfilesRequest,ListConversationProfilesResponse>
listConversationProfilesCallable()
Returns the list of all conversation profiles in the specified project.com.google.api.gax.rpc.UnaryCallable<ListConversationProfilesRequest,ConversationProfilesClient.ListConversationProfilesPagedResponse>
listConversationProfilesPagedCallable()
Returns the list of all conversation profiles in the specified project.ConversationProfilesClient.ListLocationsPagedResponse
listLocations(com.google.cloud.location.ListLocationsRequest request)
Lists information about the supported locations for this service.com.google.api.gax.rpc.UnaryCallable<com.google.cloud.location.ListLocationsRequest,com.google.cloud.location.ListLocationsResponse>
listLocationsCallable()
Lists information about the supported locations for this service.com.google.api.gax.rpc.UnaryCallable<com.google.cloud.location.ListLocationsRequest,ConversationProfilesClient.ListLocationsPagedResponse>
listLocationsPagedCallable()
Lists information about the supported locations for this service.com.google.api.gax.longrunning.OperationFuture<ConversationProfile,SetSuggestionFeatureConfigOperationMetadata>
setSuggestionFeatureConfigAsync(SetSuggestionFeatureConfigRequest request)
Adds or updates a suggestion feature in a conversation profile.com.google.api.gax.longrunning.OperationFuture<ConversationProfile,SetSuggestionFeatureConfigOperationMetadata>
setSuggestionFeatureConfigAsync(String conversationProfile)
Adds or updates a suggestion feature in a conversation profile.com.google.api.gax.longrunning.OperationFuture<ConversationProfile,SetSuggestionFeatureConfigOperationMetadata>
setSuggestionFeatureConfigAsync(String conversationProfile, Participant.Role participantRole, HumanAgentAssistantConfig.SuggestionFeatureConfig suggestionFeatureConfig)
Adds or updates a suggestion feature in a conversation profile.com.google.api.gax.rpc.UnaryCallable<SetSuggestionFeatureConfigRequest,com.google.longrunning.Operation>
setSuggestionFeatureConfigCallable()
Adds or updates a suggestion feature in a conversation profile.com.google.api.gax.rpc.OperationCallable<SetSuggestionFeatureConfigRequest,ConversationProfile,SetSuggestionFeatureConfigOperationMetadata>
setSuggestionFeatureConfigOperationCallable()
Adds or updates a suggestion feature in a conversation profile.void
shutdown()
void
shutdownNow()
ConversationProfile
updateConversationProfile(ConversationProfile conversationProfile, com.google.protobuf.FieldMask updateMask)
Updates the specified conversation profile.ConversationProfile
updateConversationProfile(UpdateConversationProfileRequest request)
Updates the specified conversation profile.com.google.api.gax.rpc.UnaryCallable<UpdateConversationProfileRequest,ConversationProfile>
updateConversationProfileCallable()
Updates the specified conversation profile.
-
-
-
Constructor Detail
-
ConversationProfilesClient
protected ConversationProfilesClient(ConversationProfilesSettings settings) throws IOException
Constructs an instance of ConversationProfilesClient, using the given settings. This is protected so that it is easy to make a subclass, but otherwise, the static factory methods should be preferred.- Throws:
IOException
-
ConversationProfilesClient
protected ConversationProfilesClient(ConversationProfilesStub stub)
-
-
Method Detail
-
create
public static final ConversationProfilesClient create() throws IOException
Constructs an instance of ConversationProfilesClient with default settings.- Throws:
IOException
-
create
public static final ConversationProfilesClient create(ConversationProfilesSettings settings) throws IOException
Constructs an instance of ConversationProfilesClient, using the given settings. The channels are created based on the settings passed in, or defaults for any settings that are not set.- Throws:
IOException
-
create
public static final ConversationProfilesClient create(ConversationProfilesStub stub)
Constructs an instance of ConversationProfilesClient, using the given stub for making calls. This is for advanced usage - prefer using create(ConversationProfilesSettings).
-
getSettings
public final ConversationProfilesSettings getSettings()
-
getStub
public ConversationProfilesStub getStub()
-
getOperationsClient
public final com.google.longrunning.OperationsClient getOperationsClient()
Returns the OperationsClient that can be used to query the status of a long-running operation returned by another API method call.
-
getHttpJsonOperationsClient
@BetaApi public final com.google.api.gax.httpjson.longrunning.OperationsClient getHttpJsonOperationsClient()
Returns the OperationsClient that can be used to query the status of a long-running operation returned by another API method call.
-
listConversationProfiles
public final ConversationProfilesClient.ListConversationProfilesPagedResponse listConversationProfiles(LocationName parent)
Returns the list of all conversation profiles in the specified project.Sample code:
// This snippet has been automatically generated and should be regarded as a code template only. // It will require modifications to work: // - It may require correct/in-range values for request initialization. // - It may require specifying regional endpoints when creating the service client as shown in // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library try (ConversationProfilesClient conversationProfilesClient = ConversationProfilesClient.create()) { LocationName parent = LocationName.of("[PROJECT]", "[LOCATION]"); for (ConversationProfile element : conversationProfilesClient.listConversationProfiles(parent).iterateAll()) { // doThingsWith(element); } }
- Parameters:
parent
- Required. The project to list all conversation profiles from. Format: `projects/<Project ID>/locations/<Location ID>`.- Throws:
com.google.api.gax.rpc.ApiException
- if the remote call fails
-
listConversationProfiles
public final ConversationProfilesClient.ListConversationProfilesPagedResponse listConversationProfiles(ProjectName parent)
Returns the list of all conversation profiles in the specified project.Sample code:
// This snippet has been automatically generated and should be regarded as a code template only. // It will require modifications to work: // - It may require correct/in-range values for request initialization. // - It may require specifying regional endpoints when creating the service client as shown in // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library try (ConversationProfilesClient conversationProfilesClient = ConversationProfilesClient.create()) { ProjectName parent = ProjectName.of("[PROJECT]"); for (ConversationProfile element : conversationProfilesClient.listConversationProfiles(parent).iterateAll()) { // doThingsWith(element); } }
- Parameters:
parent
- Required. The project to list all conversation profiles from. Format: `projects/<Project ID>/locations/<Location ID>`.- Throws:
com.google.api.gax.rpc.ApiException
- if the remote call fails
-
listConversationProfiles
public final ConversationProfilesClient.ListConversationProfilesPagedResponse listConversationProfiles(String parent)
Returns the list of all conversation profiles in the specified project.Sample code:
// This snippet has been automatically generated and should be regarded as a code template only. // It will require modifications to work: // - It may require correct/in-range values for request initialization. // - It may require specifying regional endpoints when creating the service client as shown in // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library try (ConversationProfilesClient conversationProfilesClient = ConversationProfilesClient.create()) { String parent = ProjectName.of("[PROJECT]").toString(); for (ConversationProfile element : conversationProfilesClient.listConversationProfiles(parent).iterateAll()) { // doThingsWith(element); } }
- Parameters:
parent
- Required. The project to list all conversation profiles from. Format: `projects/<Project ID>/locations/<Location ID>`.- Throws:
com.google.api.gax.rpc.ApiException
- if the remote call fails
-
listConversationProfiles
public final ConversationProfilesClient.ListConversationProfilesPagedResponse listConversationProfiles(ListConversationProfilesRequest request)
Returns the list of all conversation profiles in the specified project.Sample code:
// This snippet has been automatically generated and should be regarded as a code template only. // It will require modifications to work: // - It may require correct/in-range values for request initialization. // - It may require specifying regional endpoints when creating the service client as shown in // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library try (ConversationProfilesClient conversationProfilesClient = ConversationProfilesClient.create()) { ListConversationProfilesRequest request = ListConversationProfilesRequest.newBuilder() .setParent(ProjectName.of("[PROJECT]").toString()) .setPageSize(883849137) .setPageToken("pageToken873572522") .build(); for (ConversationProfile element : conversationProfilesClient.listConversationProfiles(request).iterateAll()) { // doThingsWith(element); } }
- Parameters:
request
- The request object containing all of the parameters for the API call.- Throws:
com.google.api.gax.rpc.ApiException
- if the remote call fails
-
listConversationProfilesPagedCallable
public final com.google.api.gax.rpc.UnaryCallable<ListConversationProfilesRequest,ConversationProfilesClient.ListConversationProfilesPagedResponse> listConversationProfilesPagedCallable()
Returns the list of all conversation profiles in the specified project.Sample code:
// This snippet has been automatically generated and should be regarded as a code template only. // It will require modifications to work: // - It may require correct/in-range values for request initialization. // - It may require specifying regional endpoints when creating the service client as shown in // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library try (ConversationProfilesClient conversationProfilesClient = ConversationProfilesClient.create()) { ListConversationProfilesRequest request = ListConversationProfilesRequest.newBuilder() .setParent(ProjectName.of("[PROJECT]").toString()) .setPageSize(883849137) .setPageToken("pageToken873572522") .build(); ApiFuture<ConversationProfile> future = conversationProfilesClient.listConversationProfilesPagedCallable().futureCall(request); // Do something. for (ConversationProfile element : future.get().iterateAll()) { // doThingsWith(element); } }
-
listConversationProfilesCallable
public final com.google.api.gax.rpc.UnaryCallable<ListConversationProfilesRequest,ListConversationProfilesResponse> listConversationProfilesCallable()
Returns the list of all conversation profiles in the specified project.Sample code:
// This snippet has been automatically generated and should be regarded as a code template only. // It will require modifications to work: // - It may require correct/in-range values for request initialization. // - It may require specifying regional endpoints when creating the service client as shown in // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library try (ConversationProfilesClient conversationProfilesClient = ConversationProfilesClient.create()) { ListConversationProfilesRequest request = ListConversationProfilesRequest.newBuilder() .setParent(ProjectName.of("[PROJECT]").toString()) .setPageSize(883849137) .setPageToken("pageToken873572522") .build(); while (true) { ListConversationProfilesResponse response = conversationProfilesClient.listConversationProfilesCallable().call(request); for (ConversationProfile element : response.getConversationProfilesList()) { // doThingsWith(element); } String nextPageToken = response.getNextPageToken(); if (!Strings.isNullOrEmpty(nextPageToken)) { request = request.toBuilder().setPageToken(nextPageToken).build(); } else { break; } } }
-
getConversationProfile
public final ConversationProfile getConversationProfile(ConversationProfileName name)
Retrieves the specified conversation profile.Sample code:
// This snippet has been automatically generated and should be regarded as a code template only. // It will require modifications to work: // - It may require correct/in-range values for request initialization. // - It may require specifying regional endpoints when creating the service client as shown in // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library try (ConversationProfilesClient conversationProfilesClient = ConversationProfilesClient.create()) { ConversationProfileName name = ConversationProfileName.ofProjectConversationProfileName( "[PROJECT]", "[CONVERSATION_PROFILE]"); ConversationProfile response = conversationProfilesClient.getConversationProfile(name); }
- Parameters:
name
- Required. The resource name of the conversation profile. Format: `projects/<Project ID>/locations/<Location ID>/conversationProfiles/<Conversation Profile ID>`.- Throws:
com.google.api.gax.rpc.ApiException
- if the remote call fails
-
getConversationProfile
public final ConversationProfile getConversationProfile(String name)
Retrieves the specified conversation profile.Sample code:
// This snippet has been automatically generated and should be regarded as a code template only. // It will require modifications to work: // - It may require correct/in-range values for request initialization. // - It may require specifying regional endpoints when creating the service client as shown in // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library try (ConversationProfilesClient conversationProfilesClient = ConversationProfilesClient.create()) { String name = ConversationProfileName.ofProjectConversationProfileName( "[PROJECT]", "[CONVERSATION_PROFILE]") .toString(); ConversationProfile response = conversationProfilesClient.getConversationProfile(name); }
- Parameters:
name
- Required. The resource name of the conversation profile. Format: `projects/<Project ID>/locations/<Location ID>/conversationProfiles/<Conversation Profile ID>`.- Throws:
com.google.api.gax.rpc.ApiException
- if the remote call fails
-
getConversationProfile
public final ConversationProfile getConversationProfile(GetConversationProfileRequest request)
Retrieves the specified conversation profile.Sample code:
// This snippet has been automatically generated and should be regarded as a code template only. // It will require modifications to work: // - It may require correct/in-range values for request initialization. // - It may require specifying regional endpoints when creating the service client as shown in // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library try (ConversationProfilesClient conversationProfilesClient = ConversationProfilesClient.create()) { GetConversationProfileRequest request = GetConversationProfileRequest.newBuilder() .setName( ConversationProfileName.ofProjectConversationProfileName( "[PROJECT]", "[CONVERSATION_PROFILE]") .toString()) .build(); ConversationProfile response = conversationProfilesClient.getConversationProfile(request); }
- Parameters:
request
- The request object containing all of the parameters for the API call.- Throws:
com.google.api.gax.rpc.ApiException
- if the remote call fails
-
getConversationProfileCallable
public final com.google.api.gax.rpc.UnaryCallable<GetConversationProfileRequest,ConversationProfile> getConversationProfileCallable()
Retrieves the specified conversation profile.Sample code:
// This snippet has been automatically generated and should be regarded as a code template only. // It will require modifications to work: // - It may require correct/in-range values for request initialization. // - It may require specifying regional endpoints when creating the service client as shown in // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library try (ConversationProfilesClient conversationProfilesClient = ConversationProfilesClient.create()) { GetConversationProfileRequest request = GetConversationProfileRequest.newBuilder() .setName( ConversationProfileName.ofProjectConversationProfileName( "[PROJECT]", "[CONVERSATION_PROFILE]") .toString()) .build(); ApiFuture<ConversationProfile> future = conversationProfilesClient.getConversationProfileCallable().futureCall(request); // Do something. ConversationProfile response = future.get(); }
-
createConversationProfile
public final ConversationProfile createConversationProfile(LocationName parent, ConversationProfile conversationProfile)
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.
Sample code:
// This snippet has been automatically generated and should be regarded as a code template only. // It will require modifications to work: // - It may require correct/in-range values for request initialization. // - It may require specifying regional endpoints when creating the service client as shown in // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library try (ConversationProfilesClient conversationProfilesClient = ConversationProfilesClient.create()) { LocationName parent = LocationName.of("[PROJECT]", "[LOCATION]"); ConversationProfile conversationProfile = ConversationProfile.newBuilder().build(); ConversationProfile response = conversationProfilesClient.createConversationProfile(parent, conversationProfile); }
- Parameters:
parent
- Required. The project to create a conversation profile for. Format: `projects/<Project ID>/locations/<Location ID>`.conversationProfile
- Required. The conversation profile to create.- Throws:
com.google.api.gax.rpc.ApiException
- if the remote call fails
-
createConversationProfile
public final ConversationProfile createConversationProfile(ProjectName parent, ConversationProfile conversationProfile)
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.
Sample code:
// This snippet has been automatically generated and should be regarded as a code template only. // It will require modifications to work: // - It may require correct/in-range values for request initialization. // - It may require specifying regional endpoints when creating the service client as shown in // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library try (ConversationProfilesClient conversationProfilesClient = ConversationProfilesClient.create()) { ProjectName parent = ProjectName.of("[PROJECT]"); ConversationProfile conversationProfile = ConversationProfile.newBuilder().build(); ConversationProfile response = conversationProfilesClient.createConversationProfile(parent, conversationProfile); }
- Parameters:
parent
- Required. The project to create a conversation profile for. Format: `projects/<Project ID>/locations/<Location ID>`.conversationProfile
- Required. The conversation profile to create.- Throws:
com.google.api.gax.rpc.ApiException
- if the remote call fails
-
createConversationProfile
public final ConversationProfile createConversationProfile(String parent, ConversationProfile conversationProfile)
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.
Sample code:
// This snippet has been automatically generated and should be regarded as a code template only. // It will require modifications to work: // - It may require correct/in-range values for request initialization. // - It may require specifying regional endpoints when creating the service client as shown in // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library try (ConversationProfilesClient conversationProfilesClient = ConversationProfilesClient.create()) { String parent = ProjectName.of("[PROJECT]").toString(); ConversationProfile conversationProfile = ConversationProfile.newBuilder().build(); ConversationProfile response = conversationProfilesClient.createConversationProfile(parent, conversationProfile); }
- Parameters:
parent
- Required. The project to create a conversation profile for. Format: `projects/<Project ID>/locations/<Location ID>`.conversationProfile
- Required. The conversation profile to create.- Throws:
com.google.api.gax.rpc.ApiException
- if the remote call fails
-
createConversationProfile
public final ConversationProfile createConversationProfile(CreateConversationProfileRequest request)
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.
Sample code:
// This snippet has been automatically generated and should be regarded as a code template only. // It will require modifications to work: // - It may require correct/in-range values for request initialization. // - It may require specifying regional endpoints when creating the service client as shown in // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library try (ConversationProfilesClient conversationProfilesClient = ConversationProfilesClient.create()) { CreateConversationProfileRequest request = CreateConversationProfileRequest.newBuilder() .setParent(ProjectName.of("[PROJECT]").toString()) .setConversationProfile(ConversationProfile.newBuilder().build()) .build(); ConversationProfile response = conversationProfilesClient.createConversationProfile(request); }
- Parameters:
request
- The request object containing all of the parameters for the API call.- Throws:
com.google.api.gax.rpc.ApiException
- if the remote call fails
-
createConversationProfileCallable
public final com.google.api.gax.rpc.UnaryCallable<CreateConversationProfileRequest,ConversationProfile> createConversationProfileCallable()
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.
Sample code:
// This snippet has been automatically generated and should be regarded as a code template only. // It will require modifications to work: // - It may require correct/in-range values for request initialization. // - It may require specifying regional endpoints when creating the service client as shown in // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library try (ConversationProfilesClient conversationProfilesClient = ConversationProfilesClient.create()) { CreateConversationProfileRequest request = CreateConversationProfileRequest.newBuilder() .setParent(ProjectName.of("[PROJECT]").toString()) .setConversationProfile(ConversationProfile.newBuilder().build()) .build(); ApiFuture<ConversationProfile> future = conversationProfilesClient.createConversationProfileCallable().futureCall(request); // Do something. ConversationProfile response = future.get(); }
-
updateConversationProfile
public final ConversationProfile updateConversationProfile(ConversationProfile conversationProfile, com.google.protobuf.FieldMask updateMask)
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.
Sample code:
// This snippet has been automatically generated and should be regarded as a code template only. // It will require modifications to work: // - It may require correct/in-range values for request initialization. // - It may require specifying regional endpoints when creating the service client as shown in // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library try (ConversationProfilesClient conversationProfilesClient = ConversationProfilesClient.create()) { ConversationProfile conversationProfile = ConversationProfile.newBuilder().build(); FieldMask updateMask = FieldMask.newBuilder().build(); ConversationProfile response = conversationProfilesClient.updateConversationProfile(conversationProfile, updateMask); }
- Parameters:
conversationProfile
- Required. The conversation profile to update.updateMask
- Required. The mask to control which fields to update.- Throws:
com.google.api.gax.rpc.ApiException
- if the remote call fails
-
updateConversationProfile
public final ConversationProfile updateConversationProfile(UpdateConversationProfileRequest request)
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.
Sample code:
// This snippet has been automatically generated and should be regarded as a code template only. // It will require modifications to work: // - It may require correct/in-range values for request initialization. // - It may require specifying regional endpoints when creating the service client as shown in // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library try (ConversationProfilesClient conversationProfilesClient = ConversationProfilesClient.create()) { UpdateConversationProfileRequest request = UpdateConversationProfileRequest.newBuilder() .setConversationProfile(ConversationProfile.newBuilder().build()) .setUpdateMask(FieldMask.newBuilder().build()) .build(); ConversationProfile response = conversationProfilesClient.updateConversationProfile(request); }
- Parameters:
request
- The request object containing all of the parameters for the API call.- Throws:
com.google.api.gax.rpc.ApiException
- if the remote call fails
-
updateConversationProfileCallable
public final com.google.api.gax.rpc.UnaryCallable<UpdateConversationProfileRequest,ConversationProfile> updateConversationProfileCallable()
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.
Sample code:
// This snippet has been automatically generated and should be regarded as a code template only. // It will require modifications to work: // - It may require correct/in-range values for request initialization. // - It may require specifying regional endpoints when creating the service client as shown in // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library try (ConversationProfilesClient conversationProfilesClient = ConversationProfilesClient.create()) { UpdateConversationProfileRequest request = UpdateConversationProfileRequest.newBuilder() .setConversationProfile(ConversationProfile.newBuilder().build()) .setUpdateMask(FieldMask.newBuilder().build()) .build(); ApiFuture<ConversationProfile> future = conversationProfilesClient.updateConversationProfileCallable().futureCall(request); // Do something. ConversationProfile response = future.get(); }
-
deleteConversationProfile
public final void deleteConversationProfile(ConversationProfileName name)
Deletes the specified conversation profile.Sample code:
// This snippet has been automatically generated and should be regarded as a code template only. // It will require modifications to work: // - It may require correct/in-range values for request initialization. // - It may require specifying regional endpoints when creating the service client as shown in // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library try (ConversationProfilesClient conversationProfilesClient = ConversationProfilesClient.create()) { ConversationProfileName name = ConversationProfileName.ofProjectConversationProfileName( "[PROJECT]", "[CONVERSATION_PROFILE]"); conversationProfilesClient.deleteConversationProfile(name); }
- Parameters:
name
- Required. The name of the conversation profile to delete. Format: `projects/<Project ID>/locations/<Location ID>/conversationProfiles/<Conversation Profile ID>`.- Throws:
com.google.api.gax.rpc.ApiException
- if the remote call fails
-
deleteConversationProfile
public final void deleteConversationProfile(String name)
Deletes the specified conversation profile.Sample code:
// This snippet has been automatically generated and should be regarded as a code template only. // It will require modifications to work: // - It may require correct/in-range values for request initialization. // - It may require specifying regional endpoints when creating the service client as shown in // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library try (ConversationProfilesClient conversationProfilesClient = ConversationProfilesClient.create()) { String name = ConversationProfileName.ofProjectConversationProfileName( "[PROJECT]", "[CONVERSATION_PROFILE]") .toString(); conversationProfilesClient.deleteConversationProfile(name); }
- Parameters:
name
- Required. The name of the conversation profile to delete. Format: `projects/<Project ID>/locations/<Location ID>/conversationProfiles/<Conversation Profile ID>`.- Throws:
com.google.api.gax.rpc.ApiException
- if the remote call fails
-
deleteConversationProfile
public final void deleteConversationProfile(DeleteConversationProfileRequest request)
Deletes the specified conversation profile.Sample code:
// This snippet has been automatically generated and should be regarded as a code template only. // It will require modifications to work: // - It may require correct/in-range values for request initialization. // - It may require specifying regional endpoints when creating the service client as shown in // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library try (ConversationProfilesClient conversationProfilesClient = ConversationProfilesClient.create()) { DeleteConversationProfileRequest request = DeleteConversationProfileRequest.newBuilder() .setName( ConversationProfileName.ofProjectConversationProfileName( "[PROJECT]", "[CONVERSATION_PROFILE]") .toString()) .build(); conversationProfilesClient.deleteConversationProfile(request); }
- Parameters:
request
- The request object containing all of the parameters for the API call.- Throws:
com.google.api.gax.rpc.ApiException
- if the remote call fails
-
deleteConversationProfileCallable
public final com.google.api.gax.rpc.UnaryCallable<DeleteConversationProfileRequest,com.google.protobuf.Empty> deleteConversationProfileCallable()
Deletes the specified conversation profile.Sample code:
// This snippet has been automatically generated and should be regarded as a code template only. // It will require modifications to work: // - It may require correct/in-range values for request initialization. // - It may require specifying regional endpoints when creating the service client as shown in // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library try (ConversationProfilesClient conversationProfilesClient = ConversationProfilesClient.create()) { DeleteConversationProfileRequest request = DeleteConversationProfileRequest.newBuilder() .setName( ConversationProfileName.ofProjectConversationProfileName( "[PROJECT]", "[CONVERSATION_PROFILE]") .toString()) .build(); ApiFuture<Empty> future = conversationProfilesClient.deleteConversationProfileCallable().futureCall(request); // Do something. future.get(); }
-
setSuggestionFeatureConfigAsync
public final com.google.api.gax.longrunning.OperationFuture<ConversationProfile,SetSuggestionFeatureConfigOperationMetadata> setSuggestionFeatureConfigAsync(String conversationProfile)
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](https://cloud.google.com/dialogflow/es/docs/how/long-running-operations). 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.
Sample code:
// This snippet has been automatically generated and should be regarded as a code template only. // It will require modifications to work: // - It may require correct/in-range values for request initialization. // - It may require specifying regional endpoints when creating the service client as shown in // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library try (ConversationProfilesClient conversationProfilesClient = ConversationProfilesClient.create()) { String conversationProfile = "conversationProfile1691597734"; ConversationProfile response = conversationProfilesClient.setSuggestionFeatureConfigAsync(conversationProfile).get(); }
- Parameters:
conversationProfile
- Required. The Conversation Profile to add or update the suggestion feature config. Format: `projects/<Project ID>/locations/<Location ID>/conversationProfiles/<Conversation Profile ID>`.- Throws:
com.google.api.gax.rpc.ApiException
- if the remote call fails
-
setSuggestionFeatureConfigAsync
public final com.google.api.gax.longrunning.OperationFuture<ConversationProfile,SetSuggestionFeatureConfigOperationMetadata> setSuggestionFeatureConfigAsync(String conversationProfile, Participant.Role participantRole, HumanAgentAssistantConfig.SuggestionFeatureConfig suggestionFeatureConfig)
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](https://cloud.google.com/dialogflow/es/docs/how/long-running-operations). 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.
Sample code:
// This snippet has been automatically generated and should be regarded as a code template only. // It will require modifications to work: // - It may require correct/in-range values for request initialization. // - It may require specifying regional endpoints when creating the service client as shown in // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library try (ConversationProfilesClient conversationProfilesClient = ConversationProfilesClient.create()) { String conversationProfile = "conversationProfile1691597734"; Participant.Role participantRole = Participant.Role.forNumber(0); HumanAgentAssistantConfig.SuggestionFeatureConfig suggestionFeatureConfig = HumanAgentAssistantConfig.SuggestionFeatureConfig.newBuilder().build(); ConversationProfile response = conversationProfilesClient .setSuggestionFeatureConfigAsync( conversationProfile, participantRole, suggestionFeatureConfig) .get(); }
- Parameters:
conversationProfile
- Required. The Conversation Profile to add or update the suggestion feature config. Format: `projects/<Project ID>/locations/<Location ID>/conversationProfiles/<Conversation Profile ID>`.participantRole
- Required. The participant role to add or update the suggestion feature config. Only HUMAN_AGENT or END_USER can be used.suggestionFeatureConfig
- Required. The suggestion feature config to add or update.- Throws:
com.google.api.gax.rpc.ApiException
- if the remote call fails
-
setSuggestionFeatureConfigAsync
public final com.google.api.gax.longrunning.OperationFuture<ConversationProfile,SetSuggestionFeatureConfigOperationMetadata> setSuggestionFeatureConfigAsync(SetSuggestionFeatureConfigRequest request)
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](https://cloud.google.com/dialogflow/es/docs/how/long-running-operations). 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.
Sample code:
// This snippet has been automatically generated and should be regarded as a code template only. // It will require modifications to work: // - It may require correct/in-range values for request initialization. // - It may require specifying regional endpoints when creating the service client as shown in // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library try (ConversationProfilesClient conversationProfilesClient = ConversationProfilesClient.create()) { SetSuggestionFeatureConfigRequest request = SetSuggestionFeatureConfigRequest.newBuilder() .setConversationProfile("conversationProfile1691597734") .setSuggestionFeatureConfig( HumanAgentAssistantConfig.SuggestionFeatureConfig.newBuilder().build()) .build(); ConversationProfile response = conversationProfilesClient.setSuggestionFeatureConfigAsync(request).get(); }
- Parameters:
request
- The request object containing all of the parameters for the API call.- Throws:
com.google.api.gax.rpc.ApiException
- if the remote call fails
-
setSuggestionFeatureConfigOperationCallable
public final com.google.api.gax.rpc.OperationCallable<SetSuggestionFeatureConfigRequest,ConversationProfile,SetSuggestionFeatureConfigOperationMetadata> setSuggestionFeatureConfigOperationCallable()
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](https://cloud.google.com/dialogflow/es/docs/how/long-running-operations). 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.
Sample code:
// This snippet has been automatically generated and should be regarded as a code template only. // It will require modifications to work: // - It may require correct/in-range values for request initialization. // - It may require specifying regional endpoints when creating the service client as shown in // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library try (ConversationProfilesClient conversationProfilesClient = ConversationProfilesClient.create()) { SetSuggestionFeatureConfigRequest request = SetSuggestionFeatureConfigRequest.newBuilder() .setConversationProfile("conversationProfile1691597734") .setSuggestionFeatureConfig( HumanAgentAssistantConfig.SuggestionFeatureConfig.newBuilder().build()) .build(); OperationFuture<ConversationProfile, SetSuggestionFeatureConfigOperationMetadata> future = conversationProfilesClient .setSuggestionFeatureConfigOperationCallable() .futureCall(request); // Do something. ConversationProfile response = future.get(); }
-
setSuggestionFeatureConfigCallable
public final com.google.api.gax.rpc.UnaryCallable<SetSuggestionFeatureConfigRequest,com.google.longrunning.Operation> setSuggestionFeatureConfigCallable()
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](https://cloud.google.com/dialogflow/es/docs/how/long-running-operations). 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.
Sample code:
// This snippet has been automatically generated and should be regarded as a code template only. // It will require modifications to work: // - It may require correct/in-range values for request initialization. // - It may require specifying regional endpoints when creating the service client as shown in // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library try (ConversationProfilesClient conversationProfilesClient = ConversationProfilesClient.create()) { SetSuggestionFeatureConfigRequest request = SetSuggestionFeatureConfigRequest.newBuilder() .setConversationProfile("conversationProfile1691597734") .setSuggestionFeatureConfig( HumanAgentAssistantConfig.SuggestionFeatureConfig.newBuilder().build()) .build(); ApiFuture<Operation> future = conversationProfilesClient.setSuggestionFeatureConfigCallable().futureCall(request); // Do something. Operation response = future.get(); }
-
clearSuggestionFeatureConfigAsync
public final com.google.api.gax.longrunning.OperationFuture<ConversationProfile,ClearSuggestionFeatureConfigOperationMetadata> clearSuggestionFeatureConfigAsync(String conversationProfile)
Clears a suggestion feature from a conversation profile for the given participant role.This method is a [long-running operation](https://cloud.google.com/dialogflow/es/docs/how/long-running-operations). The returned `Operation` type has the following method-specific fields:
- `metadata`: [ClearSuggestionFeatureConfigOperationMetadata][google.cloud.dialogflow.v2.ClearSuggestionFeatureConfigOperationMetadata] - `response`: [ConversationProfile][google.cloud.dialogflow.v2.ConversationProfile]
Sample code:
// This snippet has been automatically generated and should be regarded as a code template only. // It will require modifications to work: // - It may require correct/in-range values for request initialization. // - It may require specifying regional endpoints when creating the service client as shown in // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library try (ConversationProfilesClient conversationProfilesClient = ConversationProfilesClient.create()) { String conversationProfile = "conversationProfile1691597734"; ConversationProfile response = conversationProfilesClient.clearSuggestionFeatureConfigAsync(conversationProfile).get(); }
- Parameters:
conversationProfile
- Required. The Conversation Profile to add or update the suggestion feature config. Format: `projects/<Project ID>/locations/<Location ID>/conversationProfiles/<Conversation Profile ID>`.- Throws:
com.google.api.gax.rpc.ApiException
- if the remote call fails
-
clearSuggestionFeatureConfigAsync
public final com.google.api.gax.longrunning.OperationFuture<ConversationProfile,ClearSuggestionFeatureConfigOperationMetadata> clearSuggestionFeatureConfigAsync(String conversationProfile, Participant.Role participantRole, SuggestionFeature.Type suggestionFeatureType)
Clears a suggestion feature from a conversation profile for the given participant role.This method is a [long-running operation](https://cloud.google.com/dialogflow/es/docs/how/long-running-operations). The returned `Operation` type has the following method-specific fields:
- `metadata`: [ClearSuggestionFeatureConfigOperationMetadata][google.cloud.dialogflow.v2.ClearSuggestionFeatureConfigOperationMetadata] - `response`: [ConversationProfile][google.cloud.dialogflow.v2.ConversationProfile]
Sample code:
// This snippet has been automatically generated and should be regarded as a code template only. // It will require modifications to work: // - It may require correct/in-range values for request initialization. // - It may require specifying regional endpoints when creating the service client as shown in // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library try (ConversationProfilesClient conversationProfilesClient = ConversationProfilesClient.create()) { String conversationProfile = "conversationProfile1691597734"; Participant.Role participantRole = Participant.Role.forNumber(0); SuggestionFeature.Type suggestionFeatureType = SuggestionFeature.Type.forNumber(0); ConversationProfile response = conversationProfilesClient .clearSuggestionFeatureConfigAsync( conversationProfile, participantRole, suggestionFeatureType) .get(); }
- Parameters:
conversationProfile
- Required. The Conversation Profile to add or update the suggestion feature config. Format: `projects/<Project ID>/locations/<Location ID>/conversationProfiles/<Conversation Profile ID>`.participantRole
- Required. The participant role to remove the suggestion feature config. Only HUMAN_AGENT or END_USER can be used.suggestionFeatureType
- Required. The type of the suggestion feature to remove.- Throws:
com.google.api.gax.rpc.ApiException
- if the remote call fails
-
clearSuggestionFeatureConfigAsync
public final com.google.api.gax.longrunning.OperationFuture<ConversationProfile,ClearSuggestionFeatureConfigOperationMetadata> clearSuggestionFeatureConfigAsync(ClearSuggestionFeatureConfigRequest request)
Clears a suggestion feature from a conversation profile for the given participant role.This method is a [long-running operation](https://cloud.google.com/dialogflow/es/docs/how/long-running-operations). The returned `Operation` type has the following method-specific fields:
- `metadata`: [ClearSuggestionFeatureConfigOperationMetadata][google.cloud.dialogflow.v2.ClearSuggestionFeatureConfigOperationMetadata] - `response`: [ConversationProfile][google.cloud.dialogflow.v2.ConversationProfile]
Sample code:
// This snippet has been automatically generated and should be regarded as a code template only. // It will require modifications to work: // - It may require correct/in-range values for request initialization. // - It may require specifying regional endpoints when creating the service client as shown in // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library try (ConversationProfilesClient conversationProfilesClient = ConversationProfilesClient.create()) { ClearSuggestionFeatureConfigRequest request = ClearSuggestionFeatureConfigRequest.newBuilder() .setConversationProfile("conversationProfile1691597734") .build(); ConversationProfile response = conversationProfilesClient.clearSuggestionFeatureConfigAsync(request).get(); }
- Parameters:
request
- The request object containing all of the parameters for the API call.- Throws:
com.google.api.gax.rpc.ApiException
- if the remote call fails
-
clearSuggestionFeatureConfigOperationCallable
public final com.google.api.gax.rpc.OperationCallable<ClearSuggestionFeatureConfigRequest,ConversationProfile,ClearSuggestionFeatureConfigOperationMetadata> clearSuggestionFeatureConfigOperationCallable()
Clears a suggestion feature from a conversation profile for the given participant role.This method is a [long-running operation](https://cloud.google.com/dialogflow/es/docs/how/long-running-operations). The returned `Operation` type has the following method-specific fields:
- `metadata`: [ClearSuggestionFeatureConfigOperationMetadata][google.cloud.dialogflow.v2.ClearSuggestionFeatureConfigOperationMetadata] - `response`: [ConversationProfile][google.cloud.dialogflow.v2.ConversationProfile]
Sample code:
// This snippet has been automatically generated and should be regarded as a code template only. // It will require modifications to work: // - It may require correct/in-range values for request initialization. // - It may require specifying regional endpoints when creating the service client as shown in // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library try (ConversationProfilesClient conversationProfilesClient = ConversationProfilesClient.create()) { ClearSuggestionFeatureConfigRequest request = ClearSuggestionFeatureConfigRequest.newBuilder() .setConversationProfile("conversationProfile1691597734") .build(); OperationFuture<ConversationProfile, ClearSuggestionFeatureConfigOperationMetadata> future = conversationProfilesClient .clearSuggestionFeatureConfigOperationCallable() .futureCall(request); // Do something. ConversationProfile response = future.get(); }
-
clearSuggestionFeatureConfigCallable
public final com.google.api.gax.rpc.UnaryCallable<ClearSuggestionFeatureConfigRequest,com.google.longrunning.Operation> clearSuggestionFeatureConfigCallable()
Clears a suggestion feature from a conversation profile for the given participant role.This method is a [long-running operation](https://cloud.google.com/dialogflow/es/docs/how/long-running-operations). The returned `Operation` type has the following method-specific fields:
- `metadata`: [ClearSuggestionFeatureConfigOperationMetadata][google.cloud.dialogflow.v2.ClearSuggestionFeatureConfigOperationMetadata] - `response`: [ConversationProfile][google.cloud.dialogflow.v2.ConversationProfile]
Sample code:
// This snippet has been automatically generated and should be regarded as a code template only. // It will require modifications to work: // - It may require correct/in-range values for request initialization. // - It may require specifying regional endpoints when creating the service client as shown in // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library try (ConversationProfilesClient conversationProfilesClient = ConversationProfilesClient.create()) { ClearSuggestionFeatureConfigRequest request = ClearSuggestionFeatureConfigRequest.newBuilder() .setConversationProfile("conversationProfile1691597734") .build(); ApiFuture<Operation> future = conversationProfilesClient.clearSuggestionFeatureConfigCallable().futureCall(request); // Do something. Operation response = future.get(); }
-
listLocations
public final ConversationProfilesClient.ListLocationsPagedResponse listLocations(com.google.cloud.location.ListLocationsRequest request)
Lists information about the supported locations for this service.Sample code:
// This snippet has been automatically generated and should be regarded as a code template only. // It will require modifications to work: // - It may require correct/in-range values for request initialization. // - It may require specifying regional endpoints when creating the service client as shown in // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library try (ConversationProfilesClient conversationProfilesClient = ConversationProfilesClient.create()) { ListLocationsRequest request = ListLocationsRequest.newBuilder() .setName("name3373707") .setFilter("filter-1274492040") .setPageSize(883849137) .setPageToken("pageToken873572522") .build(); for (Location element : conversationProfilesClient.listLocations(request).iterateAll()) { // doThingsWith(element); } }
- Parameters:
request
- The request object containing all of the parameters for the API call.- Throws:
com.google.api.gax.rpc.ApiException
- if the remote call fails
-
listLocationsPagedCallable
public final com.google.api.gax.rpc.UnaryCallable<com.google.cloud.location.ListLocationsRequest,ConversationProfilesClient.ListLocationsPagedResponse> listLocationsPagedCallable()
Lists information about the supported locations for this service.Sample code:
// This snippet has been automatically generated and should be regarded as a code template only. // It will require modifications to work: // - It may require correct/in-range values for request initialization. // - It may require specifying regional endpoints when creating the service client as shown in // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library try (ConversationProfilesClient conversationProfilesClient = ConversationProfilesClient.create()) { ListLocationsRequest request = ListLocationsRequest.newBuilder() .setName("name3373707") .setFilter("filter-1274492040") .setPageSize(883849137) .setPageToken("pageToken873572522") .build(); ApiFuture<Location> future = conversationProfilesClient.listLocationsPagedCallable().futureCall(request); // Do something. for (Location element : future.get().iterateAll()) { // doThingsWith(element); } }
-
listLocationsCallable
public final com.google.api.gax.rpc.UnaryCallable<com.google.cloud.location.ListLocationsRequest,com.google.cloud.location.ListLocationsResponse> listLocationsCallable()
Lists information about the supported locations for this service.Sample code:
// This snippet has been automatically generated and should be regarded as a code template only. // It will require modifications to work: // - It may require correct/in-range values for request initialization. // - It may require specifying regional endpoints when creating the service client as shown in // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library try (ConversationProfilesClient conversationProfilesClient = ConversationProfilesClient.create()) { ListLocationsRequest request = ListLocationsRequest.newBuilder() .setName("name3373707") .setFilter("filter-1274492040") .setPageSize(883849137) .setPageToken("pageToken873572522") .build(); while (true) { ListLocationsResponse response = conversationProfilesClient.listLocationsCallable().call(request); for (Location element : response.getLocationsList()) { // doThingsWith(element); } String nextPageToken = response.getNextPageToken(); if (!Strings.isNullOrEmpty(nextPageToken)) { request = request.toBuilder().setPageToken(nextPageToken).build(); } else { break; } } }
-
getLocation
public final com.google.cloud.location.Location getLocation(com.google.cloud.location.GetLocationRequest request)
Gets information about a location.Sample code:
// This snippet has been automatically generated and should be regarded as a code template only. // It will require modifications to work: // - It may require correct/in-range values for request initialization. // - It may require specifying regional endpoints when creating the service client as shown in // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library try (ConversationProfilesClient conversationProfilesClient = ConversationProfilesClient.create()) { GetLocationRequest request = GetLocationRequest.newBuilder().setName("name3373707").build(); Location response = conversationProfilesClient.getLocation(request); }
- Parameters:
request
- The request object containing all of the parameters for the API call.- Throws:
com.google.api.gax.rpc.ApiException
- if the remote call fails
-
getLocationCallable
public final com.google.api.gax.rpc.UnaryCallable<com.google.cloud.location.GetLocationRequest,com.google.cloud.location.Location> getLocationCallable()
Gets information about a location.Sample code:
// This snippet has been automatically generated and should be regarded as a code template only. // It will require modifications to work: // - It may require correct/in-range values for request initialization. // - It may require specifying regional endpoints when creating the service client as shown in // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library try (ConversationProfilesClient conversationProfilesClient = ConversationProfilesClient.create()) { GetLocationRequest request = GetLocationRequest.newBuilder().setName("name3373707").build(); ApiFuture<Location> future = conversationProfilesClient.getLocationCallable().futureCall(request); // Do something. Location response = future.get(); }
-
close
public final void close()
- Specified by:
close
in interfaceAutoCloseable
-
shutdown
public void shutdown()
- Specified by:
shutdown
in interfacecom.google.api.gax.core.BackgroundResource
-
isShutdown
public boolean isShutdown()
- Specified by:
isShutdown
in interfacecom.google.api.gax.core.BackgroundResource
-
isTerminated
public boolean isTerminated()
- Specified by:
isTerminated
in interfacecom.google.api.gax.core.BackgroundResource
-
shutdownNow
public void shutdownNow()
- Specified by:
shutdownNow
in interfacecom.google.api.gax.core.BackgroundResource
-
awaitTermination
public boolean awaitTermination(long duration, TimeUnit unit) throws InterruptedException
- Specified by:
awaitTermination
in interfacecom.google.api.gax.core.BackgroundResource
- Throws:
InterruptedException
-
-