Class ContactCenterInsightsClient (2.44.0)

GitHub RepositoryProduct Reference

Service Description: An API that lets users analyze and explore their business conversation data.

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 (ContactCenterInsightsClient contactCenterInsightsClient =
     ContactCenterInsightsClient.create()) {
   LocationName parent = LocationName.of("[PROJECT]", "[LOCATION]");
   Conversation conversation = Conversation.newBuilder().build();
   String conversationId = "conversationId-1676095234";
   Conversation response =
       contactCenterInsightsClient.createConversation(parent, conversation, conversationId);
 }

Note: close() needs to be called on the ContactCenterInsightsClient object to clean up resources such as threads. In the example above, try-with-resources is used, which automatically calls close().

Methods
Method Description Method Variants

CreateConversation

Creates a conversation.

Request object method variants only take one parameter, a request object, which must be constructed before the call.

  • createConversation(CreateConversationRequest request)

"Flattened" method variants have converted the fields of the request object into function parameters to enable multiple ways to call the same method.

  • createConversation(LocationName parent, Conversation conversation, String conversationId)

  • createConversation(String parent, Conversation conversation, String conversationId)

Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service.

  • createConversationCallable()

UploadConversation

Create a longrunning conversation upload operation. This method differs from CreateConversation by allowing audio transcription and optional DLP redaction.

Request object method variants only take one parameter, a request object, which must be constructed before the call.

  • uploadConversationAsync(UploadConversationRequest request)

Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service.

  • uploadConversationOperationCallable()

  • uploadConversationCallable()

UpdateConversation

Updates a conversation.

Request object method variants only take one parameter, a request object, which must be constructed before the call.

  • updateConversation(UpdateConversationRequest request)

"Flattened" method variants have converted the fields of the request object into function parameters to enable multiple ways to call the same method.

  • updateConversation(Conversation conversation, FieldMask updateMask)

Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service.

  • updateConversationCallable()

GetConversation

Gets a conversation.

Request object method variants only take one parameter, a request object, which must be constructed before the call.

  • getConversation(GetConversationRequest request)

"Flattened" method variants have converted the fields of the request object into function parameters to enable multiple ways to call the same method.

  • getConversation(ConversationName name)

  • getConversation(String name)

Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service.

  • getConversationCallable()

ListConversations

Lists conversations.

Request object method variants only take one parameter, a request object, which must be constructed before the call.

  • listConversations(ListConversationsRequest request)

"Flattened" method variants have converted the fields of the request object into function parameters to enable multiple ways to call the same method.

  • listConversations(LocationName parent)

  • listConversations(String parent)

Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service.

  • listConversationsPagedCallable()

  • listConversationsCallable()

DeleteConversation

Deletes a conversation.

Request object method variants only take one parameter, a request object, which must be constructed before the call.

  • deleteConversation(DeleteConversationRequest request)

"Flattened" method variants have converted the fields of the request object into function parameters to enable multiple ways to call the same method.

  • deleteConversation(ConversationName name)

  • deleteConversation(String name)

Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service.

  • deleteConversationCallable()

CreateAnalysis

Creates an analysis. The long running operation is done when the analysis has completed.

Request object method variants only take one parameter, a request object, which must be constructed before the call.

  • createAnalysisAsync(CreateAnalysisRequest request)

Methods that return long-running operations have "Async" method variants that return OperationFuture, which is used to track polling of the service.

  • createAnalysisAsync(ConversationName parent, Analysis analysis)

  • createAnalysisAsync(String parent, Analysis analysis)

Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service.

  • createAnalysisOperationCallable()

  • createAnalysisCallable()

GetAnalysis

Gets an analysis.

Request object method variants only take one parameter, a request object, which must be constructed before the call.

  • getAnalysis(GetAnalysisRequest request)

"Flattened" method variants have converted the fields of the request object into function parameters to enable multiple ways to call the same method.

  • getAnalysis(AnalysisName name)

  • getAnalysis(String name)

Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service.

  • getAnalysisCallable()

ListAnalyses

Lists analyses.

Request object method variants only take one parameter, a request object, which must be constructed before the call.

  • listAnalyses(ListAnalysesRequest request)

"Flattened" method variants have converted the fields of the request object into function parameters to enable multiple ways to call the same method.

  • listAnalyses(ConversationName parent)

  • listAnalyses(String parent)

Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service.

  • listAnalysesPagedCallable()

  • listAnalysesCallable()

DeleteAnalysis

Deletes an analysis.

Request object method variants only take one parameter, a request object, which must be constructed before the call.

  • deleteAnalysis(DeleteAnalysisRequest request)

"Flattened" method variants have converted the fields of the request object into function parameters to enable multiple ways to call the same method.

  • deleteAnalysis(AnalysisName name)

  • deleteAnalysis(String name)

Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service.

  • deleteAnalysisCallable()

BulkAnalyzeConversations

Analyzes multiple conversations in a single request.

Request object method variants only take one parameter, a request object, which must be constructed before the call.

  • bulkAnalyzeConversationsAsync(BulkAnalyzeConversationsRequest request)

Methods that return long-running operations have "Async" method variants that return OperationFuture, which is used to track polling of the service.

  • bulkAnalyzeConversationsAsync(LocationName parent, String filter, float analysisPercentage)

  • bulkAnalyzeConversationsAsync(String parent, String filter, float analysisPercentage)

Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service.

  • bulkAnalyzeConversationsOperationCallable()

  • bulkAnalyzeConversationsCallable()

BulkDeleteConversations

Deletes multiple conversations in a single request.

Request object method variants only take one parameter, a request object, which must be constructed before the call.

  • bulkDeleteConversationsAsync(BulkDeleteConversationsRequest request)

Methods that return long-running operations have "Async" method variants that return OperationFuture, which is used to track polling of the service.

  • bulkDeleteConversationsAsync(LocationName parent, String filter)

  • bulkDeleteConversationsAsync(String parent, String filter)

Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service.

  • bulkDeleteConversationsOperationCallable()

  • bulkDeleteConversationsCallable()

IngestConversations

Imports conversations and processes them according to the user's configuration.

Request object method variants only take one parameter, a request object, which must be constructed before the call.

  • ingestConversationsAsync(IngestConversationsRequest request)

Methods that return long-running operations have "Async" method variants that return OperationFuture, which is used to track polling of the service.

  • ingestConversationsAsync(LocationName parent)

  • ingestConversationsAsync(String parent)

Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service.

  • ingestConversationsOperationCallable()

  • ingestConversationsCallable()

ExportInsightsData

Export insights data to a destination defined in the request body.

Request object method variants only take one parameter, a request object, which must be constructed before the call.

  • exportInsightsDataAsync(ExportInsightsDataRequest request)

Methods that return long-running operations have "Async" method variants that return OperationFuture, which is used to track polling of the service.

  • exportInsightsDataAsync(LocationName parent)

  • exportInsightsDataAsync(String parent)

Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service.

  • exportInsightsDataOperationCallable()

  • exportInsightsDataCallable()

CreateIssueModel

Creates an issue model.

Request object method variants only take one parameter, a request object, which must be constructed before the call.

  • createIssueModelAsync(CreateIssueModelRequest request)

Methods that return long-running operations have "Async" method variants that return OperationFuture, which is used to track polling of the service.

  • createIssueModelAsync(LocationName parent, IssueModel issueModel)

  • createIssueModelAsync(String parent, IssueModel issueModel)

Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service.

  • createIssueModelOperationCallable()

  • createIssueModelCallable()

UpdateIssueModel

Updates an issue model.

Request object method variants only take one parameter, a request object, which must be constructed before the call.

  • updateIssueModel(UpdateIssueModelRequest request)

"Flattened" method variants have converted the fields of the request object into function parameters to enable multiple ways to call the same method.

  • updateIssueModel(IssueModel issueModel, FieldMask updateMask)

Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service.

  • updateIssueModelCallable()

GetIssueModel

Gets an issue model.

Request object method variants only take one parameter, a request object, which must be constructed before the call.

  • getIssueModel(GetIssueModelRequest request)

"Flattened" method variants have converted the fields of the request object into function parameters to enable multiple ways to call the same method.

  • getIssueModel(IssueModelName name)

  • getIssueModel(String name)

Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service.

  • getIssueModelCallable()

ListIssueModels

Lists issue models.

Request object method variants only take one parameter, a request object, which must be constructed before the call.

  • listIssueModels(ListIssueModelsRequest request)

"Flattened" method variants have converted the fields of the request object into function parameters to enable multiple ways to call the same method.

  • listIssueModels(LocationName parent)

  • listIssueModels(String parent)

Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service.

  • listIssueModelsCallable()

DeleteIssueModel

Deletes an issue model.

Request object method variants only take one parameter, a request object, which must be constructed before the call.

  • deleteIssueModelAsync(DeleteIssueModelRequest request)

Methods that return long-running operations have "Async" method variants that return OperationFuture, which is used to track polling of the service.

  • deleteIssueModelAsync(IssueModelName name)

  • deleteIssueModelAsync(String name)

Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service.

  • deleteIssueModelOperationCallable()

  • deleteIssueModelCallable()

DeployIssueModel

Deploys an issue model. Returns an error if a model is already deployed. An issue model can only be used in analysis after it has been deployed.

Request object method variants only take one parameter, a request object, which must be constructed before the call.

  • deployIssueModelAsync(DeployIssueModelRequest request)

Methods that return long-running operations have "Async" method variants that return OperationFuture, which is used to track polling of the service.

  • deployIssueModelAsync(IssueModelName name)

  • deployIssueModelAsync(String name)

Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service.

  • deployIssueModelOperationCallable()

  • deployIssueModelCallable()

UndeployIssueModel

Undeploys an issue model. An issue model can not be used in analysis after it has been undeployed.

Request object method variants only take one parameter, a request object, which must be constructed before the call.

  • undeployIssueModelAsync(UndeployIssueModelRequest request)

Methods that return long-running operations have "Async" method variants that return OperationFuture, which is used to track polling of the service.

  • undeployIssueModelAsync(IssueModelName name)

  • undeployIssueModelAsync(String name)

Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service.

  • undeployIssueModelOperationCallable()

  • undeployIssueModelCallable()

GetIssue

Gets an issue.

Request object method variants only take one parameter, a request object, which must be constructed before the call.

  • getIssue(GetIssueRequest request)

"Flattened" method variants have converted the fields of the request object into function parameters to enable multiple ways to call the same method.

  • getIssue(IssueName name)

  • getIssue(String name)

Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service.

  • getIssueCallable()

ListIssues

Lists issues.

Request object method variants only take one parameter, a request object, which must be constructed before the call.

  • listIssues(ListIssuesRequest request)

"Flattened" method variants have converted the fields of the request object into function parameters to enable multiple ways to call the same method.

  • listIssues(IssueModelName parent)

  • listIssues(String parent)

Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service.

  • listIssuesCallable()

UpdateIssue

Updates an issue.

Request object method variants only take one parameter, a request object, which must be constructed before the call.

  • updateIssue(UpdateIssueRequest request)

"Flattened" method variants have converted the fields of the request object into function parameters to enable multiple ways to call the same method.

  • updateIssue(Issue issue, FieldMask updateMask)

Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service.

  • updateIssueCallable()

DeleteIssue

Deletes an issue.

Request object method variants only take one parameter, a request object, which must be constructed before the call.

  • deleteIssue(DeleteIssueRequest request)

"Flattened" method variants have converted the fields of the request object into function parameters to enable multiple ways to call the same method.

  • deleteIssue(IssueName name)

  • deleteIssue(String name)

Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service.

  • deleteIssueCallable()

CalculateIssueModelStats

Gets an issue model's statistics.

Request object method variants only take one parameter, a request object, which must be constructed before the call.

  • calculateIssueModelStats(CalculateIssueModelStatsRequest request)

"Flattened" method variants have converted the fields of the request object into function parameters to enable multiple ways to call the same method.

  • calculateIssueModelStats(IssueModelName issueModel)

  • calculateIssueModelStats(String issueModel)

Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service.

  • calculateIssueModelStatsCallable()

CreatePhraseMatcher

Creates a phrase matcher.

Request object method variants only take one parameter, a request object, which must be constructed before the call.

  • createPhraseMatcher(CreatePhraseMatcherRequest request)

"Flattened" method variants have converted the fields of the request object into function parameters to enable multiple ways to call the same method.

  • createPhraseMatcher(LocationName parent, PhraseMatcher phraseMatcher)

  • createPhraseMatcher(String parent, PhraseMatcher phraseMatcher)

Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service.

  • createPhraseMatcherCallable()

GetPhraseMatcher

Gets a phrase matcher.

Request object method variants only take one parameter, a request object, which must be constructed before the call.

  • getPhraseMatcher(GetPhraseMatcherRequest request)

"Flattened" method variants have converted the fields of the request object into function parameters to enable multiple ways to call the same method.

  • getPhraseMatcher(PhraseMatcherName name)

  • getPhraseMatcher(String name)

Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service.

  • getPhraseMatcherCallable()

ListPhraseMatchers

Lists phrase matchers.

Request object method variants only take one parameter, a request object, which must be constructed before the call.

  • listPhraseMatchers(ListPhraseMatchersRequest request)

"Flattened" method variants have converted the fields of the request object into function parameters to enable multiple ways to call the same method.

  • listPhraseMatchers(LocationName parent)

  • listPhraseMatchers(String parent)

Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service.

  • listPhraseMatchersPagedCallable()

  • listPhraseMatchersCallable()

DeletePhraseMatcher

Deletes a phrase matcher.

Request object method variants only take one parameter, a request object, which must be constructed before the call.

  • deletePhraseMatcher(DeletePhraseMatcherRequest request)

"Flattened" method variants have converted the fields of the request object into function parameters to enable multiple ways to call the same method.

  • deletePhraseMatcher(PhraseMatcherName name)

  • deletePhraseMatcher(String name)

Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service.

  • deletePhraseMatcherCallable()

UpdatePhraseMatcher

Updates a phrase matcher.

Request object method variants only take one parameter, a request object, which must be constructed before the call.

  • updatePhraseMatcher(UpdatePhraseMatcherRequest request)

"Flattened" method variants have converted the fields of the request object into function parameters to enable multiple ways to call the same method.

  • updatePhraseMatcher(PhraseMatcher phraseMatcher, FieldMask updateMask)

Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service.

  • updatePhraseMatcherCallable()

CalculateStats

Gets conversation statistics.

Request object method variants only take one parameter, a request object, which must be constructed before the call.

  • calculateStats(CalculateStatsRequest request)

"Flattened" method variants have converted the fields of the request object into function parameters to enable multiple ways to call the same method.

  • calculateStats(LocationName location)

  • calculateStats(String location)

Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service.

  • calculateStatsCallable()

GetSettings

Gets project-level settings.

Request object method variants only take one parameter, a request object, which must be constructed before the call.

  • getSettings(GetSettingsRequest request)

"Flattened" method variants have converted the fields of the request object into function parameters to enable multiple ways to call the same method.

  • getSettings(SettingsName name)

  • getSettings(String name)

Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service.

  • getSettingsCallable()

UpdateSettings

Updates project-level settings.

Request object method variants only take one parameter, a request object, which must be constructed before the call.

  • updateSettings(UpdateSettingsRequest request)

"Flattened" method variants have converted the fields of the request object into function parameters to enable multiple ways to call the same method.

  • updateSettings(Settings settings, FieldMask updateMask)

Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service.

  • updateSettingsCallable()

CreateView

Creates a view.

Request object method variants only take one parameter, a request object, which must be constructed before the call.

  • createView(CreateViewRequest request)

"Flattened" method variants have converted the fields of the request object into function parameters to enable multiple ways to call the same method.

  • createView(LocationName parent, View view)

  • createView(String parent, View view)

Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service.

  • createViewCallable()

GetView

Gets a view.

Request object method variants only take one parameter, a request object, which must be constructed before the call.

  • getView(GetViewRequest request)

"Flattened" method variants have converted the fields of the request object into function parameters to enable multiple ways to call the same method.

  • getView(ViewName name)

  • getView(String name)

Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service.

  • getViewCallable()

ListViews

Lists views.

Request object method variants only take one parameter, a request object, which must be constructed before the call.

  • listViews(ListViewsRequest request)

"Flattened" method variants have converted the fields of the request object into function parameters to enable multiple ways to call the same method.

  • listViews(LocationName parent)

  • listViews(String parent)

Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service.

  • listViewsPagedCallable()

  • listViewsCallable()

UpdateView

Updates a view.

Request object method variants only take one parameter, a request object, which must be constructed before the call.

  • updateView(UpdateViewRequest request)

"Flattened" method variants have converted the fields of the request object into function parameters to enable multiple ways to call the same method.

  • updateView(View view, FieldMask updateMask)

Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service.

  • updateViewCallable()

DeleteView

Deletes a view.

Request object method variants only take one parameter, a request object, which must be constructed before the call.

  • deleteView(DeleteViewRequest request)

"Flattened" method variants have converted the fields of the request object into function parameters to enable multiple ways to call the same method.

  • deleteView(ViewName name)

  • deleteView(String name)

Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service.

  • deleteViewCallable()

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 ContactCenterInsightsSettings 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
 ContactCenterInsightsSettings contactCenterInsightsSettings =
     ContactCenterInsightsSettings.newBuilder()
         .setCredentialsProvider(FixedCredentialsProvider.create(myCredentials))
         .build();
 ContactCenterInsightsClient contactCenterInsightsClient =
     ContactCenterInsightsClient.create(contactCenterInsightsSettings);

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
 ContactCenterInsightsSettings contactCenterInsightsSettings =
     ContactCenterInsightsSettings.newBuilder().setEndpoint(myEndpoint).build();
 ContactCenterInsightsClient contactCenterInsightsClient =
     ContactCenterInsightsClient.create(contactCenterInsightsSettings);

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
 ContactCenterInsightsSettings contactCenterInsightsSettings =
     ContactCenterInsightsSettings.newHttpJsonBuilder().build();
 ContactCenterInsightsClient contactCenterInsightsClient =
     ContactCenterInsightsClient.create(contactCenterInsightsSettings);

Please refer to the GitHub repository's samples for more quickstart code snippets.

Inheritance

java.lang.Object > ContactCenterInsightsClient

Static Methods

create()

public static final ContactCenterInsightsClient create()

Constructs an instance of ContactCenterInsightsClient with default settings.

Returns
Type Description
ContactCenterInsightsClient
Exceptions
Type Description
IOException

create(ContactCenterInsightsSettings settings)

public static final ContactCenterInsightsClient create(ContactCenterInsightsSettings settings)

Constructs an instance of ContactCenterInsightsClient, using the given settings. The channels are created based on the settings passed in, or defaults for any settings that are not set.

Parameter
Name Description
settings ContactCenterInsightsSettings
Returns
Type Description
ContactCenterInsightsClient
Exceptions
Type Description
IOException

create(ContactCenterInsightsStub stub)

public static final ContactCenterInsightsClient create(ContactCenterInsightsStub stub)

Constructs an instance of ContactCenterInsightsClient, using the given stub for making calls. This is for advanced usage - prefer using create(ContactCenterInsightsSettings).

Parameter
Name Description
stub ContactCenterInsightsStub
Returns
Type Description
ContactCenterInsightsClient

Constructors

ContactCenterInsightsClient(ContactCenterInsightsSettings settings)

protected ContactCenterInsightsClient(ContactCenterInsightsSettings settings)

Constructs an instance of ContactCenterInsightsClient, 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.

Parameter
Name Description
settings ContactCenterInsightsSettings

ContactCenterInsightsClient(ContactCenterInsightsStub stub)

protected ContactCenterInsightsClient(ContactCenterInsightsStub stub)
Parameter
Name Description
stub ContactCenterInsightsStub

Methods

awaitTermination(long duration, TimeUnit unit)

public boolean awaitTermination(long duration, TimeUnit unit)
Parameters
Name Description
duration long
unit TimeUnit
Returns
Type Description
boolean
Exceptions
Type Description
InterruptedException

bulkAnalyzeConversationsAsync(BulkAnalyzeConversationsRequest request)

public final OperationFuture<BulkAnalyzeConversationsResponse,BulkAnalyzeConversationsMetadata> bulkAnalyzeConversationsAsync(BulkAnalyzeConversationsRequest request)

Analyzes multiple conversations in a single request.

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 (ContactCenterInsightsClient contactCenterInsightsClient =
     ContactCenterInsightsClient.create()) {
   BulkAnalyzeConversationsRequest request =
       BulkAnalyzeConversationsRequest.newBuilder()
           .setParent(LocationName.of("[PROJECT]", "[LOCATION]").toString())
           .setFilter("filter-1274492040")
           .setAnalysisPercentage(1609757661)
           .setAnnotatorSelector(AnnotatorSelector.newBuilder().build())
           .build();
   BulkAnalyzeConversationsResponse response =
       contactCenterInsightsClient.bulkAnalyzeConversationsAsync(request).get();
 }
Parameter
Name Description
request BulkAnalyzeConversationsRequest

The request object containing all of the parameters for the API call.
Returns
Type Description
OperationFuture<BulkAnalyzeConversationsResponse,BulkAnalyzeConversationsMetadata>

bulkAnalyzeConversationsAsync(LocationName parent, String filter, float analysisPercentage)

public final OperationFuture<BulkAnalyzeConversationsResponse,BulkAnalyzeConversationsMetadata> bulkAnalyzeConversationsAsync(LocationName parent, String filter, float analysisPercentage)

Analyzes multiple conversations in a single request.

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 (ContactCenterInsightsClient contactCenterInsightsClient =
     ContactCenterInsightsClient.create()) {
   LocationName parent = LocationName.of("[PROJECT]", "[LOCATION]");
   String filter = "filter-1274492040";
   float analysisPercentage = 1609757661;
   BulkAnalyzeConversationsResponse response =
       contactCenterInsightsClient
           .bulkAnalyzeConversationsAsync(parent, filter, analysisPercentage)
           .get();
 }
Parameters
Name Description
parent LocationName

Required. The parent resource to create analyses in.
filter String

Required. Filter used to select the subset of conversations to analyze.
analysisPercentage float

Required. Percentage of selected conversation to analyze, between [0, 100].
Returns
Type Description
OperationFuture<BulkAnalyzeConversationsResponse,BulkAnalyzeConversationsMetadata>

bulkAnalyzeConversationsAsync(String parent, String filter, float analysisPercentage)

public final OperationFuture<BulkAnalyzeConversationsResponse,BulkAnalyzeConversationsMetadata> bulkAnalyzeConversationsAsync(String parent, String filter, float analysisPercentage)

Analyzes multiple conversations in a single request.

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 (ContactCenterInsightsClient contactCenterInsightsClient =
     ContactCenterInsightsClient.create()) {
   String parent = LocationName.of("[PROJECT]", "[LOCATION]").toString();
   String filter = "filter-1274492040";
   float analysisPercentage = 1609757661;
   BulkAnalyzeConversationsResponse response =
       contactCenterInsightsClient
           .bulkAnalyzeConversationsAsync(parent, filter, analysisPercentage)
           .get();
 }
Parameters
Name Description
parent String

Required. The parent resource to create analyses in.
filter String

Required. Filter used to select the subset of conversations to analyze.
analysisPercentage float

Required. Percentage of selected conversation to analyze, between [0, 100].
Returns
Type Description
OperationFuture<BulkAnalyzeConversationsResponse,BulkAnalyzeConversationsMetadata>

bulkAnalyzeConversationsCallable()

public final UnaryCallable<BulkAnalyzeConversationsRequest,Operation> bulkAnalyzeConversationsCallable()

Analyzes multiple conversations in a single request.

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 (ContactCenterInsightsClient contactCenterInsightsClient =
     ContactCenterInsightsClient.create()) {
   BulkAnalyzeConversationsRequest request =
       BulkAnalyzeConversationsRequest.newBuilder()
           .setParent(LocationName.of("[PROJECT]", "[LOCATION]").toString())
           .setFilter("filter-1274492040")
           .setAnalysisPercentage(1609757661)
           .setAnnotatorSelector(AnnotatorSelector.newBuilder().build())
           .build();
   ApiFuture<Operation> future =
       contactCenterInsightsClient.bulkAnalyzeConversationsCallable().futureCall(request);
   // Do something.
   Operation response = future.get();
 }
Returns
Type Description
UnaryCallable<BulkAnalyzeConversationsRequest,Operation>

bulkAnalyzeConversationsOperationCallable()

public final OperationCallable<BulkAnalyzeConversationsRequest,BulkAnalyzeConversationsResponse,BulkAnalyzeConversationsMetadata> bulkAnalyzeConversationsOperationCallable()

Analyzes multiple conversations in a single request.

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 (ContactCenterInsightsClient contactCenterInsightsClient =
     ContactCenterInsightsClient.create()) {
   BulkAnalyzeConversationsRequest request =
       BulkAnalyzeConversationsRequest.newBuilder()
           .setParent(LocationName.of("[PROJECT]", "[LOCATION]").toString())
           .setFilter("filter-1274492040")
           .setAnalysisPercentage(1609757661)
           .setAnnotatorSelector(AnnotatorSelector.newBuilder().build())
           .build();
   OperationFuture<BulkAnalyzeConversationsResponse, BulkAnalyzeConversationsMetadata> future =
       contactCenterInsightsClient
           .bulkAnalyzeConversationsOperationCallable()
           .futureCall(request);
   // Do something.
   BulkAnalyzeConversationsResponse response = future.get();
 }
Returns
Type Description
OperationCallable<BulkAnalyzeConversationsRequest,BulkAnalyzeConversationsResponse,BulkAnalyzeConversationsMetadata>

bulkDeleteConversationsAsync(BulkDeleteConversationsRequest request)

public final OperationFuture<BulkDeleteConversationsResponse,BulkDeleteConversationsMetadata> bulkDeleteConversationsAsync(BulkDeleteConversationsRequest request)

Deletes multiple conversations in a single request.

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 (ContactCenterInsightsClient contactCenterInsightsClient =
     ContactCenterInsightsClient.create()) {
   BulkDeleteConversationsRequest request =
       BulkDeleteConversationsRequest.newBuilder()
           .setParent(LocationName.of("[PROJECT]", "[LOCATION]").toString())
           .setFilter("filter-1274492040")
           .setMaxDeleteCount(1611707510)
           .setForce(true)
           .build();
   BulkDeleteConversationsResponse response =
       contactCenterInsightsClient.bulkDeleteConversationsAsync(request).get();
 }
Parameter
Name Description
request BulkDeleteConversationsRequest

The request object containing all of the parameters for the API call.
Returns
Type Description
OperationFuture<BulkDeleteConversationsResponse,BulkDeleteConversationsMetadata>

bulkDeleteConversationsAsync(LocationName parent, String filter)

public final OperationFuture<BulkDeleteConversationsResponse,BulkDeleteConversationsMetadata> bulkDeleteConversationsAsync(LocationName parent, String filter)

Deletes multiple conversations in a single request.

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 (ContactCenterInsightsClient contactCenterInsightsClient =
     ContactCenterInsightsClient.create()) {
   LocationName parent = LocationName.of("[PROJECT]", "[LOCATION]");
   String filter = "filter-1274492040";
   BulkDeleteConversationsResponse response =
       contactCenterInsightsClient.bulkDeleteConversationsAsync(parent, filter).get();
 }
Parameters
Name Description
parent LocationName

Required. The parent resource to delete conversations from. Format: projects/{project}/locations/{location}
filter String

Filter used to select the subset of conversations to delete.
Returns
Type Description
OperationFuture<BulkDeleteConversationsResponse,BulkDeleteConversationsMetadata>

bulkDeleteConversationsAsync(String parent, String filter)

public final OperationFuture<BulkDeleteConversationsResponse,BulkDeleteConversationsMetadata> bulkDeleteConversationsAsync(String parent, String filter)

Deletes multiple conversations in a single request.

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 (ContactCenterInsightsClient contactCenterInsightsClient =
     ContactCenterInsightsClient.create()) {
   String parent = LocationName.of("[PROJECT]", "[LOCATION]").toString();
   String filter = "filter-1274492040";
   BulkDeleteConversationsResponse response =
       contactCenterInsightsClient.bulkDeleteConversationsAsync(parent, filter).get();
 }
Parameters
Name Description
parent String

Required. The parent resource to delete conversations from. Format: projects/{project}/locations/{location}
filter String

Filter used to select the subset of conversations to delete.
Returns
Type Description
OperationFuture<BulkDeleteConversationsResponse,BulkDeleteConversationsMetadata>

bulkDeleteConversationsCallable()

public final UnaryCallable<BulkDeleteConversationsRequest,Operation> bulkDeleteConversationsCallable()

Deletes multiple conversations in a single request.

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 (ContactCenterInsightsClient contactCenterInsightsClient =
     ContactCenterInsightsClient.create()) {
   BulkDeleteConversationsRequest request =
       BulkDeleteConversationsRequest.newBuilder()
           .setParent(LocationName.of("[PROJECT]", "[LOCATION]").toString())
           .setFilter("filter-1274492040")
           .setMaxDeleteCount(1611707510)
           .setForce(true)
           .build();
   ApiFuture<Operation> future =
       contactCenterInsightsClient.bulkDeleteConversationsCallable().futureCall(request);
   // Do something.
   Operation response = future.get();
 }
Returns
Type Description
UnaryCallable<BulkDeleteConversationsRequest,Operation>

bulkDeleteConversationsOperationCallable()

public final OperationCallable<BulkDeleteConversationsRequest,BulkDeleteConversationsResponse,BulkDeleteConversationsMetadata> bulkDeleteConversationsOperationCallable()

Deletes multiple conversations in a single request.

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 (ContactCenterInsightsClient contactCenterInsightsClient =
     ContactCenterInsightsClient.create()) {
   BulkDeleteConversationsRequest request =
       BulkDeleteConversationsRequest.newBuilder()
           .setParent(LocationName.of("[PROJECT]", "[LOCATION]").toString())
           .setFilter("filter-1274492040")
           .setMaxDeleteCount(1611707510)
           .setForce(true)
           .build();
   OperationFuture<BulkDeleteConversationsResponse, BulkDeleteConversationsMetadata> future =
       contactCenterInsightsClient
           .bulkDeleteConversationsOperationCallable()
           .futureCall(request);
   // Do something.
   BulkDeleteConversationsResponse response = future.get();
 }
Returns
Type Description
OperationCallable<BulkDeleteConversationsRequest,BulkDeleteConversationsResponse,BulkDeleteConversationsMetadata>

calculateIssueModelStats(CalculateIssueModelStatsRequest request)

public final CalculateIssueModelStatsResponse calculateIssueModelStats(CalculateIssueModelStatsRequest request)

Gets an issue model's statistics.

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 (ContactCenterInsightsClient contactCenterInsightsClient =
     ContactCenterInsightsClient.create()) {
   CalculateIssueModelStatsRequest request =
       CalculateIssueModelStatsRequest.newBuilder()
           .setIssueModel(
               IssueModelName.of("[PROJECT]", "[LOCATION]", "[ISSUE_MODEL]").toString())
           .build();
   CalculateIssueModelStatsResponse response =
       contactCenterInsightsClient.calculateIssueModelStats(request);
 }
Parameter
Name Description
request CalculateIssueModelStatsRequest

The request object containing all of the parameters for the API call.
Returns
Type Description
CalculateIssueModelStatsResponse

calculateIssueModelStats(IssueModelName issueModel)

public final CalculateIssueModelStatsResponse calculateIssueModelStats(IssueModelName issueModel)

Gets an issue model's statistics.

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 (ContactCenterInsightsClient contactCenterInsightsClient =
     ContactCenterInsightsClient.create()) {
   IssueModelName issueModel = IssueModelName.of("[PROJECT]", "[LOCATION]", "[ISSUE_MODEL]");
   CalculateIssueModelStatsResponse response =
       contactCenterInsightsClient.calculateIssueModelStats(issueModel);
 }
Parameter
Name Description
issueModel IssueModelName

Required. The resource name of the issue model to query against.
Returns
Type Description
CalculateIssueModelStatsResponse

calculateIssueModelStats(String issueModel)

public final CalculateIssueModelStatsResponse calculateIssueModelStats(String issueModel)

Gets an issue model's statistics.

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 (ContactCenterInsightsClient contactCenterInsightsClient =
     ContactCenterInsightsClient.create()) {
   String issueModel = IssueModelName.of("[PROJECT]", "[LOCATION]", "[ISSUE_MODEL]").toString();
   CalculateIssueModelStatsResponse response =
       contactCenterInsightsClient.calculateIssueModelStats(issueModel);
 }
Parameter
Name Description
issueModel String

Required. The resource name of the issue model to query against.
Returns
Type Description
CalculateIssueModelStatsResponse

calculateIssueModelStatsCallable()

public final UnaryCallable<CalculateIssueModelStatsRequest,CalculateIssueModelStatsResponse> calculateIssueModelStatsCallable()

Gets an issue model's statistics.

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 (ContactCenterInsightsClient contactCenterInsightsClient =
     ContactCenterInsightsClient.create()) {
   CalculateIssueModelStatsRequest request =
       CalculateIssueModelStatsRequest.newBuilder()
           .setIssueModel(
               IssueModelName.of("[PROJECT]", "[LOCATION]", "[ISSUE_MODEL]").toString())
           .build();
   ApiFuture<CalculateIssueModelStatsResponse> future =
       contactCenterInsightsClient.calculateIssueModelStatsCallable().futureCall(request);
   // Do something.
   CalculateIssueModelStatsResponse response = future.get();
 }
Returns
Type Description
UnaryCallable<CalculateIssueModelStatsRequest,CalculateIssueModelStatsResponse>

calculateStats(CalculateStatsRequest request)

public final CalculateStatsResponse calculateStats(CalculateStatsRequest request)

Gets conversation statistics.

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 (ContactCenterInsightsClient contactCenterInsightsClient =
     ContactCenterInsightsClient.create()) {
   CalculateStatsRequest request =
       CalculateStatsRequest.newBuilder()
           .setLocation(LocationName.of("[PROJECT]", "[LOCATION]").toString())
           .setFilter("filter-1274492040")
           .build();
   CalculateStatsResponse response = contactCenterInsightsClient.calculateStats(request);
 }
Parameter
Name Description
request CalculateStatsRequest

The request object containing all of the parameters for the API call.
Returns
Type Description
CalculateStatsResponse

calculateStats(LocationName location)

public final CalculateStatsResponse calculateStats(LocationName location)

Gets conversation statistics.

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 (ContactCenterInsightsClient contactCenterInsightsClient =
     ContactCenterInsightsClient.create()) {
   LocationName location = LocationName.of("[PROJECT]", "[LOCATION]");
   CalculateStatsResponse response = contactCenterInsightsClient.calculateStats(location);
 }
Parameter
Name Description
location LocationName

Required. The location of the conversations.
Returns
Type Description
CalculateStatsResponse

calculateStats(String location)

public final CalculateStatsResponse calculateStats(String location)

Gets conversation statistics.

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 (ContactCenterInsightsClient contactCenterInsightsClient =
     ContactCenterInsightsClient.create()) {
   String location = LocationName.of("[PROJECT]", "[LOCATION]").toString();
   CalculateStatsResponse response = contactCenterInsightsClient.calculateStats(location);
 }
Parameter
Name Description
location String

Required. The location of the conversations.
Returns
Type Description
CalculateStatsResponse

calculateStatsCallable()

public final UnaryCallable<CalculateStatsRequest,CalculateStatsResponse> calculateStatsCallable()

Gets conversation statistics.

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 (ContactCenterInsightsClient contactCenterInsightsClient =
     ContactCenterInsightsClient.create()) {
   CalculateStatsRequest request =
       CalculateStatsRequest.newBuilder()
           .setLocation(LocationName.of("[PROJECT]", "[LOCATION]").toString())
           .setFilter("filter-1274492040")
           .build();
   ApiFuture<CalculateStatsResponse> future =
       contactCenterInsightsClient.calculateStatsCallable().futureCall(request);
   // Do something.
   CalculateStatsResponse response = future.get();
 }
Returns
Type Description
UnaryCallable<CalculateStatsRequest,CalculateStatsResponse>

close()

public final void close()

createAnalysisAsync(ConversationName parent, Analysis analysis)

public final OperationFuture<Analysis,CreateAnalysisOperationMetadata> createAnalysisAsync(ConversationName parent, Analysis analysis)

Creates an analysis. The long running operation is done when the analysis has completed.

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 (ContactCenterInsightsClient contactCenterInsightsClient =
     ContactCenterInsightsClient.create()) {
   ConversationName parent = ConversationName.of("[PROJECT]", "[LOCATION]", "[CONVERSATION]");
   Analysis analysis = Analysis.newBuilder().build();
   Analysis response = contactCenterInsightsClient.createAnalysisAsync(parent, analysis).get();
 }
Parameters
Name Description
parent ConversationName

Required. The parent resource of the analysis.
analysis Analysis

Required. The analysis to create.
Returns
Type Description
OperationFuture<Analysis,CreateAnalysisOperationMetadata>

createAnalysisAsync(CreateAnalysisRequest request)

public final OperationFuture<Analysis,CreateAnalysisOperationMetadata> createAnalysisAsync(CreateAnalysisRequest request)

Creates an analysis. The long running operation is done when the analysis has completed.

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 (ContactCenterInsightsClient contactCenterInsightsClient =
     ContactCenterInsightsClient.create()) {
   CreateAnalysisRequest request =
       CreateAnalysisRequest.newBuilder()
           .setParent(
               ConversationName.of("[PROJECT]", "[LOCATION]", "[CONVERSATION]").toString())
           .setAnalysis(Analysis.newBuilder().build())
           .build();
   Analysis response = contactCenterInsightsClient.createAnalysisAsync(request).get();
 }
Parameter
Name Description
request CreateAnalysisRequest

The request object containing all of the parameters for the API call.
Returns
Type Description
OperationFuture<Analysis,CreateAnalysisOperationMetadata>

createAnalysisAsync(String parent, Analysis analysis)

public final OperationFuture<Analysis,CreateAnalysisOperationMetadata> createAnalysisAsync(String parent, Analysis analysis)

Creates an analysis. The long running operation is done when the analysis has completed.

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 (ContactCenterInsightsClient contactCenterInsightsClient =
     ContactCenterInsightsClient.create()) {
   String parent = ConversationName.of("[PROJECT]", "[LOCATION]", "[CONVERSATION]").toString();
   Analysis analysis = Analysis.newBuilder().build();
   Analysis response = contactCenterInsightsClient.createAnalysisAsync(parent, analysis).get();
 }
Parameters
Name Description
parent String

Required. The parent resource of the analysis.
analysis Analysis

Required. The analysis to create.
Returns
Type Description
OperationFuture<Analysis,CreateAnalysisOperationMetadata>

createAnalysisCallable()

public final UnaryCallable<CreateAnalysisRequest,Operation> createAnalysisCallable()

Creates an analysis. The long running operation is done when the analysis has completed.

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 (ContactCenterInsightsClient contactCenterInsightsClient =
     ContactCenterInsightsClient.create()) {
   CreateAnalysisRequest request =
       CreateAnalysisRequest.newBuilder()
           .setParent(
               ConversationName.of("[PROJECT]", "[LOCATION]", "[CONVERSATION]").toString())
           .setAnalysis(Analysis.newBuilder().build())
           .build();
   ApiFuture<Operation> future =
       contactCenterInsightsClient.createAnalysisCallable().futureCall(request);
   // Do something.
   Operation response = future.get();
 }
Returns
Type Description
UnaryCallable<CreateAnalysisRequest,Operation>

createAnalysisOperationCallable()

public final OperationCallable<CreateAnalysisRequest,Analysis,CreateAnalysisOperationMetadata> createAnalysisOperationCallable()

Creates an analysis. The long running operation is done when the analysis has completed.

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 (ContactCenterInsightsClient contactCenterInsightsClient =
     ContactCenterInsightsClient.create()) {
   CreateAnalysisRequest request =
       CreateAnalysisRequest.newBuilder()
           .setParent(
               ConversationName.of("[PROJECT]", "[LOCATION]", "[CONVERSATION]").toString())
           .setAnalysis(Analysis.newBuilder().build())
           .build();
   OperationFuture<Analysis, CreateAnalysisOperationMetadata> future =
       contactCenterInsightsClient.createAnalysisOperationCallable().futureCall(request);
   // Do something.
   Analysis response = future.get();
 }
Returns
Type Description
OperationCallable<CreateAnalysisRequest,Analysis,CreateAnalysisOperationMetadata>

createConversation(CreateConversationRequest request)

public final Conversation createConversation(CreateConversationRequest request)

Creates a conversation.

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 (ContactCenterInsightsClient contactCenterInsightsClient =
     ContactCenterInsightsClient.create()) {
   CreateConversationRequest request =
       CreateConversationRequest.newBuilder()
           .setParent(LocationName.of("[PROJECT]", "[LOCATION]").toString())
           .setConversation(Conversation.newBuilder().build())
           .setConversationId("conversationId-1676095234")
           .build();
   Conversation response = contactCenterInsightsClient.createConversation(request);
 }
Parameter
Name Description
request CreateConversationRequest

The request object containing all of the parameters for the API call.
Returns
Type Description
Conversation

createConversation(LocationName parent, Conversation conversation, String conversationId)

public final Conversation createConversation(LocationName parent, Conversation conversation, String conversationId)

Creates a conversation.

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 (ContactCenterInsightsClient contactCenterInsightsClient =
     ContactCenterInsightsClient.create()) {
   LocationName parent = LocationName.of("[PROJECT]", "[LOCATION]");
   Conversation conversation = Conversation.newBuilder().build();
   String conversationId = "conversationId-1676095234";
   Conversation response =
       contactCenterInsightsClient.createConversation(parent, conversation, conversationId);
 }
Parameters
Name Description
parent LocationName

Required. The parent resource of the conversation.
conversation Conversation

Required. The conversation resource to create.
conversationId String

A unique ID for the new conversation. This ID will become the final component of the conversation's resource name. If no ID is specified, a server-generated ID will be used.

This value should be 4-64 characters and must match the regular expression ^[a-z0-9-]{4,64}$. Valid characters are a-z-
Returns
Type Description
Conversation

createConversation(String parent, Conversation conversation, String conversationId)

public final Conversation createConversation(String parent, Conversation conversation, String conversationId)

Creates a conversation.

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 (ContactCenterInsightsClient contactCenterInsightsClient =
     ContactCenterInsightsClient.create()) {
   String parent = LocationName.of("[PROJECT]", "[LOCATION]").toString();
   Conversation conversation = Conversation.newBuilder().build();
   String conversationId = "conversationId-1676095234";
   Conversation response =
       contactCenterInsightsClient.createConversation(parent, conversation, conversationId);
 }
Parameters
Name Description
parent String

Required. The parent resource of the conversation.
conversation Conversation

Required. The conversation resource to create.
conversationId String

A unique ID for the new conversation. This ID will become the final component of the conversation's resource name. If no ID is specified, a server-generated ID will be used.

This value should be 4-64 characters and must match the regular expression ^[a-z0-9-]{4,64}$. Valid characters are a-z-
Returns
Type Description
Conversation

createConversationCallable()

public final UnaryCallable<CreateConversationRequest,Conversation> createConversationCallable()

Creates a conversation.

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 (ContactCenterInsightsClient contactCenterInsightsClient =
     ContactCenterInsightsClient.create()) {
   CreateConversationRequest request =
       CreateConversationRequest.newBuilder()
           .setParent(LocationName.of("[PROJECT]", "[LOCATION]").toString())
           .setConversation(Conversation.newBuilder().build())
           .setConversationId("conversationId-1676095234")
           .build();
   ApiFuture<Conversation> future =
       contactCenterInsightsClient.createConversationCallable().futureCall(request);
   // Do something.
   Conversation response = future.get();
 }
Returns
Type Description
UnaryCallable<CreateConversationRequest,Conversation>

createIssueModelAsync(CreateIssueModelRequest request)

public final OperationFuture<IssueModel,CreateIssueModelMetadata> createIssueModelAsync(CreateIssueModelRequest request)

Creates an issue model.

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 (ContactCenterInsightsClient contactCenterInsightsClient =
     ContactCenterInsightsClient.create()) {
   CreateIssueModelRequest request =
       CreateIssueModelRequest.newBuilder()
           .setParent(LocationName.of("[PROJECT]", "[LOCATION]").toString())
           .setIssueModel(IssueModel.newBuilder().build())
           .build();
   IssueModel response = contactCenterInsightsClient.createIssueModelAsync(request).get();
 }
Parameter
Name Description
request CreateIssueModelRequest

The request object containing all of the parameters for the API call.
Returns
Type Description
OperationFuture<IssueModel,CreateIssueModelMetadata>

createIssueModelAsync(LocationName parent, IssueModel issueModel)

public final OperationFuture<IssueModel,CreateIssueModelMetadata> createIssueModelAsync(LocationName parent, IssueModel issueModel)

Creates an issue model.

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 (ContactCenterInsightsClient contactCenterInsightsClient =
     ContactCenterInsightsClient.create()) {
   LocationName parent = LocationName.of("[PROJECT]", "[LOCATION]");
   IssueModel issueModel = IssueModel.newBuilder().build();
   IssueModel response =
       contactCenterInsightsClient.createIssueModelAsync(parent, issueModel).get();
 }
Parameters
Name Description
parent LocationName

Required. The parent resource of the issue model.
issueModel IssueModel

Required. The issue model to create.
Returns
Type Description
OperationFuture<IssueModel,CreateIssueModelMetadata>

createIssueModelAsync(String parent, IssueModel issueModel)

public final OperationFuture<IssueModel,CreateIssueModelMetadata> createIssueModelAsync(String parent, IssueModel issueModel)

Creates an issue model.

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 (ContactCenterInsightsClient contactCenterInsightsClient =
     ContactCenterInsightsClient.create()) {
   String parent = LocationName.of("[PROJECT]", "[LOCATION]").toString();
   IssueModel issueModel = IssueModel.newBuilder().build();
   IssueModel response =
       contactCenterInsightsClient.createIssueModelAsync(parent, issueModel).get();
 }
Parameters
Name Description
parent String

Required. The parent resource of the issue model.
issueModel IssueModel

Required. The issue model to create.
Returns
Type Description
OperationFuture<IssueModel,CreateIssueModelMetadata>

createIssueModelCallable()

public final UnaryCallable<CreateIssueModelRequest,Operation> createIssueModelCallable()

Creates an issue model.

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 (ContactCenterInsightsClient contactCenterInsightsClient =
     ContactCenterInsightsClient.create()) {
   CreateIssueModelRequest request =
       CreateIssueModelRequest.newBuilder()
           .setParent(LocationName.of("[PROJECT]", "[LOCATION]").toString())
           .setIssueModel(IssueModel.newBuilder().build())
           .build();
   ApiFuture<Operation> future =
       contactCenterInsightsClient.createIssueModelCallable().futureCall(request);
   // Do something.
   Operation response = future.get();
 }
Returns
Type Description
UnaryCallable<CreateIssueModelRequest,Operation>

createIssueModelOperationCallable()

public final OperationCallable<CreateIssueModelRequest,IssueModel,CreateIssueModelMetadata> createIssueModelOperationCallable()

Creates an issue model.

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 (ContactCenterInsightsClient contactCenterInsightsClient =
     ContactCenterInsightsClient.create()) {
   CreateIssueModelRequest request =
       CreateIssueModelRequest.newBuilder()
           .setParent(LocationName.of("[PROJECT]", "[LOCATION]").toString())
           .setIssueModel(IssueModel.newBuilder().build())
           .build();
   OperationFuture<IssueModel, CreateIssueModelMetadata> future =
       contactCenterInsightsClient.createIssueModelOperationCallable().futureCall(request);
   // Do something.
   IssueModel response = future.get();
 }
Returns
Type Description
OperationCallable<CreateIssueModelRequest,IssueModel,CreateIssueModelMetadata>

createPhraseMatcher(CreatePhraseMatcherRequest request)

public final PhraseMatcher createPhraseMatcher(CreatePhraseMatcherRequest request)

Creates a phrase matcher.

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 (ContactCenterInsightsClient contactCenterInsightsClient =
     ContactCenterInsightsClient.create()) {
   CreatePhraseMatcherRequest request =
       CreatePhraseMatcherRequest.newBuilder()
           .setParent(LocationName.of("[PROJECT]", "[LOCATION]").toString())
           .setPhraseMatcher(PhraseMatcher.newBuilder().build())
           .build();
   PhraseMatcher response = contactCenterInsightsClient.createPhraseMatcher(request);
 }
Parameter
Name Description
request CreatePhraseMatcherRequest

The request object containing all of the parameters for the API call.
Returns
Type Description
PhraseMatcher

createPhraseMatcher(LocationName parent, PhraseMatcher phraseMatcher)

public final PhraseMatcher createPhraseMatcher(LocationName parent, PhraseMatcher phraseMatcher)

Creates a phrase matcher.

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 (ContactCenterInsightsClient contactCenterInsightsClient =
     ContactCenterInsightsClient.create()) {
   LocationName parent = LocationName.of("[PROJECT]", "[LOCATION]");
   PhraseMatcher phraseMatcher = PhraseMatcher.newBuilder().build();
   PhraseMatcher response =
       contactCenterInsightsClient.createPhraseMatcher(parent, phraseMatcher);
 }
Parameters
Name Description
parent LocationName

Required. The parent resource of the phrase matcher. Required. The location to create a phrase matcher for. Format: projects/<Project ID>/locations/<Location ID> or projects/<Project Number>/locations/<Location ID>
phraseMatcher PhraseMatcher

Required. The phrase matcher resource to create.
Returns
Type Description
PhraseMatcher

createPhraseMatcher(String parent, PhraseMatcher phraseMatcher)

public final PhraseMatcher createPhraseMatcher(String parent, PhraseMatcher phraseMatcher)

Creates a phrase matcher.

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 (ContactCenterInsightsClient contactCenterInsightsClient =
     ContactCenterInsightsClient.create()) {
   String parent = LocationName.of("[PROJECT]", "[LOCATION]").toString();
   PhraseMatcher phraseMatcher = PhraseMatcher.newBuilder().build();
   PhraseMatcher response =
       contactCenterInsightsClient.createPhraseMatcher(parent, phraseMatcher);
 }
Parameters
Name Description
parent String

Required. The parent resource of the phrase matcher. Required. The location to create a phrase matcher for. Format: projects/<Project ID>/locations/<Location ID> or projects/<Project Number>/locations/<Location ID>
phraseMatcher PhraseMatcher

Required. The phrase matcher resource to create.
Returns
Type Description
PhraseMatcher

createPhraseMatcherCallable()

public final UnaryCallable<CreatePhraseMatcherRequest,PhraseMatcher> createPhraseMatcherCallable()

Creates a phrase matcher.

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 (ContactCenterInsightsClient contactCenterInsightsClient =
     ContactCenterInsightsClient.create()) {
   CreatePhraseMatcherRequest request =
       CreatePhraseMatcherRequest.newBuilder()
           .setParent(LocationName.of("[PROJECT]", "[LOCATION]").toString())
           .setPhraseMatcher(PhraseMatcher.newBuilder().build())
           .build();
   ApiFuture<PhraseMatcher> future =
       contactCenterInsightsClient.createPhraseMatcherCallable().futureCall(request);
   // Do something.
   PhraseMatcher response = future.get();
 }
Returns
Type Description
UnaryCallable<CreatePhraseMatcherRequest,PhraseMatcher>

createView(CreateViewRequest request)

public final View createView(CreateViewRequest request)

Creates a view.

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 (ContactCenterInsightsClient contactCenterInsightsClient =
     ContactCenterInsightsClient.create()) {
   CreateViewRequest request =
       CreateViewRequest.newBuilder()
           .setParent(LocationName.of("[PROJECT]", "[LOCATION]").toString())
           .setView(View.newBuilder().build())
           .build();
   View response = contactCenterInsightsClient.createView(request);
 }
Parameter
Name Description
request CreateViewRequest

The request object containing all of the parameters for the API call.
Returns
Type Description
View

createView(LocationName parent, View view)

public final View createView(LocationName parent, View view)

Creates a view.

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 (ContactCenterInsightsClient contactCenterInsightsClient =
     ContactCenterInsightsClient.create()) {
   LocationName parent = LocationName.of("[PROJECT]", "[LOCATION]");
   View view = View.newBuilder().build();
   View response = contactCenterInsightsClient.createView(parent, view);
 }
Parameters
Name Description
parent LocationName

Required. The parent resource of the view. Required. The location to create a view for. Format: projects/<Project ID>/locations/<Location ID> or projects/<Project Number>/locations/<Location ID>
view View

Required. The view resource to create.
Returns
Type Description
View

createView(String parent, View view)

public final View createView(String parent, View view)

Creates a view.

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 (ContactCenterInsightsClient contactCenterInsightsClient =
     ContactCenterInsightsClient.create()) {
   String parent = LocationName.of("[PROJECT]", "[LOCATION]").toString();
   View view = View.newBuilder().build();
   View response = contactCenterInsightsClient.createView(parent, view);
 }
Parameters
Name Description
parent String

Required. The parent resource of the view. Required. The location to create a view for. Format: projects/<Project ID>/locations/<Location ID> or projects/<Project Number>/locations/<Location ID>
view View

Required. The view resource to create.
Returns
Type Description
View

createViewCallable()

public final UnaryCallable<CreateViewRequest,View> createViewCallable()

Creates a view.

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 (ContactCenterInsightsClient contactCenterInsightsClient =
     ContactCenterInsightsClient.create()) {
   CreateViewRequest request =
       CreateViewRequest.newBuilder()
           .setParent(LocationName.of("[PROJECT]", "[LOCATION]").toString())
           .setView(View.newBuilder().build())
           .build();
   ApiFuture<View> future = contactCenterInsightsClient.createViewCallable().futureCall(request);
   // Do something.
   View response = future.get();
 }
Returns
Type Description
UnaryCallable<CreateViewRequest,View>

deleteAnalysis(AnalysisName name)

public final void deleteAnalysis(AnalysisName name)

Deletes an analysis.

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 (ContactCenterInsightsClient contactCenterInsightsClient =
     ContactCenterInsightsClient.create()) {
   AnalysisName name =
       AnalysisName.of("[PROJECT]", "[LOCATION]", "[CONVERSATION]", "[ANALYSIS]");
   contactCenterInsightsClient.deleteAnalysis(name);
 }
Parameter
Name Description
name AnalysisName

Required. The name of the analysis to delete.

deleteAnalysis(DeleteAnalysisRequest request)

public final void deleteAnalysis(DeleteAnalysisRequest request)

Deletes an analysis.

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 (ContactCenterInsightsClient contactCenterInsightsClient =
     ContactCenterInsightsClient.create()) {
   DeleteAnalysisRequest request =
       DeleteAnalysisRequest.newBuilder()
           .setName(
               AnalysisName.of("[PROJECT]", "[LOCATION]", "[CONVERSATION]", "[ANALYSIS]")
                   .toString())
           .build();
   contactCenterInsightsClient.deleteAnalysis(request);
 }
Parameter
Name Description
request DeleteAnalysisRequest

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

deleteAnalysis(String name)

public final void deleteAnalysis(String name)

Deletes an analysis.

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 (ContactCenterInsightsClient contactCenterInsightsClient =
     ContactCenterInsightsClient.create()) {
   String name =
       AnalysisName.of("[PROJECT]", "[LOCATION]", "[CONVERSATION]", "[ANALYSIS]").toString();
   contactCenterInsightsClient.deleteAnalysis(name);
 }
Parameter
Name Description
name String

Required. The name of the analysis to delete.

deleteAnalysisCallable()

public final UnaryCallable<DeleteAnalysisRequest,Empty> deleteAnalysisCallable()

Deletes an analysis.

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 (ContactCenterInsightsClient contactCenterInsightsClient =
     ContactCenterInsightsClient.create()) {
   DeleteAnalysisRequest request =
       DeleteAnalysisRequest.newBuilder()
           .setName(
               AnalysisName.of("[PROJECT]", "[LOCATION]", "[CONVERSATION]", "[ANALYSIS]")
                   .toString())
           .build();
   ApiFuture<Empty> future =
       contactCenterInsightsClient.deleteAnalysisCallable().futureCall(request);
   // Do something.
   future.get();
 }
Returns
Type Description
UnaryCallable<DeleteAnalysisRequest,Empty>

deleteConversation(ConversationName name)

public final void deleteConversation(ConversationName name)

Deletes a conversation.

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 (ContactCenterInsightsClient contactCenterInsightsClient =
     ContactCenterInsightsClient.create()) {
   ConversationName name = ConversationName.of("[PROJECT]", "[LOCATION]", "[CONVERSATION]");
   contactCenterInsightsClient.deleteConversation(name);
 }
Parameter
Name Description
name ConversationName

Required. The name of the conversation to delete.

deleteConversation(DeleteConversationRequest request)

public final void deleteConversation(DeleteConversationRequest request)

Deletes a conversation.

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 (ContactCenterInsightsClient contactCenterInsightsClient =
     ContactCenterInsightsClient.create()) {
   DeleteConversationRequest request =
       DeleteConversationRequest.newBuilder()
           .setName(ConversationName.of("[PROJECT]", "[LOCATION]", "[CONVERSATION]").toString())
           .setForce(true)
           .build();
   contactCenterInsightsClient.deleteConversation(request);
 }
Parameter
Name Description
request DeleteConversationRequest

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

deleteConversation(String name)

public final void deleteConversation(String name)

Deletes a conversation.

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 (ContactCenterInsightsClient contactCenterInsightsClient =
     ContactCenterInsightsClient.create()) {
   String name = ConversationName.of("[PROJECT]", "[LOCATION]", "[CONVERSATION]").toString();
   contactCenterInsightsClient.deleteConversation(name);
 }
Parameter
Name Description
name String

Required. The name of the conversation to delete.

deleteConversationCallable()

public final UnaryCallable<DeleteConversationRequest,Empty> deleteConversationCallable()

Deletes a conversation.

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 (ContactCenterInsightsClient contactCenterInsightsClient =
     ContactCenterInsightsClient.create()) {
   DeleteConversationRequest request =
       DeleteConversationRequest.newBuilder()
           .setName(ConversationName.of("[PROJECT]", "[LOCATION]", "[CONVERSATION]").toString())
           .setForce(true)
           .build();
   ApiFuture<Empty> future =
       contactCenterInsightsClient.deleteConversationCallable().futureCall(request);
   // Do something.
   future.get();
 }
Returns
Type Description
UnaryCallable<DeleteConversationRequest,Empty>

deleteIssue(DeleteIssueRequest request)

public final void deleteIssue(DeleteIssueRequest request)

Deletes an issue.

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 (ContactCenterInsightsClient contactCenterInsightsClient =
     ContactCenterInsightsClient.create()) {
   DeleteIssueRequest request =
       DeleteIssueRequest.newBuilder()
           .setName(
               IssueName.of("[PROJECT]", "[LOCATION]", "[ISSUE_MODEL]", "[ISSUE]").toString())
           .build();
   contactCenterInsightsClient.deleteIssue(request);
 }
Parameter
Name Description
request DeleteIssueRequest

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

deleteIssue(IssueName name)

public final void deleteIssue(IssueName name)

Deletes an issue.

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 (ContactCenterInsightsClient contactCenterInsightsClient =
     ContactCenterInsightsClient.create()) {
   IssueName name = IssueName.of("[PROJECT]", "[LOCATION]", "[ISSUE_MODEL]", "[ISSUE]");
   contactCenterInsightsClient.deleteIssue(name);
 }
Parameter
Name Description
name IssueName

Required. The name of the issue to delete.

deleteIssue(String name)

public final void deleteIssue(String name)

Deletes an issue.

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 (ContactCenterInsightsClient contactCenterInsightsClient =
     ContactCenterInsightsClient.create()) {
   String name = IssueName.of("[PROJECT]", "[LOCATION]", "[ISSUE_MODEL]", "[ISSUE]").toString();
   contactCenterInsightsClient.deleteIssue(name);
 }
Parameter
Name Description
name String

Required. The name of the issue to delete.

deleteIssueCallable()

public final UnaryCallable<DeleteIssueRequest,Empty> deleteIssueCallable()

Deletes an issue.

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 (ContactCenterInsightsClient contactCenterInsightsClient =
     ContactCenterInsightsClient.create()) {
   DeleteIssueRequest request =
       DeleteIssueRequest.newBuilder()
           .setName(
               IssueName.of("[PROJECT]", "[LOCATION]", "[ISSUE_MODEL]", "[ISSUE]").toString())
           .build();
   ApiFuture<Empty> future =
       contactCenterInsightsClient.deleteIssueCallable().futureCall(request);
   // Do something.
   future.get();
 }
Returns
Type Description
UnaryCallable<DeleteIssueRequest,Empty>

deleteIssueModelAsync(DeleteIssueModelRequest request)

public final OperationFuture<Empty,DeleteIssueModelMetadata> deleteIssueModelAsync(DeleteIssueModelRequest request)

Deletes an issue model.

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 (ContactCenterInsightsClient contactCenterInsightsClient =
     ContactCenterInsightsClient.create()) {
   DeleteIssueModelRequest request =
       DeleteIssueModelRequest.newBuilder()
           .setName(IssueModelName.of("[PROJECT]", "[LOCATION]", "[ISSUE_MODEL]").toString())
           .build();
   contactCenterInsightsClient.deleteIssueModelAsync(request).get();
 }
Parameter
Name Description
request DeleteIssueModelRequest

The request object containing all of the parameters for the API call.
Returns
Type Description
OperationFuture<Empty,DeleteIssueModelMetadata>

deleteIssueModelAsync(IssueModelName name)

public final OperationFuture<Empty,DeleteIssueModelMetadata> deleteIssueModelAsync(IssueModelName name)

Deletes an issue model.

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 (ContactCenterInsightsClient contactCenterInsightsClient =
     ContactCenterInsightsClient.create()) {
   IssueModelName name = IssueModelName.of("[PROJECT]", "[LOCATION]", "[ISSUE_MODEL]");
   contactCenterInsightsClient.deleteIssueModelAsync(name).get();
 }
Parameter
Name Description
name IssueModelName

Required. The name of the issue model to delete.
Returns
Type Description
OperationFuture<Empty,DeleteIssueModelMetadata>

deleteIssueModelAsync(String name)

public final OperationFuture<Empty,DeleteIssueModelMetadata> deleteIssueModelAsync(String name)

Deletes an issue model.

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 (ContactCenterInsightsClient contactCenterInsightsClient =
     ContactCenterInsightsClient.create()) {
   String name = IssueModelName.of("[PROJECT]", "[LOCATION]", "[ISSUE_MODEL]").toString();
   contactCenterInsightsClient.deleteIssueModelAsync(name).get();
 }
Parameter
Name Description
name String

Required. The name of the issue model to delete.
Returns
Type Description
OperationFuture<Empty,DeleteIssueModelMetadata>

deleteIssueModelCallable()

public final UnaryCallable<DeleteIssueModelRequest,Operation> deleteIssueModelCallable()

Deletes an issue model.

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 (ContactCenterInsightsClient contactCenterInsightsClient =
     ContactCenterInsightsClient.create()) {
   DeleteIssueModelRequest request =
       DeleteIssueModelRequest.newBuilder()
           .setName(IssueModelName.of("[PROJECT]", "[LOCATION]", "[ISSUE_MODEL]").toString())
           .build();
   ApiFuture<Operation> future =
       contactCenterInsightsClient.deleteIssueModelCallable().futureCall(request);
   // Do something.
   future.get();
 }
Returns
Type Description
UnaryCallable<DeleteIssueModelRequest,Operation>

deleteIssueModelOperationCallable()

public final OperationCallable<DeleteIssueModelRequest,Empty,DeleteIssueModelMetadata> deleteIssueModelOperationCallable()

Deletes an issue model.

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 (ContactCenterInsightsClient contactCenterInsightsClient =
     ContactCenterInsightsClient.create()) {
   DeleteIssueModelRequest request =
       DeleteIssueModelRequest.newBuilder()
           .setName(IssueModelName.of("[PROJECT]", "[LOCATION]", "[ISSUE_MODEL]").toString())
           .build();
   OperationFuture<Empty, DeleteIssueModelMetadata> future =
       contactCenterInsightsClient.deleteIssueModelOperationCallable().futureCall(request);
   // Do something.
   future.get();
 }
Returns
Type Description
OperationCallable<DeleteIssueModelRequest,Empty,DeleteIssueModelMetadata>

deletePhraseMatcher(DeletePhraseMatcherRequest request)

public final void deletePhraseMatcher(DeletePhraseMatcherRequest request)

Deletes a phrase matcher.

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 (ContactCenterInsightsClient contactCenterInsightsClient =
     ContactCenterInsightsClient.create()) {
   DeletePhraseMatcherRequest request =
       DeletePhraseMatcherRequest.newBuilder()
           .setName(
               PhraseMatcherName.of("[PROJECT]"