Class ContactCenterInsightsClient (2.3.1)

public class ContactCenterInsightsClient implements BackgroundResource

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 for illustrative purposes only.
 // It may require modifications to work in your environment.
 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().

The surface of this class includes several types of Java methods for each of the API's methods:

  1. A "flattened" method. With this type of method, the fields of the request type have been converted into function parameters. It may be the case that not all fields are available as parameters, and not every API method will have a flattened method entry point.
  2. A "request object" method. This type of method only takes one parameter, a request object, which must be constructed before the call. Not every API method will have a request object method.
  3. A "callable" method. This type of method takes no parameters and returns an immutable API callable object, which can be used to initiate calls to the service.

See the individual methods for example code.

Many parameters require resource names to be formatted in a particular way. To assist with these names, this class includes a format method for each type of name, and additionally a parse method to extract the individual identifiers contained within names that are returned.

This class can be customized by passing in a custom instance of ContactCenterInsightsSettings to create(). For example:

To customize credentials:


 // This snippet has been automatically generated for illustrative purposes only.
 // It may require modifications to work in your environment.
 ContactCenterInsightsSettings contactCenterInsightsSettings =
     ContactCenterInsightsSettings.newBuilder()
         .setCredentialsProvider(FixedCredentialsProvider.create(myCredentials))
         .build();
 ContactCenterInsightsClient contactCenterInsightsClient =
     ContactCenterInsightsClient.create(contactCenterInsightsSettings);
 

To customize the endpoint:


 // This snippet has been automatically generated for illustrative purposes only.
 // It may require modifications to work in your environment.
 ContactCenterInsightsSettings contactCenterInsightsSettings =
     ContactCenterInsightsSettings.newBuilder().setEndpoint(myEndpoint).build();
 ContactCenterInsightsClient contactCenterInsightsClient =
     ContactCenterInsightsClient.create(contactCenterInsightsSettings);
 

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

Inheritance

java.lang.Object > ContactCenterInsightsClient

Implements

BackgroundResource

Static Methods

create()

public static final ContactCenterInsightsClient create()

Constructs an instance of ContactCenterInsightsClient with default settings.

Returns
TypeDescription
ContactCenterInsightsClient
Exceptions
TypeDescription
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
NameDescription
settingsContactCenterInsightsSettings
Returns
TypeDescription
ContactCenterInsightsClient
Exceptions
TypeDescription
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
NameDescription
stubContactCenterInsightsStub
Returns
TypeDescription
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
NameDescription
settingsContactCenterInsightsSettings

ContactCenterInsightsClient(ContactCenterInsightsStub stub)

protected ContactCenterInsightsClient(ContactCenterInsightsStub stub)
Parameter
NameDescription
stubContactCenterInsightsStub

Methods

awaitTermination(long duration, TimeUnit unit)

public boolean awaitTermination(long duration, TimeUnit unit)
Parameters
NameDescription
durationlong
unitTimeUnit
Returns
TypeDescription
boolean
Exceptions
TypeDescription
InterruptedException

calculateIssueModelStats(CalculateIssueModelStatsRequest request)

public final CalculateIssueModelStatsResponse calculateIssueModelStats(CalculateIssueModelStatsRequest request)

Gets an issue model's statistics.

Sample code:


 // This snippet has been automatically generated for illustrative purposes only.
 // It may require modifications to work in your environment.
 try (ContactCenterInsightsClient contactCenterInsightsClient =
     ContactCenterInsightsClient.create()) {
   CalculateIssueModelStatsRequest request =
       CalculateIssueModelStatsRequest.newBuilder()
           .setIssueModel(
               IssueModelName.of("[PROJECT]", "[LOCATION]", "[ISSUE_MODEL]").toString())
           .build();
   CalculateIssueModelStatsResponse response =
       contactCenterInsightsClient.calculateIssueModelStats(request);
 }
 
Parameter
NameDescription
requestCalculateIssueModelStatsRequest

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

Returns
TypeDescription
CalculateIssueModelStatsResponse

calculateIssueModelStats(IssueModelName issueModel)

public final CalculateIssueModelStatsResponse calculateIssueModelStats(IssueModelName issueModel)

Gets an issue model's statistics.

Sample code:


 // This snippet has been automatically generated for illustrative purposes only.
 // It may require modifications to work in your environment.
 try (ContactCenterInsightsClient contactCenterInsightsClient =
     ContactCenterInsightsClient.create()) {
   IssueModelName issueModel = IssueModelName.of("[PROJECT]", "[LOCATION]", "[ISSUE_MODEL]");
   CalculateIssueModelStatsResponse response =
       contactCenterInsightsClient.calculateIssueModelStats(issueModel);
 }
 
Parameter
NameDescription
issueModelIssueModelName

Required. The resource name of the issue model to query against.

Returns
TypeDescription
CalculateIssueModelStatsResponse

calculateIssueModelStats(String issueModel)

public final CalculateIssueModelStatsResponse calculateIssueModelStats(String issueModel)

Gets an issue model's statistics.

Sample code:


 // This snippet has been automatically generated for illustrative purposes only.
 // It may require modifications to work in your environment.
 try (ContactCenterInsightsClient contactCenterInsightsClient =
     ContactCenterInsightsClient.create()) {
   String issueModel = IssueModelName.of("[PROJECT]", "[LOCATION]", "[ISSUE_MODEL]").toString();
   CalculateIssueModelStatsResponse response =
       contactCenterInsightsClient.calculateIssueModelStats(issueModel);
 }
 
Parameter
NameDescription
issueModelString

Required. The resource name of the issue model to query against.

Returns
TypeDescription
CalculateIssueModelStatsResponse

calculateIssueModelStatsCallable()

public final UnaryCallable<CalculateIssueModelStatsRequest,CalculateIssueModelStatsResponse> calculateIssueModelStatsCallable()

Gets an issue model's statistics.

Sample code:


 // This snippet has been automatically generated for illustrative purposes only.
 // It may require modifications to work in your environment.
 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
TypeDescription
UnaryCallable<CalculateIssueModelStatsRequest,CalculateIssueModelStatsResponse>

calculateStats(CalculateStatsRequest request)

public final CalculateStatsResponse calculateStats(CalculateStatsRequest request)

Gets conversation statistics.

Sample code:


 // This snippet has been automatically generated for illustrative purposes only.
 // It may require modifications to work in your environment.
 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
NameDescription
requestCalculateStatsRequest

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

Returns
TypeDescription
CalculateStatsResponse

calculateStats(LocationName location)

public final CalculateStatsResponse calculateStats(LocationName location)

Gets conversation statistics.

Sample code:


 // This snippet has been automatically generated for illustrative purposes only.
 // It may require modifications to work in your environment.
 try (ContactCenterInsightsClient contactCenterInsightsClient =
     ContactCenterInsightsClient.create()) {
   LocationName location = LocationName.of("[PROJECT]", "[LOCATION]");
   CalculateStatsResponse response = contactCenterInsightsClient.calculateStats(location);
 }
 
Parameter
NameDescription
locationLocationName

Required. The location of the conversations.

Returns
TypeDescription
CalculateStatsResponse

calculateStats(String location)

public final CalculateStatsResponse calculateStats(String location)

Gets conversation statistics.

Sample code:


 // This snippet has been automatically generated for illustrative purposes only.
 // It may require modifications to work in your environment.
 try (ContactCenterInsightsClient contactCenterInsightsClient =
     ContactCenterInsightsClient.create()) {
   String location = LocationName.of("[PROJECT]", "[LOCATION]").toString();
   CalculateStatsResponse response = contactCenterInsightsClient.calculateStats(location);
 }
 
Parameter
NameDescription
locationString

Required. The location of the conversations.

Returns
TypeDescription
CalculateStatsResponse

calculateStatsCallable()

public final UnaryCallable<CalculateStatsRequest,CalculateStatsResponse> calculateStatsCallable()

Gets conversation statistics.

Sample code:


 // This snippet has been automatically generated for illustrative purposes only.
 // It may require modifications to work in your environment.
 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
TypeDescription
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 for illustrative purposes only.
 // It may require modifications to work in your environment.
 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
NameDescription
parentConversationName

Required. The parent resource of the analysis.

analysisAnalysis

Required. The analysis to create.

Returns
TypeDescription
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 for illustrative purposes only.
 // It may require modifications to work in your environment.
 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
NameDescription
requestCreateAnalysisRequest

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

Returns
TypeDescription
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 for illustrative purposes only.
 // It may require modifications to work in your environment.
 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
NameDescription
parentString

Required. The parent resource of the analysis.

analysisAnalysis

Required. The analysis to create.

Returns
TypeDescription
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 for illustrative purposes only.
 // It may require modifications to work in your environment.
 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
TypeDescription
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 for illustrative purposes only.
 // It may require modifications to work in your environment.
 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
TypeDescription
OperationCallable<CreateAnalysisRequest,Analysis,CreateAnalysisOperationMetadata>

createConversation(CreateConversationRequest request)

public final Conversation createConversation(CreateConversationRequest request)

Creates a conversation.

Sample code:


 // This snippet has been automatically generated for illustrative purposes only.
 // It may require modifications to work in your environment.
 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
NameDescription
requestCreateConversationRequest

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

Returns
TypeDescription
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 for illustrative purposes only.
 // It may require modifications to work in your environment.
 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
NameDescription
parentLocationName

Required. The parent resource of the conversation.

conversationConversation

Required. The conversation resource to create.

conversationIdString

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
TypeDescription
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 for illustrative purposes only.
 // It may require modifications to work in your environment.
 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
NameDescription
parentString

Required. The parent resource of the conversation.

conversationConversation

Required. The conversation resource to create.

conversationIdString

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

createConversationCallable()

public final UnaryCallable<CreateConversationRequest,Conversation> createConversationCallable()

Creates a conversation.

Sample code:


 // This snippet has been automatically generated for illustrative purposes only.
 // It may require modifications to work in your environment.
 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
TypeDescription
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 for illustrative purposes only.
 // It may require modifications to work in your environment.
 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
NameDescription
requestCreateIssueModelRequest

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

Returns
TypeDescription
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 for illustrative purposes only.
 // It may require modifications to work in your environment.
 try (ContactCenterInsightsClient contactCenterInsightsClient =
     ContactCenterInsightsClient.create()) {
   LocationName parent = LocationName.of("[PROJECT]", "[LOCATION]");
   IssueModel issueModel = IssueModel.newBuilder().build();
   IssueModel response =
       contactCenterInsightsClient.createIssueModelAsync(parent, issueModel).get();
 }
 
Parameters
NameDescription
parentLocationName

Required. The parent resource of the issue model.

issueModelIssueModel

Required. The issue model to create.

Returns
TypeDescription
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 for illustrative purposes only.
 // It may require modifications to work in your environment.
 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
NameDescription
parentString

Required. The parent resource of the issue model.

issueModelIssueModel

Required. The issue model to create.

Returns
TypeDescription
OperationFuture<IssueModel,CreateIssueModelMetadata>

createIssueModelCallable()

public final UnaryCallable<CreateIssueModelRequest,Operation> createIssueModelCallable()

Creates an issue model.

Sample code:


 // This snippet has been automatically generated for illustrative purposes only.
 // It may require modifications to work in your environment.
 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
TypeDescription
UnaryCallable<CreateIssueModelRequest,Operation>

createIssueModelOperationCallable()

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

Creates an issue model.

Sample code:


 // This snippet has been automatically generated for illustrative purposes only.
 // It may require modifications to work in your environment.
 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
TypeDescription
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 for illustrative purposes only.
 // It may require modifications to work in your environment.
 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
NameDescription
requestCreatePhraseMatcherRequest

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

Returns
TypeDescription
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 for illustrative purposes only.
 // It may require modifications to work in your environment.
 try (ContactCenterInsightsClient contactCenterInsightsClient =
     ContactCenterInsightsClient.create()) {
   LocationName parent = LocationName.of("[PROJECT]", "[LOCATION]");
   PhraseMatcher phraseMatcher = PhraseMatcher.newBuilder().build();
   PhraseMatcher response =
       contactCenterInsightsClient.createPhraseMatcher(parent, phraseMatcher);
 }
 
Parameters
NameDescription
parentLocationName

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>

phraseMatcherPhraseMatcher

Required. The phrase matcher resource to create.

Returns
TypeDescription
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 for illustrative purposes only.
 // It may require modifications to work in your environment.
 try (ContactCenterInsightsClient contactCenterInsightsClient =
     ContactCenterInsightsClient.create()) {
   String parent = LocationName.of("[PROJECT]", "[LOCATION]").toString();
   PhraseMatcher phraseMatcher = PhraseMatcher.newBuilder().build();
   PhraseMatcher response =
       contactCenterInsightsClient.createPhraseMatcher(parent, phraseMatcher);
 }
 
Parameters
NameDescription
parentString

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>

phraseMatcherPhraseMatcher

Required. The phrase matcher resource to create.

Returns
TypeDescription
PhraseMatcher

createPhraseMatcherCallable()

public final UnaryCallable<CreatePhraseMatcherRequest,PhraseMatcher> createPhraseMatcherCallable()

Creates a phrase matcher.

Sample code:


 // This snippet has been automatically generated for illustrative purposes only.
 // It may require modifications to work in your environment.
 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
TypeDescription
UnaryCallable<CreatePhraseMatcherRequest,PhraseMatcher>

createView(CreateViewRequest request)

public final View createView(CreateViewRequest request)

Creates a view.

Sample code:


 // This snippet has been automatically generated for illustrative purposes only.
 // It may require modifications to work in your environment.
 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
NameDescription
requestCreateViewRequest

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

Returns
TypeDescription
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 for illustrative purposes only.
 // It may require modifications to work in your environment.
 try (ContactCenterInsightsClient contactCenterInsightsClient =
     ContactCenterInsightsClient.create()) {
   LocationName parent = LocationName.of("[PROJECT]", "[LOCATION]");
   View view = View.newBuilder().build();
   View response = contactCenterInsightsClient.createView(parent, view);
 }
 
Parameters
NameDescription
parentLocationName

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>

viewView

Required. The view resource to create.

Returns
TypeDescription
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 for illustrative purposes only.
 // It may require modifications to work in your environment.
 try (ContactCenterInsightsClient contactCenterInsightsClient =
     ContactCenterInsightsClient.create()) {
   String parent = LocationName.of("[PROJECT]", "[LOCATION]").toString();
   View view = View.newBuilder().build();
   View response = contactCenterInsightsClient.createView(parent, view);
 }
 
Parameters
NameDescription
parentString

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>

viewView

Required. The view resource to create.

Returns
TypeDescription
View

createViewCallable()

public final UnaryCallable<CreateViewRequest,View> createViewCallable()

Creates a view.

Sample code:


 // This snippet has been automatically generated for illustrative purposes only.
 // It may require modifications to work in your environment.
 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
TypeDescription
UnaryCallable<CreateViewRequest,View>

deleteAnalysis(AnalysisName name)

public final void deleteAnalysis(AnalysisName name)

Deletes an analysis.

Sample code:


 // This snippet has been automatically generated for illustrative purposes only.
 // It may require modifications to work in your environment.
 try (ContactCenterInsightsClient contactCenterInsightsClient =
     ContactCenterInsightsClient.create()) {
   AnalysisName name =
       AnalysisName.of("[PROJECT]", "[LOCATION]", "[CONVERSATION]", "[ANALYSIS]");
   contactCenterInsightsClient.deleteAnalysis(name);
 }
 
Parameter
NameDescription
nameAnalysisName

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 for illustrative purposes only.
 // It may require modifications to work in your environment.
 try (ContactCenterInsightsClient contactCenterInsightsClient =
     ContactCenterInsightsClient.create()) {
   DeleteAnalysisRequest request =
       DeleteAnalysisRequest.newBuilder()
           .setName(
               AnalysisName.of("[PROJECT]", "[LOCATION]", "[CONVERSATION]", "[ANALYSIS]")
                   .toString())
           .build();
   contactCenterInsightsClient.deleteAnalysis(request);
 }
 
Parameter
NameDescription
requestDeleteAnalysisRequest

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 for illustrative purposes only.
 // It may require modifications to work in your environment.
 try (ContactCenterInsightsClient contactCenterInsightsClient =
     ContactCenterInsightsClient.create()) {
   String name =
       AnalysisName.of("[PROJECT]", "[LOCATION]", "[CONVERSATION]", "[ANALYSIS]").toString();
   contactCenterInsightsClient.deleteAnalysis(name);
 }
 
Parameter
NameDescription
nameString

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 for illustrative purposes only.
 // It may require modifications to work in your environment.
 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
TypeDescription
UnaryCallable<DeleteAnalysisRequest,Empty>

deleteConversation(ConversationName name)

public final void deleteConversation(ConversationName name)

Deletes a conversation.

Sample code:


 // This snippet has been automatically generated for illustrative purposes only.
 // It may require modifications to work in your environment.
 try (ContactCenterInsightsClient contactCenterInsightsClient =
     ContactCenterInsightsClient.create()) {
   ConversationName name = ConversationName.of("[PROJECT]", "[LOCATION]", "[CONVERSATION]");
   contactCenterInsightsClient.deleteConversation(name);
 }
 
Parameter
NameDescription
nameConversationName

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 for illustrative purposes only.
 // It may require modifications to work in your environment.
 try (ContactCenterInsightsClient contactCenterInsightsClient =
     ContactCenterInsightsClient.create()) {
   DeleteConversationRequest request =
       DeleteConversationRequest.newBuilder()
           .setName(ConversationName.of("[PROJECT]", "[LOCATION]", "[CONVERSATION]").toString())
           .setForce(true)
           .build();
   contactCenterInsightsClient.deleteConversation(request);
 }
 
Parameter
NameDescription
requestDeleteConversationRequest

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 for illustrative purposes only.
 // It may require modifications to work in your environment.
 try (ContactCenterInsightsClient contactCenterInsightsClient =
     ContactCenterInsightsClient.create()) {
   String name = ConversationName.of("[PROJECT]", "[LOCATION]", "[CONVERSATION]").toString();
   contactCenterInsightsClient.deleteConversation(name);
 }
 
Parameter
NameDescription
nameString

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 for illustrative purposes only.
 // It may require modifications to work in your environment.
 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
TypeDescription
UnaryCallable<DeleteConversationRequest,Empty>

deleteIssueModelAsync(DeleteIssueModelRequest request)

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

Deletes an issue model.

Sample code:


 // This snippet has been automatically generated for illustrative purposes only.
 // It may require modifications to work in your environment.
 try (ContactCenterInsightsClient contactCenterInsightsClient =
     ContactCenterInsightsClient.create()) {
   DeleteIssueModelRequest request =
       DeleteIssueModelRequest.newBuilder()
           .setName(IssueModelName.of("[PROJECT]", "[LOCATION]", "[ISSUE_MODEL]").toString())
           .build();
   contactCenterInsightsClient.deleteIssueModelAsync(request).get();
 }
 
Parameter
NameDescription
requestDeleteIssueModelRequest

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

Returns
TypeDescription
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 for illustrative purposes only.
 // It may require modifications to work in your environment.
 try (ContactCenterInsightsClient contactCenterInsightsClient =
     ContactCenterInsightsClient.create()) {
   IssueModelName name = IssueModelName.of("[PROJECT]", "[LOCATION]", "[ISSUE_MODEL]");
   contactCenterInsightsClient.deleteIssueModelAsync(name).get();
 }
 
Parameter
NameDescription
nameIssueModelName

Required. The name of the issue model to delete.

Returns
TypeDescription
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 for illustrative purposes only.
 // It may require modifications to work in your environment.
 try (ContactCenterInsightsClient contactCenterInsightsClient =
     ContactCenterInsightsClient.create()) {
   String name = IssueModelName.of("[PROJECT]", "[LOCATION]", "[ISSUE_MODEL]").toString();
   contactCenterInsightsClient.deleteIssueModelAsync(name).get();
 }
 
Parameter
NameDescription
nameString

Required. The name of the issue model to delete.

Returns
TypeDescription
OperationFuture<Empty,DeleteIssueModelMetadata>

deleteIssueModelCallable()

public final UnaryCallable<DeleteIssueModelRequest,Operation> deleteIssueModelCallable()

Deletes an issue model.

Sample code:


 // This snippet has been automatically generated for illustrative purposes only.
 // It may require modifications to work in your environment.
 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
TypeDescription
UnaryCallable<DeleteIssueModelRequest,Operation>

deleteIssueModelOperationCallable()

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

Deletes an issue model.

Sample code:


 // This snippet has been automatically generated for illustrative purposes only.
 // It may require modifications to work in your environment.
 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
TypeDescription
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 for illustrative purposes only.
 // It may require modifications to work in your environment.
 try (ContactCenterInsightsClient contactCenterInsightsClient =
     ContactCenterInsightsClient.create()) {
   DeletePhraseMatcherRequest request =
       DeletePhraseMatcherRequest.newBuilder()
           .setName(
               PhraseMatcherName.of("[PROJECT]", "[LOCATION]", "[PHRASE_MATCHER]").toString())
           .build();
   contactCenterInsightsClient.deletePhraseMatcher(request);
 }
 
Parameter
NameDescription
requestDeletePhraseMatcherRequest

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

deletePhraseMatcher(PhraseMatcherName name)

public final void deletePhraseMatcher(PhraseMatcherName name)

Deletes a phrase matcher.

Sample code:


 // This snippet has been automatically generated for illustrative purposes only.
 // It may require modifications to work in your environment.
 try (ContactCenterInsightsClient contactCenterInsightsClient =
     ContactCenterInsightsClient.create()) {
   PhraseMatcherName name = PhraseMatcherName.of("[PROJECT]", "[LOCATION]", "[PHRASE_MATCHER]");
   contactCenterInsightsClient.deletePhraseMatcher(name);
 }
 
Parameter
NameDescription
namePhraseMatcherName

Required. The name of the phrase matcher to delete.

deletePhraseMatcher(String name)

public final void deletePhraseMatcher(String name)

Deletes a phrase matcher.

Sample code:


 // This snippet has been automatically generated for illustrative purposes only.
 // It may require modifications to work in your environment.
 try (ContactCenterInsightsClient contactCenterInsightsClient =
     ContactCenterInsightsClient.create()) {
   String name = PhraseMatcherName.of("[PROJECT]", "[LOCATION]", "[PHRASE_MATCHER]").toString();
   contactCenterInsightsClient.deletePhraseMatcher(name);
 }
 
Parameter
NameDescription
nameString

Required. The name of the phrase matcher to delete.

deletePhraseMatcherCallable()

public final UnaryCallable<DeletePhraseMatcherRequest,Empty> deletePhraseMatcherCallable()

Deletes a phrase matcher.

Sample code:


 // This snippet has been automatically generated for illustrative purposes only.
 // It may require modifications to work in your environment.
 try (ContactCenterInsightsClient contactCenterInsightsClient =
     ContactCenterInsightsClient.create()) {
   DeletePhraseMatcherRequest request =
       DeletePhraseMatcherRequest.newBuilder()
           .setName(
               PhraseMatcherName.of("[PROJECT]", "[LOCATION]", "[PHRASE_MATCHER]").toString())
           .build();
   ApiFuture<Empty> future =
       contactCenterInsightsClient.deletePhraseMatcherCallable().futureCall(request);
   // Do something.
   future.get();
 }
 
Returns
TypeDescription
UnaryCallable<DeletePhraseMatcherRequest,Empty>

deleteView(DeleteViewRequest request)

public final void deleteView(DeleteViewRequest request)

Deletes a view.

Sample code:


 // This snippet has been automatically generated for illustrative purposes only.
 // It may require modifications to work in your environment.
 try (ContactCenterInsightsClient contactCenterInsightsClient =
     ContactCenterInsightsClient.create()) {
   DeleteViewRequest request =
       DeleteViewRequest.newBuilder()
           .setName(ViewName.of("[PROJECT]", "[LOCATION]", "[VIEW]").toString())
           .build();
   contactCenterInsightsClient.deleteView(request);
 }
 
Parameter
NameDescription
requestDeleteViewRequest

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

deleteView(ViewName name)

public final void deleteView(ViewName name)

Deletes a view.

Sample code:


 // This snippet has been automatically generated for illustrative purposes only.
 // It may require modifications to work in your environment.
 try (ContactCenterInsightsClient contactCenterInsightsClient =
     ContactCenterInsightsClient.create()) {
   ViewName name = ViewName.of("[PROJECT]", "[LOCATION]", "[VIEW]");
   contactCenterInsightsClient.deleteView(name);
 }
 
Parameter
NameDescription
nameViewName

Required. The name of the view to delete.

deleteView(String name)

public final void deleteView(String name)

Deletes a view.

Sample code:


 // This snippet has been automatically generated for illustrative purposes only.
 // It may require modifications to work in your environment.
 try (ContactCenterInsightsClient contactCenterInsightsClient =
     ContactCenterInsightsClient.create()) {
   String name = ViewName.of("[PROJECT]", "[LOCATION]", "[VIEW]").toString();
   contactCenterInsightsClient.deleteView(name);
 }
 
Parameter
NameDescription
nameString

Required. The name of the view to delete.

deleteViewCallable()

public final UnaryCallable<DeleteViewRequest,Empty> deleteViewCallable()

Deletes a view.

Sample code:


 // This snippet has been automatically generated for illustrative purposes only.
 // It may require modifications to work in your environment.
 try (ContactCenterInsightsClient contactCenterInsightsClient =
     ContactCenterInsightsClient.create()) {
   DeleteViewRequest request =
       DeleteViewRequest.newBuilder()
           .setName(ViewName.of("[PROJECT]", "[LOCATION]", "[VIEW]").toString())
           .build();
   ApiFuture<Empty> future =
       contactCenterInsightsClient.deleteViewCallable().futureCall(request);
   // Do something.
   future.get();
 }
 
Returns
TypeDescription
UnaryCallable<DeleteViewRequest,Empty>

deployIssueModelAsync(DeployIssueModelRequest request)

public final OperationFuture<DeployIssueModelResponse,DeployIssueModelMetadata> deployIssueModelAsync(DeployIssueModelRequest request)

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.

Sample code:


 // This snippet has been automatically generated for illustrative purposes only.
 // It may require modifications to work in your environment.
 try (ContactCenterInsightsClient contactCenterInsightsClient =
     ContactCenterInsightsClient.create()) {
   DeployIssueModelRequest request =
       DeployIssueModelRequest.newBuilder()
           .setName(IssueModelName.of("[PROJECT]", "[LOCATION]", "[ISSUE_MODEL]").toString())
           .build();
   DeployIssueModelResponse response =
       contactCenterInsightsClient.deployIssueModelAsync(request).get();
 }
 
Parameter
NameDescription
requestDeployIssueModelRequest

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

Returns
TypeDescription
OperationFuture<DeployIssueModelResponse,DeployIssueModelMetadata>

deployIssueModelAsync(IssueModelName name)

public final OperationFuture<DeployIssueModelResponse,DeployIssueModelMetadata> deployIssueModelAsync(IssueModelName name)

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.

Sample code:


 // This snippet has been automatically generated for illustrative purposes only.
 // It may require modifications to work in your environment.
 try (ContactCenterInsightsClient contactCenterInsightsClient =
     ContactCenterInsightsClient.create()) {
   IssueModelName name = IssueModelName.of("[PROJECT]", "[LOCATION]", "[ISSUE_MODEL]");
   DeployIssueModelResponse response =
       contactCenterInsightsClient.deployIssueModelAsync(name).get();
 }
 
Parameter
NameDescription
nameIssueModelName

Required. The issue model to deploy.

Returns
TypeDescription
OperationFuture<DeployIssueModelResponse,DeployIssueModelMetadata>

deployIssueModelAsync(String name)

public final OperationFuture<DeployIssueModelResponse,DeployIssueModelMetadata> deployIssueModelAsync(String name)

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.

Sample code:


 // This snippet has been automatically generated for illustrative purposes only.
 // It may require modifications to work in your environment.
 try (ContactCenterInsightsClient contactCenterInsightsClient =
     ContactCenterInsightsClient.create()) {
   String name = IssueModelName.of("[PROJECT]", "[LOCATION]", "[ISSUE_MODEL]").toString();
   DeployIssueModelResponse response =
       contactCenterInsightsClient.deployIssueModelAsync(name).get();
 }
 
Parameter
NameDescription
nameString

Required. The issue model to deploy.

Returns
TypeDescription
OperationFuture<DeployIssueModelResponse,DeployIssueModelMetadata>

deployIssueModelCallable()

public final UnaryCallable<DeployIssueModelRequest,Operation> deployIssueModelCallable()

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.

Sample code:


 // This snippet has been automatically generated for illustrative purposes only.
 // It may require modifications to work in your environment.
 try (ContactCenterInsightsClient contactCenterInsightsClient =
     ContactCenterInsightsClient.create()) {
   DeployIssueModelRequest request =
       DeployIssueModelRequest.newBuilder()
           .setName(IssueModelName.of("[PROJECT]", "[LOCATION]", "[ISSUE_MODEL]").toString())
           .build();
   ApiFuture<Operation> future =
       contactCenterInsightsClient.deployIssueModelCallable().futureCall(request);
   // Do something.
   Operation response = future.get();
 }
 
Returns
TypeDescription
UnaryCallable<DeployIssueModelRequest,Operation>

deployIssueModelOperationCallable()

public final OperationCallable<DeployIssueModelRequest,DeployIssueModelResponse,DeployIssueModelMetadata> deployIssueModelOperationCallable()

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.

Sample code:


 // This snippet has been automatically generated for illustrative purposes only.
 // It may require modifications to work in your environment.
 try (ContactCenterInsightsClient contactCenterInsightsClient =
     ContactCenterInsightsClient.create()) {
   DeployIssueModelRequest request =
       DeployIssueModelRequest.newBuilder()
           .setName(IssueModelName.of("[PROJECT]", "[LOCATION]", "[ISSUE_MODEL]").toString())
           .build();
   OperationFuture<DeployIssueModelResponse, DeployIssueModelMetadata> future =
       contactCenterInsightsClient.deployIssueModelOperationCallable().futureCall(request);
   // Do something.
   DeployIssueModelResponse response = future.get();
 }
 
Returns
TypeDescription
OperationCallable<DeployIssueModelRequest,DeployIssueModelResponse,DeployIssueModelMetadata>

exportInsightsDataAsync(ExportInsightsDataRequest request)

public final OperationFuture<ExportInsightsDataResponse,ExportInsightsDataMetadata> exportInsightsDataAsync(ExportInsightsDataRequest request)

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

Sample code:


 // This snippet has been automatically generated for illustrative purposes only.
 // It may require modifications to work in your environment.
 try (ContactCenterInsightsClient contactCenterInsightsClient =
     ContactCenterInsightsClient.create()) {
   ExportInsightsDataRequest request =
       ExportInsightsDataRequest.newBuilder()
           .setParent(LocationName.of("[PROJECT]", "[LOCATION]").toString())
           .setFilter("filter-1274492040")
           .setKmsKey("kmsKey-1127483058")
           .build();
   ExportInsightsDataResponse response =
       contactCenterInsightsClient.exportInsightsDataAsync(request).get();
 }
 
Parameter
NameDescription
requestExportInsightsDataRequest

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

Returns
TypeDescription
OperationFuture<ExportInsightsDataResponse,ExportInsightsDataMetadata>

exportInsightsDataAsync(LocationName parent)

public final OperationFuture<ExportInsightsDataResponse,ExportInsightsDataMetadata> exportInsightsDataAsync(LocationName parent)

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

Sample code:


 // This snippet has been automatically generated for illustrative purposes only.
 // It may require modifications to work in your environment.
 try (ContactCenterInsightsClient contactCenterInsightsClient =
     ContactCenterInsightsClient.create()) {
   LocationName parent = LocationName.of("[PROJECT]", "[LOCATION]");
   ExportInsightsDataResponse response =
       contactCenterInsightsClient.exportInsightsDataAsync(parent).get();
 }
 
Parameter
NameDescription
parentLocationName

Required. The parent resource to export data from.

Returns
TypeDescription
OperationFuture<ExportInsightsDataResponse,ExportInsightsDataMetadata>

exportInsightsDataAsync(String parent)

public final OperationFuture<ExportInsightsDataResponse,ExportInsightsDataMetadata> exportInsightsDataAsync(String parent)

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

Sample code:


 // This snippet has been automatically generated for illustrative purposes only.
 // It may require modifications to work in your environment.
 try (ContactCenterInsightsClient contactCenterInsightsClient =
     ContactCenterInsightsClient.create()) {
   String parent = LocationName.of("[PROJECT]", "[LOCATION]").toString();
   ExportInsightsDataResponse response =
       contactCenterInsightsClient.exportInsightsDataAsync(parent).get();
 }
 
Parameter
NameDescription
parentString

Required. The parent resource to export data from.

Returns
TypeDescription
OperationFuture<ExportInsightsDataResponse,ExportInsightsDataMetadata>

exportInsightsDataCallable()

public final UnaryCallable<ExportInsightsDataRequest,Operation> exportInsightsDataCallable()

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

Sample code:


 // This snippet has been automatically generated for illustrative purposes only.
 // It may require modifications to work in your environment.
 try (ContactCenterInsightsClient contactCenterInsightsClient =
     ContactCenterInsightsClient.create()) {
   ExportInsightsDataRequest request =
       ExportInsightsDataRequest.newBuilder()
           .setParent(LocationName.of("[PROJECT]", "[LOCATION]").toString())
           .setFilter("filter-1274492040")
           .setKmsKey("kmsKey-1127483058")
           .build();
   ApiFuture<Operation> future =
       contactCenterInsightsClient.exportInsightsDataCallable().futureCall(request);
   // Do something.
   Operation response = future.get();
 }
 
Returns
TypeDescription
UnaryCallable<ExportInsightsDataRequest,Operation>

exportInsightsDataOperationCallable()

public final OperationCallable<ExportInsightsDataRequest,ExportInsightsDataResponse,ExportInsightsDataMetadata> exportInsightsDataOperationCallable()

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

Sample code:


 // This snippet has been automatically generated for illustrative purposes only.
 // It may require modifications to work in your environment.
 try (ContactCenterInsightsClient contactCenterInsightsClient =
     ContactCenterInsightsClient.create()) {
   ExportInsightsDataRequest request =
       ExportInsightsDataRequest.newBuilder()
           .setParent(LocationName.of("[PROJECT]", "[LOCATION]").toString())
           .setFilter("filter-1274492040")
           .setKmsKey("kmsKey-1127483058")
           .build();
   OperationFuture<ExportInsightsDataResponse, ExportInsightsDataMetadata> future =
       contactCenterInsightsClient.exportInsightsDataOperationCallable().futureCall(request);
   // Do something.
   ExportInsightsDataResponse response = future.get();
 }
 
Returns
TypeDescription
OperationCallable<ExportInsightsDataRequest,ExportInsightsDataResponse,ExportInsightsDataMetadata>

getAnalysis(AnalysisName name)

public final Analysis getAnalysis(AnalysisName name)

Gets an analysis.

Sample code:


 // This snippet has been automatically generated for illustrative purposes only.
 // It may require modifications to work in your environment.
 try (ContactCenterInsightsClient contactCenterInsightsClient =
     ContactCenterInsightsClient.create()) {
   AnalysisName name =
       AnalysisName.of("[PROJECT]", "[LOCATION]", "[CONVERSATION]", "[ANALYSIS]");
   Analysis response = contactCenterInsightsClient.getAnalysis(name);
 }
 
Parameter
NameDescription
nameAnalysisName

Required. The name of the analysis to get.

Returns
TypeDescription
Analysis

getAnalysis(GetAnalysisRequest request)

public final Analysis getAnalysis(GetAnalysisRequest request)

Gets an analysis.

Sample code:


 // This snippet has been automatically generated for illustrative purposes only.
 // It may require modifications to work in your environment.
 try (ContactCenterInsightsClient contactCenterInsightsClient =
     ContactCenterInsightsClient.create()) {
   GetAnalysisRequest request =
       GetAnalysisRequest.newBuilder()
           .setName(
               AnalysisName.of("[PROJECT]", "[LOCATION]", "[CONVERSATION]", "[ANALYSIS]")
                   .toString())
           .build();
   Analysis response = contactCenterInsightsClient.getAnalysis(request);
 }
 
Parameter
NameDescription
requestGetAnalysisRequest

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

Returns
TypeDescription
Analysis

getAnalysis(String name)

public final Analysis getAnalysis(String name)

Gets an analysis.

Sample code:


 // This snippet has been automatically generated for illustrative purposes only.
 // It may require modifications to work in your environment.
 try (ContactCenterInsightsClient contactCenterInsightsClient =
     ContactCenterInsightsClient.create()) {
   String name =
       AnalysisName.of("[PROJECT]", "[LOCATION]", "[CONVERSATION]", "[ANALYSIS]").toString();
   Analysis response = contactCenterInsightsClient.getAnalysis(name);
 }
 
Parameter
NameDescription
nameString

Required. The name of the analysis to get.

Returns
TypeDescription
Analysis

getAnalysisCallable()

public final UnaryCallable<GetAnalysisRequest,Analysis> getAnalysisCallable()

Gets an analysis.

Sample code:


 // This snippet has been automatically generated for illustrative purposes only.
 // It may require modifications to work in your environment.
 try (ContactCenterInsightsClient contactCenterInsightsClient =
     ContactCenterInsightsClient.create()) {
   GetAnalysisRequest request =
       GetAnalysisRequest.newBuilder()
           .setName(
               AnalysisName.of("[PROJECT]", "[LOCATION]", "[CONVERSATION]", "[ANALYSIS]")
                   .toString())
           .build();
   ApiFuture<Analysis> future =
       contactCenterInsightsClient.getAnalysisCallable().futureCall(request);
   // Do something.
   Analysis response = future.get();
 }
 
Returns
TypeDescription
UnaryCallable<GetAnalysisRequest,Analysis>

getConversation(ConversationName name)

public final Conversation getConversation(ConversationName name)

Gets a conversation.

Sample code:


 // This snippet has been automatically generated for illustrative purposes only.
 // It may require modifications to work in your environment.
 try (ContactCenterInsightsClient contactCenterInsightsClient =
     ContactCenterInsightsClient.create()) {
   ConversationName name = ConversationName.of("[PROJECT]", "[LOCATION]", "[CONVERSATION]");
   Conversation response = contactCenterInsightsClient.getConversation(name);
 }
 
Parameter
NameDescription
nameConversationName

Required. The name of the conversation to get.

Returns
TypeDescription
Conversation

getConversation(GetConversationRequest request)

public final Conversation getConversation(GetConversationRequest request)

Gets a conversation.

Sample code:


 // This snippet has been automatically generated for illustrative purposes only.
 // It may require modifications to work in your environment.
 try (ContactCenterInsightsClient contactCenterInsightsClient =
     ContactCenterInsightsClient.create()) {
   GetConversationRequest request =
       GetConversationRequest.newBuilder()
           .setName(ConversationName.of("[PROJECT]", "[LOCATION]", "[CONVERSATION]").toString())
           .setView(ConversationView.forNumber(0))
           .build();
   Conversation response = contactCenterInsightsClient.getConversation(request);
 }
 
Parameter
NameDescription
requestGetConversationRequest

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

Returns
TypeDescription
Conversation

getConversation(String name)

public final Conversation getConversation(String name)

Gets a conversation.

Sample code:


 // This snippet has been automatically generated for illustrative purposes only.
 // It may require modifications to work in your environment.
 try (ContactCenterInsightsClient contactCenterInsightsClient =
     ContactCenterInsightsClient.create()) {
   String name = ConversationName.of("[PROJECT]", "[LOCATION]", "[CONVERSATION]").toString();
   Conversation response = contactCenterInsightsClient.getConversation(name);
 }
 
Parameter
NameDescription
nameString

Required. The name of the conversation to get.

Returns
TypeDescription
Conversation

getConversationCallable()

public final UnaryCallable<GetConversationRequest,Conversation> getConversationCallable()

Gets a conversation.

Sample code:


 // This snippet has been automatically generated for illustrative purposes only.
 // It may require modifications to work in your environment.
 try (ContactCenterInsightsClient contactCenterInsightsClient =
     ContactCenterInsightsClient.create()) {
   GetConversationRequest request =
       GetConversationRequest.newBuilder()
           .setName(ConversationName.of("[PROJECT]", "[LOCATION]", "[CONVERSATION]").toString())
           .setView(ConversationView.forNumber(0))
           .build();
   ApiFuture<Conversation> future =
       contactCenterInsightsClient.getConversationCallable().futureCall(request);
   // Do something.
   Conversation response = future.get();
 }
 
Returns
TypeDescription
UnaryCallable<GetConversationRequest,Conversation>

getIssue(GetIssueRequest request)

public final Issue getIssue(GetIssueRequest request)

Gets an issue.

Sample code:


 // This snippet has been automatically generated for illustrative purposes only.
 // It may require modifications to work in your environment.
 try (ContactCenterInsightsClient contactCenterInsightsClient =
     ContactCenterInsightsClient.create()) {
   GetIssueRequest request =
       GetIssueRequest.newBuilder()
           .setName(
               IssueName.of("[PROJECT]", "[LOCATION]", "[ISSUE_MODEL]", "[ISSUE]").toString())
           .build();
   Issue response = contactCenterInsightsClient.getIssue(request);
 }
 
Parameter
NameDescription
requestGetIssueRequest

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

Returns
TypeDescription
Issue

getIssue(IssueName name)

public final Issue getIssue(IssueName name)

Gets an issue.

Sample code:


 // This snippet has been automatically generated for illustrative purposes only.
 // It may require modifications to work in your environment.
 try (ContactCenterInsightsClient contactCenterInsightsClient =
     ContactCenterInsightsClient.create()) {
   IssueName name = IssueName.of("[PROJECT]", "[LOCATION]", "[ISSUE_MODEL]", "[ISSUE]");
   Issue response = contactCenterInsightsClient.getIssue(name);
 }
 
Parameter
NameDescription
nameIssueName

Required. The name of the issue to get.

Returns
TypeDescription
Issue

getIssue(String name)

public final Issue getIssue(String name)

Gets an issue.

Sample code:


 // This snippet has been automatically generated for illustrative purposes only.
 // It may require modifications to work in your environment.
 try (ContactCenterInsightsClient contactCenterInsightsClient =
     ContactCenterInsightsClient.create()) {
   String name = IssueName.of("[PROJECT]", "[LOCATION]", "[ISSUE_MODEL]", "[ISSUE]").toString();
   Issue response = contactCenterInsightsClient.getIssue(name);
 }
 
Parameter
NameDescription
nameString

Required. The name of the issue to get.

Returns
TypeDescription
Issue

getIssueCallable()

public final UnaryCallable<GetIssueRequest,Issue> getIssueCallable()

Gets an issue.

Sample code:


 // This snippet has been automatically generated for illustrative purposes only.
 // It may require modifications to work in your environment.
 try (ContactCenterInsightsClient contactCenterInsightsClient =
     ContactCenterInsightsClient.create()) {
   GetIssueRequest request =
       GetIssueRequest.newBuilder()
           .setName(
               IssueName.of("[PROJECT]", "[LOCATION]", "[ISSUE_MODEL]", "[ISSUE]").toString())
           .build();
   ApiFuture<Issue> future = contactCenterInsightsClient.getIssueCallable().futureCall(request);
   // Do something.
   Issue response = future.get();
 }
 
Returns
TypeDescription
UnaryCallable<GetIssueRequest,Issue>

getIssueModel(GetIssueModelRequest request)

public final IssueModel getIssueModel(GetIssueModelRequest request)

Gets an issue model.

Sample code:


 // This snippet has been automatically generated for illustrative purposes only.
 // It may require modifications to work in your environment.
 try (ContactCenterInsightsClient contactCenterInsightsClient =
     ContactCenterInsightsClient.create()) {
   GetIssueModelRequest request =
       GetIssueModelRequest.newBuilder()
           .setName(IssueModelName.of("[PROJECT]", "[LOCATION]", "[ISSUE_MODEL]").toString())
           .build();
   IssueModel response = contactCenterInsightsClient.getIssueModel(request);
 }
 
Parameter
NameDescription
requestGetIssueModelRequest

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

Returns
TypeDescription
IssueModel

getIssueModel(IssueModelName name)

public final IssueModel getIssueModel(IssueModelName name)

Gets an issue model.

Sample code:


 // This snippet has been automatically generated for illustrative purposes only.
 // It may require modifications to work in your environment.
 try (ContactCenterInsightsClient contactCenterInsightsClient =
     ContactCenterInsightsClient.create()) {
   IssueModelName name = IssueModelName.of("[PROJECT]", "[LOCATION]", "[ISSUE_MODEL]");
   IssueModel response = contactCenterInsightsClient.getIssueModel(name);
 }
 
Parameter
NameDescription
nameIssueModelName

Required. The name of the issue model to get.

Returns
TypeDescription
IssueModel

getIssueModel(String name)

public final IssueModel getIssueModel(String name)

Gets an issue model.

Sample code:


 // This snippet has been automatically generated for illustrative purposes only.
 // It may require modifications to work in your environment.
 try (ContactCenterInsightsClient contactCenterInsightsClient =
     ContactCenterInsightsClient.create()) {
   String name = IssueModelName.of("[PROJECT]", "[LOCATION]", "[ISSUE_MODEL]").toString();
   IssueModel response = contactCenterInsightsClient.getIssueModel(name);
 }
 
Parameter
NameDescription
nameString

Required. The name of the issue model to get.

Returns
TypeDescription
IssueModel

getIssueModelCallable()

public final UnaryCallable<GetIssueModelRequest,IssueModel> getIssueModelCallable()

Gets an issue model.

Sample code:


 // This snippet has been automatically generated for illustrative purposes only.
 // It may require modifications to work in your environment.
 try (ContactCenterInsightsClient contactCenterInsightsClient =
     ContactCenterInsightsClient.create()) {
   GetIssueModelRequest request =
       GetIssueModelRequest.newBuilder()
           .setName(IssueModelName.of("[PROJECT]", "[LOCATION]", "[ISSUE_MODEL]").toString())
           .build();
   ApiFuture<IssueModel> future =
       contactCenterInsightsClient.getIssueModelCallable().futureCall(request);
   // Do something.
   IssueModel response = future.get();
 }
 
Returns
TypeDescription
UnaryCallable<GetIssueModelRequest,IssueModel>

getOperationsClient()

public final OperationsClient getOperationsClient()

Returns the OperationsClient that can be used to query the status of a long-running operation returned by another API method call.

Returns
TypeDescription
OperationsClient

getPhraseMatcher(GetPhraseMatcherRequest request)

public final PhraseMatcher getPhraseMatcher(GetPhraseMatcherRequest request)

Gets a phrase matcher.

Sample code:


 // This snippet has been automatically generated for illustrative purposes only.
 // It may require modifications to work in your environment.
 try (ContactCenterInsightsClient contactCenterInsightsClient =
     ContactCenterInsightsClient.create()) {
   GetPhraseMatcherRequest request =
       GetPhraseMatcherRequest.newBuilder()
           .setName(
               PhraseMatcherName.of("[PROJECT]", "[LOCATION]", "[PHRASE_MATCHER]").toString())
           .build();
   PhraseMatcher response = contactCenterInsightsClient.getPhraseMatcher(request);
 }
 
Parameter
NameDescription
requestGetPhraseMatcherRequest

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

Returns
TypeDescription
PhraseMatcher

getPhraseMatcher(PhraseMatcherName name)

public final PhraseMatcher getPhraseMatcher(PhraseMatcherName name)

Gets a phrase matcher.

Sample code:


 // This snippet has been automatically generated for illustrative purposes only.
 // It may require modifications to work in your environment.
 try (ContactCenterInsightsClient contactCenterInsightsClient =
     ContactCenterInsightsClient.create()) {
   PhraseMatcherName name = PhraseMatcherName.of("[PROJECT]", "[LOCATION]", "[PHRASE_MATCHER]");
   PhraseMatcher response = contactCenterInsightsClient.getPhraseMatcher(name);
 }
 
Parameter
NameDescription
namePhraseMatcherName

Required. The name of the phrase matcher to get.

Returns
TypeDescription
PhraseMatcher

getPhraseMatcher(String name)

public final PhraseMatcher getPhraseMatcher(String name)

Gets a phrase matcher.

Sample code:


 // This snippet has been automatically generated for illustrative purposes only.
 // It may require modifications to work in your environment.
 try (ContactCenterInsightsClient contactCenterInsightsClient =
     ContactCenterInsightsClient.create()) {
   String name = PhraseMatcherName.of("[PROJECT]", "[LOCATION]", "[PHRASE_MATCHER]").toString();
   PhraseMatcher response = contactCenterInsightsClient.getPhraseMatcher(name);
 }
 
Parameter
NameDescription
nameString

Required. The name of the phrase matcher to get.

Returns
TypeDescription
PhraseMatcher

getPhraseMatcherCallable()

public final UnaryCallable<GetPhraseMatcherRequest,PhraseMatcher> getPhraseMatcherCallable()

Gets a phrase matcher.

Sample code:


 // This snippet has been automatically generated for illustrative purposes only.
 // It may require modifications to work in your environment.
 try (ContactCenterInsightsClient contactCenterInsightsClient =
     ContactCenterInsightsClient.create()) {
   GetPhraseMatcherRequest request =
       GetPhraseMatcherRequest.newBuilder()
           .setName(
               PhraseMatcherName.of("[PROJECT]", "[LOCATION]", "[PHRASE_MATCHER]").toString())
           .build();
   ApiFuture<PhraseMatcher> future =
       contactCenterInsightsClient.getPhraseMatcherCallable().futureCall(request);
   // Do something.
   PhraseMatcher response = future.get();
 }
 
Returns
TypeDescription
UnaryCallable<GetPhraseMatcherRequest,PhraseMatcher>

getSettings()

public final ContactCenterInsightsSettings getSettings()
Returns
TypeDescription
ContactCenterInsightsSettings

getSettings(GetSettingsRequest request)

public final Settings getSettings(GetSettingsRequest request)

Gets project-level settings.

Sample code:


 // This snippet has been automatically generated for illustrative purposes only.
 // It may require modifications to work in your environment.
 try (ContactCenterInsightsClient contactCenterInsightsClient =
     ContactCenterInsightsClient.create()) {
   GetSettingsRequest request =
       GetSettingsRequest.newBuilder()
           .setName(SettingsName.of("[PROJECT]", "[LOCATION]").toString())
           .build();
   Settings response = contactCenterInsightsClient.getSettings(request);
 }
 
Parameter
NameDescription
requestGetSettingsRequest

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

Returns
TypeDescription
Settings

getSettings(SettingsName name)

public final Settings getSettings(SettingsName name)

Gets project-level settings.

Sample code:


 // This snippet has been automatically generated for illustrative purposes only.
 // It may require modifications to work in your environment.
 try (ContactCenterInsightsClient contactCenterInsightsClient =
     ContactCenterInsightsClient.create()) {
   SettingsName name = SettingsName.of("[PROJECT]", "[LOCATION]");
   Settings response = contactCenterInsightsClient.getSettings(name);
 }
 
Parameter
NameDescription
nameSettingsName

Required. The name of the settings resource to get.

Returns
TypeDescription
Settings

getSettings(String name)

public final Settings getSettings(String name)

Gets project-level settings.

Sample code:


 // This snippet has been automatically generated for illustrative purposes only.
 // It may require modifications to work in your environment.
 try (ContactCenterInsightsClient contactCenterInsightsClient =
     ContactCenterInsightsClient.create()) {
   String name = SettingsName.of("[PROJECT]", "[LOCATION]").toString();
   Settings response = contactCenterInsightsClient.getSettings(name);
 }
 
Parameter
NameDescription
nameString

Required. The name of the settings resource to get.

Returns
TypeDescription
Settings

getSettingsCallable()

public final UnaryCallable<GetSettingsRequest,Settings> getSettingsCallable()

Gets project-level settings.

Sample code:


 // This snippet has been automatically generated for illustrative purposes only.
 // It may require modifications to work in your environment.
 try (ContactCenterInsightsClient contactCenterInsightsClient =
     ContactCenterInsightsClient.create()) {
   GetSettingsRequest request =
       GetSettingsRequest.newBuilder()
           .setName(SettingsName.of("[PROJECT]", "[LOCATION]").toString())
           .build();
   ApiFuture<Settings> future =
       contactCenterInsightsClient.getSettingsCallable().futureCall(request);
   // Do something.
   Settings response = future.get();
 }
 
Returns
TypeDescription
UnaryCallable<GetSettingsRequest,Settings>

getStub()

public ContactCenterInsightsStub getStub()
Returns
TypeDescription
ContactCenterInsightsStub

getView(GetViewRequest request)

public final View getView(GetViewRequest request)

Gets a view.

Sample code:


 // This snippet has been automatically generated for illustrative purposes only.
 // It may require modifications to work in your environment.
 try (ContactCenterInsightsClient contactCenterInsightsClient =
     ContactCenterInsightsClient.create()) {
   GetViewRequest request =
       GetViewRequest.newBuilder()
           .setName(ViewName.of("[PROJECT]", "[LOCATION]", "[VIEW]").toString())
           .build();
   View response = contactCenterInsightsClient.getView(request);
 }
 
Parameter
NameDescription
requestGetViewRequest

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

Returns
TypeDescription
View

getView(ViewName name)

public final View getView(ViewName name)

Gets a view.

Sample code:


 // This snippet has been automatically generated for illustrative purposes only.
 // It may require modifications to work in your environment.
 try (ContactCenterInsightsClient contactCenterInsightsClient =
     ContactCenterInsightsClient.create()) {
   ViewName name = ViewName.of("[PROJECT]", "[LOCATION]", "[VIEW]");
   View response = contactCenterInsightsClient.getView(name);
 }
 
Parameter
NameDescription
nameViewName

Required. The name of the view to get.

Returns
TypeDescription
View

getView(String name)

public final View getView(String name)

Gets a view.

Sample code:


 // This snippet has been automatically generated for illustrative purposes only.
 // It may require modifications to work in your environment.
 try (ContactCenterInsightsClient contactCenterInsightsClient =
     ContactCenterInsightsClient.create()) {
   String name = ViewName.of("[PROJECT]", "[LOCATION]", "[VIEW]").toString();
   View response = contactCenterInsightsClient.getView(name);
 }
 
Parameter
NameDescription
nameString

Required. The name of the view to get.

Returns
TypeDescription
View

getViewCallable()

public final UnaryCallable<GetViewRequest,View> getViewCallable()

Gets a view.

Sample code:


 // This snippet has been automatically generated for illustrative purposes only.
 // It may require modifications to work in your environment.
 try (ContactCenterInsightsClient contactCenterInsightsClient =
     ContactCenterInsightsClient.create()) {
   GetViewRequest request =
       GetViewRequest.newBuilder()
           .setName(ViewName.of("[PROJECT]", "[LOCATION]", "[VIEW]").toString())
           .build();
   ApiFuture<View> future = contactCenterInsightsClient.getViewCallable().futureCall(request);
   // Do something.
   View response = future.get();
 }
 
Returns
TypeDescription
UnaryCallable<GetViewRequest,View>

isShutdown()

public boolean isShutdown()
Returns
TypeDescription
boolean

isTerminated()

public boolean isTerminated()
Returns
TypeDescription
boolean

listAnalyses(ConversationName parent)

public final ContactCenterInsightsClient.ListAnalysesPagedResponse listAnalyses(ConversationName parent)

Lists analyses.

Sample code:


 // This snippet has been automatically generated for illustrative purposes only.
 // It may require modifications to work in your environment.
 try (ContactCenterInsightsClient contactCenterInsightsClient =
     ContactCenterInsightsClient.create()) {
   ConversationName parent = ConversationName.of("[PROJECT]", "[LOCATION]", "[CONVERSATION]");
   for (Analysis element : contactCenterInsightsClient.listAnalyses(parent).iterateAll()) {
     // doThingsWith(element);
   }
 }
 
Parameter
NameDescription
parentConversationName

Required. The parent resource of the analyses.

Returns
TypeDescription
ContactCenterInsightsClient.ListAnalysesPagedResponse

listAnalyses(ListAnalysesRequest request)

public final ContactCenterInsightsClient.ListAnalysesPagedResponse listAnalyses(ListAnalysesRequest request)

Lists analyses.

Sample code:


 // This snippet has been automatically generated for illustrative purposes only.
 // It may require modifications to work in your environment.
 try (ContactCenterInsightsClient contactCenterInsightsClient =
     ContactCenterInsightsClient.create()) {
   ListAnalysesRequest request =
       ListAnalysesRequest.newBuilder()
           .setParent(
               ConversationName.of("[PROJECT]", "[LOCATION]", "[CONVERSATION]").toString())
           .setPageSize(883849137)
           .setPageToken("pageToken873572522")
           .setFilter("filter-1274492040")
           .build();
   for (Analysis element : contactCenterInsightsClient.listAnalyses(request).iterateAll()) {
     // doThingsWith(element);
   }
 }
 
Parameter
NameDescription
requestListAnalysesRequest

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

Returns
TypeDescription
ContactCenterInsightsClient.ListAnalysesPagedResponse

listAnalyses(String parent)

public final ContactCenterInsightsClient.ListAnalysesPagedResponse listAnalyses(String parent)

Lists analyses.

Sample code:


 // This snippet has been automatically generated for illustrative purposes only.
 // It may require modifications to work in your environment.
 try (ContactCenterInsightsClient contactCenterInsightsClient =
     ContactCenterInsightsClient.create()) {
   String parent = ConversationName.of("[PROJECT]", "[LOCATION]", "[CONVERSATION]").toString();
   for (Analysis element : contactCenterInsightsClient.listAnalyses(parent).iterateAll()) {
     // doThingsWith(element);
   }
 }
 
Parameter
NameDescription
parentString

Required. The parent resource of the analyses.

Returns
TypeDescription
ContactCenterInsightsClient.ListAnalysesPagedResponse

listAnalysesCallable()

public final UnaryCallable<ListAnalysesRequest,ListAnalysesResponse> listAnalysesCallable()

Lists analyses.

Sample code:


 // This snippet has been automatically generated for illustrative purposes only.
 // It may require modifications to work in your environment.
 try (ContactCenterInsightsClient contactCenterInsightsClient =
     ContactCenterInsightsClient.create()) {
   ListAnalysesRequest request =
       ListAnalysesRequest.newBuilder()
           .setParent(
               ConversationName.of("[PROJECT]", "[LOCATION]", "[CONVERSATION]").toString())
           .setPageSize(883849137)
           .setPageToken("pageToken873572522")
           .setFilter("filter-1274492040")
           .build();
   while (true) {
     ListAnalysesResponse response =
         contactCenterInsightsClient.listAnalysesCallable().call(request);
     for (Analysis element : response.getResponsesList()) {
       // doThingsWith(element);
     }
     String nextPageToken = response.getNextPageToken();
     if (!Strings.isNullOrEmpty(nextPageToken)) {
       request = request.toBuilder().setPageToken(nextPageToken).build();
     } else {
       break;
     }
   }
 }
 
Returns
TypeDescription
UnaryCallable<ListAnalysesRequest,ListAnalysesResponse>

listAnalysesPagedCallable()

public final UnaryCallable<ListAnalysesRequest,ContactCenterInsightsClient.ListAnalysesPagedResponse> listAnalysesPagedCallable()

Lists analyses.

Sample code:


 // This snippet has been automatically generated for illustrative purposes only.
 // It may require modifications to work in your environment.
 try (ContactCenterInsightsClient contactCenterInsightsClient =
     ContactCenterInsightsClient.create()) {
   ListAnalysesRequest request =
       ListAnalysesRequest.newBuilder()
           .setParent(
               ConversationName.of("[PROJECT]", "[LOCATION]", "[CONVERSATION]").toString())
           .setPageSize(883849137)
           .setPageToken("pageToken873572522")
           .setFilter("filter-1274492040")
           .build();
   ApiFuture<Analysis> future =
       contactCenterInsightsClient.listAnalysesPagedCallable().futureCall(request);
   // Do something.
   for (Analysis element : future.get().iterateAll()) {
     // doThingsWith(element);
   }
 }
 
Returns
TypeDescription
UnaryCallable<ListAnalysesRequest,ListAnalysesPagedResponse>

listConversations(ListConversationsRequest request)

public final ContactCenterInsightsClient.ListConversationsPagedResponse listConversations(ListConversationsRequest request)

Lists conversations.

Sample code:


 // This snippet has been automatically generated for illustrative purposes only.
 // It may require modifications to work in your environment.
 try (ContactCenterInsightsClient contactCenterInsightsClient =
     ContactCenterInsightsClient.create()) {
   ListConversationsRequest request =
       ListConversationsRequest.newBuilder()
           .setParent(LocationName.of("[PROJECT]", "[LOCATION]").toString())
           .setPageSize(883849137)
           .setPageToken("pageToken873572522")
           .setFilter("filter-1274492040")
           .setView(ConversationView.forNumber(0))
           .build();
   for (Conversation element :
       contactCenterInsightsClient.listConversations(request).iterateAll()) {
     // doThingsWith(element);
   }
 }
 
Parameter
NameDescription
requestListConversationsRequest

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

Returns
TypeDescription
ContactCenterInsightsClient.ListConversationsPagedResponse

listConversations(LocationName parent)

public final ContactCenterInsightsClient.ListConversationsPagedResponse listConversations(LocationName parent)

Lists conversations.

Sample code:


 // This snippet has been automatically generated for illustrative purposes only.
 // It may require modifications to work in your environment.
 try (ContactCenterInsightsClient contactCenterInsightsClient =
     ContactCenterInsightsClient.create()) {
   LocationName parent = LocationName.of("[PROJECT]", "[LOCATION]");
   for (Conversation element :
       contactCenterInsightsClient.listConversations(parent).iterateAll()) {
     // doThingsWith(element);
   }
 }
 
Parameter
NameDescription
parentLocationName

Required. The parent resource of the conversation.

Returns
TypeDescription
ContactCenterInsightsClient.ListConversationsPagedResponse

listConversations(String parent)

public final ContactCenterInsightsClient.ListConversationsPagedResponse listConversations(String parent)

Lists conversations.

Sample code:


 // This snippet has been automatically generated for illustrative purposes only.
 // It may require modifications to work in your environment.
 try (ContactCenterInsightsClient contactCenterInsightsClient =
     ContactCenterInsightsClient.create()) {
   String parent = LocationName.of("[PROJECT]", "[LOCATION]").toString();
   for (Conversation element :
       contactCenterInsightsClient.listConversations(parent).iterateAll()) {
     // doThingsWith(element);
   }
 }
 
Parameter
NameDescription
parentString

Required. The parent resource of the conversation.

Returns
TypeDescription
ContactCenterInsightsClient.ListConversationsPagedResponse

listConversationsCallable()

public final UnaryCallable<ListConversationsRequest,ListConversationsResponse> listConversationsCallable()

Lists conversations.

Sample code:


 // This snippet has been automatically generated for illustrative purposes only.
 // It may require modifications to work in your environment.
 try (ContactCenterInsightsClient contactCenterInsightsClient =
     ContactCenterInsightsClient.create()) {
   ListConversationsRequest request =
       ListConversationsRequest.newBuilder()
           .setParent(LocationName.of("[PROJECT]", "[LOCATION]").toString())
           .setPageSize(883849137)
           .setPageToken("pageToken873572522")
           .setFilter("filter-1274492040")
           .setView(ConversationView.forNumber(0))
           .build();
   while (true) {
     ListConversationsResponse response =
         contactCenterInsightsClient.listConversationsCallable().call(request);
     for (Conversation element : response.getResponsesList()) {
       // doThingsWith(element);
     }
     String nextPageToken = response.getNextPageToken();
     if (!Strings.isNullOrEmpty(nextPageToken)) {
       request = request.toBuilder().setPageToken(nextPageToken).build();
     } else {
       break;
     }
   }
 }
 
Returns
TypeDescription
UnaryCallable<ListConversationsRequest,ListConversationsResponse>

listConversationsPagedCallable()

public final UnaryCallable<ListConversationsRequest,ContactCenterInsightsClient.ListConversationsPagedResponse> listConversationsPagedCallable()

Lists conversations.

Sample code:


 // This snippet has been automatically generated for illustrative purposes only.
 // It may require modifications to work in your environment.
 try (ContactCenterInsightsClient contactCenterInsightsClient =
     ContactCenterInsightsClient.create()) {
   ListConversationsRequest request =
       ListConversationsRequest.newBuilder()
           .setParent(LocationName.of("[PROJECT]", "[LOCATION]").toString())
           .setPageSize(883849137)
           .setPageToken("pageToken873572522")
           .setFilter("filter-1274492040")
           .setView(ConversationView.forNumber(0))
           .build();
   ApiFuture<Conversation> future =
       contactCenterInsightsClient.listConversationsPagedCallable().futureCall(request);
   // Do something.
   for (Conversation element : future.get().iterateAll()) {
     // doThingsWith(element);
   }
 }
 
Returns
TypeDescription
UnaryCallable<ListConversationsRequest,ListConversationsPagedResponse>

listIssueModels(ListIssueModelsRequest request)

public final ListIssueModelsResponse listIssueModels(ListIssueModelsRequest request)

Lists issue models.

Sample code:


 // This snippet has been automatically generated for illustrative purposes only.
 // It may require modifications to work in your environment.
 try (ContactCenterInsightsClient contactCenterInsightsClient =
     ContactCenterInsightsClient.create()) {
   ListIssueModelsRequest request =
       ListIssueModelsRequest.newBuilder()
           .setParent(LocationName.of("[PROJECT]", "[LOCATION]").toString())
           .build();
   ListIssueModelsResponse response = contactCenterInsightsClient.listIssueModels(request);
 }
 
Parameter
NameDescription
requestListIssueModelsRequest

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

Returns
TypeDescription
ListIssueModelsResponse

listIssueModels(LocationName parent)

public final ListIssueModelsResponse listIssueModels(LocationName parent)

Lists issue models.

Sample code:


 // This snippet has been automatically generated for illustrative purposes only.
 // It may require modifications to work in your environment.
 try (ContactCenterInsightsClient contactCenterInsightsClient =
     ContactCenterInsightsClient.create()) {
   LocationName parent = LocationName.of("[PROJECT]", "[LOCATION]");
   ListIssueModelsResponse response = contactCenterInsightsClient.listIssueModels(parent);
 }
 
Parameter
NameDescription
parentLocationName

Required. The parent resource of the issue model.

Returns
TypeDescription
ListIssueModelsResponse

listIssueModels(String parent)

public final ListIssueModelsResponse listIssueModels(String parent)

Lists issue models.

Sample code:


 // This snippet has been automatically generated for illustrative purposes only.
 // It may require modifications to work in your environment.
 try (ContactCenterInsightsClient contactCenterInsightsClient =
     ContactCenterInsightsClient.create()) {
   String parent = LocationName.of("[PROJECT]", "[LOCATION]").toString();
   ListIssueModelsResponse response = contactCenterInsightsClient.listIssueModels(parent);
 }
 
Parameter
NameDescription
parentString

Required. The parent resource of the issue model.

Returns
TypeDescription
ListIssueModelsResponse

listIssueModelsCallable()

public final UnaryCallable<ListIssueModelsRequest,ListIssueModelsResponse> listIssueModelsCallable()

Lists issue models.

Sample code:


 // This snippet has been automatically generated for illustrative purposes only.
 // It may require modifications to work in your environment.
 try (ContactCenterInsightsClient contactCenterInsightsClient =
     ContactCenterInsightsClient.create()) {
   ListIssueModelsRequest request =
       ListIssueModelsRequest.newBuilder()
           .setParent(LocationName.of("[PROJECT]", "[LOCATION]").toString())
           .build();
   ApiFuture<ListIssueModelsResponse> future =
       contactCenterInsightsClient.listIssueModelsCallable().futureCall(request);
   // Do something.
   ListIssueModelsResponse response = future.get();
 }
 
Returns
TypeDescription
UnaryCallable<ListIssueModelsRequest,ListIssueModelsResponse>

listIssues(IssueModelName parent)

public final ListIssuesResponse listIssues(IssueModelName parent)

Lists issues.

Sample code:


 // This snippet has been automatically generated for illustrative purposes only.
 // It may require modifications to work in your environment.
 try (ContactCenterInsightsClient contactCenterInsightsClient =
     ContactCenterInsightsClient.create()) {
   IssueModelName parent = IssueModelName.of("[PROJECT]", "[LOCATION]", "[ISSUE_MODEL]");
   ListIssuesResponse response = contactCenterInsightsClient.listIssues(parent);
 }
 
Parameter
NameDescription
parentIssueModelName

Required. The parent resource of the issue.

Returns
TypeDescription
ListIssuesResponse

listIssues(ListIssuesRequest request)

public final ListIssuesResponse listIssues(ListIssuesRequest request)

Lists issues.

Sample code:


 // This snippet has been automatically generated for illustrative purposes only.
 // It may require modifications to work in your environment.
 try (ContactCenterInsightsClient contactCenterInsightsClient =
     ContactCenterInsightsClient.create()) {
   ListIssuesRequest request =
       ListIssuesRequest.newBuilder()
           .setParent(IssueModelName.of("[PROJECT]", "[LOCATION]", "[ISSUE_MODEL]").toString())
           .build();
   ListIssuesResponse response = contactCenterInsightsClient.listIssues(request);
 }
 
Parameter
NameDescription
requestListIssuesRequest

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

Returns
TypeDescription
ListIssuesResponse

listIssues(String parent)

public final ListIssuesResponse listIssues(String parent)

Lists issues.

Sample code:


 // This snippet has been automatically generated for illustrative purposes only.
 // It may require modifications to work in your environment.
 try (ContactCenterInsightsClient contactCenterInsightsClient =
     ContactCenterInsightsClient.create()) {
   String parent = IssueModelName.of("[PROJECT]", "[LOCATION]", "[ISSUE_MODEL]").toString();
   ListIssuesResponse response = contactCenterInsightsClient.listIssues(parent);
 }
 
Parameter
NameDescription
parentString

Required. The parent resource of the issue.

Returns
TypeDescription
ListIssuesResponse

listIssuesCallable()

public final UnaryCallable<ListIssuesRequest,ListIssuesResponse> listIssuesCallable()

Lists issues.

Sample code:


 // This snippet has been automatically generated for illustrative purposes only.
 // It may require modifications to work in your environment.
 try (ContactCenterInsightsClient contactCenterInsightsClient =
     ContactCenterInsightsClient.create()) {
   ListIssuesRequest request =
       ListIssuesRequest.newBuilder()
           .setParent(IssueModelName.of("[PROJECT]", "[LOCATION]", "[ISSUE_MODEL]").toString())
           .build();
   ApiFuture<ListIssuesResponse> future =
       contactCenterInsightsClient.listIssuesCallable().futureCall(request);
   // Do something.
   ListIssuesResponse response = future.get();
 }
 
Returns
TypeDescription
UnaryCallable<ListIssuesRequest,ListIssuesResponse>

listPhraseMatchers(ListPhraseMatchersRequest request)

public final ContactCenterInsightsClient.ListPhraseMatchersPagedResponse listPhraseMatchers(ListPhraseMatchersRequest request)

Lists phrase matchers.

Sample code:


 // This snippet has been automatically generated for illustrative purposes only.
 // It may require modifications to work in your environment.
 try (ContactCenterInsightsClient contactCenterInsightsClient =
     ContactCenterInsightsClient.create()) {
   ListPhraseMatchersRequest request =
       ListPhraseMatchersRequest.newBuilder()
           .setParent(LocationName.of("[PROJECT]", "[LOCATION]").toString())
           .setPageSize(883849137)
           .setPageToken("pageToken873572522")
           .setFilter("filter-1274492040")
           .build();
   for (PhraseMatcher element :
       contactCenterInsightsClient.listPhraseMatchers(request).iterateAll()) {
     // doThingsWith(element);
   }
 }
 
Parameter
NameDescription
requestListPhraseMatchersRequest

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

Returns
TypeDescription
ContactCenterInsightsClient.ListPhraseMatchersPagedResponse

listPhraseMatchers(LocationName parent)

public final ContactCenterInsightsClient.ListPhraseMatchersPagedResponse listPhraseMatchers(LocationName parent)

Lists phrase matchers.

Sample code:


 // This snippet has been automatically generated for illustrative purposes only.
 // It may require modifications to work in your environment.
 try (ContactCenterInsightsClient contactCenterInsightsClient =
     ContactCenterInsightsClient.create()) {
   LocationName parent = LocationName.of("[PROJECT]", "[LOCATION]");
   for (PhraseMatcher element :
       contactCenterInsightsClient.listPhraseMatchers(parent).iterateAll()) {
     // doThingsWith(element);
   }
 }
 
Parameter
NameDescription
parentLocationName

Required. The parent resource of the phrase matcher.

Returns
TypeDescription
ContactCenterInsightsClient.ListPhraseMatchersPagedResponse

listPhraseMatchers(String parent)

public final ContactCenterInsightsClient.ListPhraseMatchersPagedResponse listPhraseMatchers(String parent)

Lists phrase matchers.

Sample code:


 // This snippet has been automatically generated for illustrative purposes only.
 // It may require modifications to work in your environment.
 try (ContactCenterInsightsClient contactCenterInsightsClient =
     ContactCenterInsightsClient.create()) {
   String parent = LocationName.of("[PROJECT]", "[LOCATION]").toString();
   for (PhraseMatcher element :
       contactCenterInsightsClient.listPhraseMatchers(parent).iterateAll()) {
     // doThingsWith(element);
   }
 }
 
Parameter
NameDescription
parentString

Required. The parent resource of the phrase matcher.

Returns
TypeDescription
ContactCenterInsightsClient.ListPhraseMatchersPagedResponse

listPhraseMatchersCallable()

public final UnaryCallable<ListPhraseMatchersRequest,ListPhraseMatchersResponse> listPhraseMatchersCallable()

Lists phrase matchers.

Sample code:


 // This snippet has been automatically generated for illustrative purposes only.
 // It may require modifications to work in your environment.
 try (ContactCenterInsightsClient contactCenterInsightsClient =
     ContactCenterInsightsClient.create()) {
   ListPhraseMatchersRequest request =
       ListPhraseMatchersRequest.newBuilder()
           .setParent(LocationName.of("[PROJECT]", "[LOCATION]").toString())
           .setPageSize(883849137)
           .setPageToken("pageToken873572522")
           .setFilter("filter-1274492040")
           .build();
   while (true) {
     ListPhraseMatchersResponse response =
         contactCenterInsightsClient.listPhraseMatchersCallable().call(request);
     for (PhraseMatcher element : response.getResponsesList()) {
       // doThingsWith(element);
     }
     String nextPageToken = response.getNextPageToken();
     if (!Strings.isNullOrEmpty(nextPageToken)) {
       request = request.toBuilder().setPageToken(nextPageToken).build();
     } else {
       break;
     }
   }
 }
 
Returns
TypeDescription
UnaryCallable<ListPhraseMatchersRequest,ListPhraseMatchersResponse>

listPhraseMatchersPagedCallable()

public final UnaryCallable<ListPhraseMatchersRequest,ContactCenterInsightsClient.ListPhraseMatchersPagedResponse> listPhraseMatchersPagedCallable()

Lists phrase matchers.

Sample code:


 // This snippet has been automatically generated for illustrative purposes only.
 // It may require modifications to work in your environment.
 try (ContactCenterInsightsClient contactCenterInsightsClient =
     ContactCenterInsightsClient.create()) {
   ListPhraseMatchersRequest request =
       ListPhraseMatchersRequest.newBuilder()
           .setParent(LocationName.of("[PROJECT]", "[LOCATION]").toString())
           .setPageSize(883849137)
           .setPageToken("pageToken873572522")
           .setFilter("filter-1274492040")
           .build();
   ApiFuture<PhraseMatcher> future =
       contactCenterInsightsClient.listPhraseMatchersPagedCallable().futureCall(request);
   // Do something.
   for (PhraseMatcher element : future.get().iterateAll()) {
     // doThingsWith(element);
   }
 }
 
Returns
TypeDescription
UnaryCallable<ListPhraseMatchersRequest,ListPhraseMatchersPagedResponse>

listViews(ListViewsRequest request)

public final ContactCenterInsightsClient.ListViewsPagedResponse listViews(ListViewsRequest request)

Lists views.

Sample code:


 // This snippet has been automatically generated for illustrative purposes only.
 // It may require modifications to work in your environment.
 try (ContactCenterInsightsClient contactCenterInsightsClient =
     ContactCenterInsightsClient.create()) {
   ListViewsRequest request =
       ListViewsRequest.newBuilder()
           .setParent(LocationName.of("[PROJECT]", "[LOCATION]").toString())
           .setPageSize(883849137)
           .setPageToken("pageToken873572522")
           .build();
   for (View element : contactCenterInsightsClient.listViews(request).iterateAll()) {
     // doThingsWith(element);
   }
 }
 
Parameter
NameDescription
requestListViewsRequest

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

Returns
TypeDescription
ContactCenterInsightsClient.ListViewsPagedResponse

listViews(LocationName parent)

public final ContactCenterInsightsClient.ListViewsPagedResponse listViews(LocationName parent)

Lists views.

Sample code:


 // This snippet has been automatically generated for illustrative purposes only.
 // It may require modifications to work in your environment.
 try (ContactCenterInsightsClient contactCenterInsightsClient =
     ContactCenterInsightsClient.create()) {
   LocationName parent = LocationName.of("[PROJECT]", "[LOCATION]");
   for (View element : contactCenterInsightsClient.listViews(parent).iterateAll()) {
     // doThingsWith(element);
   }
 }
 
Parameter
NameDescription
parentLocationName

Required. The parent resource of the views.

Returns
TypeDescription
ContactCenterInsightsClient.ListViewsPagedResponse

listViews(String parent)

public final ContactCenterInsightsClient.ListViewsPagedResponse listViews(String parent)

Lists views.

Sample code:


 // This snippet has been automatically generated for illustrative purposes only.
 // It may require modifications to work in your environment.
 try (ContactCenterInsightsClient contactCenterInsightsClient =
     ContactCenterInsightsClient.create()) {
   String parent = LocationName.of("[PROJECT]", "[LOCATION]").toString();
   for (View element : contactCenterInsightsClient.listViews(parent).iterateAll()) {
     // doThingsWith(element);
   }
 }
 
Parameter
NameDescription
parentString

Required. The parent resource of the views.

Returns
TypeDescription
ContactCenterInsightsClient.ListViewsPagedResponse

listViewsCallable()

public final UnaryCallable<ListViewsRequest,ListViewsResponse> listViewsCallable()

Lists views.

Sample code:


 // This snippet has been automatically generated for illustrative purposes only.
 // It may require modifications to work in your environment.
 try (ContactCenterInsightsClient contactCenterInsightsClient =
     ContactCenterInsightsClient.create()) {
   ListViewsRequest request =
       ListViewsRequest.newBuilder()
           .setParent(LocationName.of("[PROJECT]", "[LOCATION]").toString())
           .setPageSize(883849137)
           .setPageToken("pageToken873572522")
           .build();
   while (true) {
     ListViewsResponse response = contactCenterInsightsClient.listViewsCallable().call(request);
     for (View element : response.getResponsesList()) {
       // doThingsWith(element);
     }
     String nextPageToken = response.getNextPageToken();
     if (!Strings.isNullOrEmpty(nextPageToken)) {
       request = request.toBuilder().setPageToken(nextPageToken).build();
     } else {
       break;
     }
   }
 }
 
Returns
TypeDescription
UnaryCallable<ListViewsRequest,ListViewsResponse>

listViewsPagedCallable()

public final UnaryCallable<ListViewsRequest,ContactCenterInsightsClient.ListViewsPagedResponse> listViewsPagedCallable()

Lists views.

Sample code:


 // This snippet has been automatically generated for illustrative purposes only.
 // It may require modifications to work in your environment.
 try (ContactCenterInsightsClient contactCenterInsightsClient =
     ContactCenterInsightsClient.create()) {
   ListViewsRequest request =
       ListViewsRequest.newBuilder()
           .setParent(LocationName.of("[PROJECT]", "[LOCATION]").toString())
           .setPageSize(883849137)
           .setPageToken("pageToken873572522")
           .build();
   ApiFuture<View> future =
       contactCenterInsightsClient.listViewsPagedCallable().futureCall(request);
   // Do something.
   for (View element : future.get().iterateAll()) {
     // doThingsWith(element);
   }
 }
 
Returns
TypeDescription
UnaryCallable<ListViewsRequest,ListViewsPagedResponse>

shutdown()

public void shutdown()

shutdownNow()

public void shutdownNow()

undeployIssueModelAsync(IssueModelName name)

public final OperationFuture<UndeployIssueModelResponse,UndeployIssueModelMetadata> undeployIssueModelAsync(IssueModelName name)

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

Sample code:


 // This snippet has been automatically generated for illustrative purposes only.
 // It may require modifications to work in your environment.
 try (ContactCenterInsightsClient contactCenterInsightsClient =
     ContactCenterInsightsClient.create()) {
   IssueModelName name = IssueModelName.of("[PROJECT]", "[LOCATION]", "[ISSUE_MODEL]");
   UndeployIssueModelResponse response =
       contactCenterInsightsClient.undeployIssueModelAsync(name).get();
 }
 
Parameter
NameDescription
nameIssueModelName

Required. The issue model to undeploy.

Returns
TypeDescription
OperationFuture<UndeployIssueModelResponse,UndeployIssueModelMetadata>

undeployIssueModelAsync(UndeployIssueModelRequest request)

public final OperationFuture<UndeployIssueModelResponse,UndeployIssueModelMetadata> undeployIssueModelAsync(UndeployIssueModelRequest request)

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

Sample code:


 // This snippet has been automatically generated for illustrative purposes only.
 // It may require modifications to work in your environment.
 try (ContactCenterInsightsClient contactCenterInsightsClient =
     ContactCenterInsightsClient.create()) {
   UndeployIssueModelRequest request =
       UndeployIssueModelRequest.newBuilder()
           .setName(IssueModelName.of("[PROJECT]", "[LOCATION]", "[ISSUE_MODEL]").toString())
           .build();
   UndeployIssueModelResponse response =
       contactCenterInsightsClient.undeployIssueModelAsync(request).get();
 }
 
Parameter
NameDescription
requestUndeployIssueModelRequest

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

Returns
TypeDescription
OperationFuture<UndeployIssueModelResponse,UndeployIssueModelMetadata>

undeployIssueModelAsync(String name)

public final OperationFuture<UndeployIssueModelResponse,UndeployIssueModelMetadata> undeployIssueModelAsync(String name)

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

Sample code:


 // This snippet has been automatically generated for illustrative purposes only.
 // It may require modifications to work in your environment.
 try (ContactCenterInsightsClient contactCenterInsightsClient =
     ContactCenterInsightsClient.create()) {
   String name = IssueModelName.of("[PROJECT]", "[LOCATION]", "[ISSUE_MODEL]").toString();
   UndeployIssueModelResponse response =
       contactCenterInsightsClient.undeployIssueModelAsync(name).get();
 }
 
Parameter
NameDescription
nameString

Required. The issue model to undeploy.

Returns
TypeDescription
OperationFuture<UndeployIssueModelResponse,UndeployIssueModelMetadata>

undeployIssueModelCallable()

public final UnaryCallable<UndeployIssueModelRequest,Operation> undeployIssueModelCallable()

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

Sample code:


 // This snippet has been automatically generated for illustrative purposes only.
 // It may require modifications to work in your environment.
 try (ContactCenterInsightsClient contactCenterInsightsClient =
     ContactCenterInsightsClient.create()) {
   UndeployIssueModelRequest request =
       UndeployIssueModelRequest.newBuilder()
           .setName(IssueModelName.of("[PROJECT]", "[LOCATION]", "[ISSUE_MODEL]").toString())
           .build();
   ApiFuture<Operation> future =
       contactCenterInsightsClient.undeployIssueModelCallable().futureCall(request);
   // Do something.
   Operation response = future.get();
 }
 
Returns
TypeDescription
UnaryCallable<UndeployIssueModelRequest,Operation>

undeployIssueModelOperationCallable()

public final OperationCallable<UndeployIssueModelRequest,UndeployIssueModelResponse,UndeployIssueModelMetadata> undeployIssueModelOperationCallable()

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

Sample code:


 // This snippet has been automatically generated for illustrative purposes only.
 // It may require modifications to work in your environment.
 try (ContactCenterInsightsClient contactCenterInsightsClient =
     ContactCenterInsightsClient.create()) {
   UndeployIssueModelRequest request =
       UndeployIssueModelRequest.newBuilder()
           .setName(IssueModelName.of("[PROJECT]", "[LOCATION]", "[ISSUE_MODEL]").toString())
           .build();
   OperationFuture<UndeployIssueModelResponse, UndeployIssueModelMetadata> future =
       contactCenterInsightsClient.undeployIssueModelOperationCallable().futureCall(request);
   // Do something.
   UndeployIssueModelResponse response = future.get();
 }
 
Returns
TypeDescription
OperationCallable<UndeployIssueModelRequest,UndeployIssueModelResponse,UndeployIssueModelMetadata>

updateConversation(Conversation conversation, FieldMask updateMask)

public final Conversation updateConversation(Conversation conversation, FieldMask updateMask)

Updates a conversation.

Sample code:


 // This snippet has been automatically generated for illustrative purposes only.
 // It may require modifications to work in your environment.
 try (ContactCenterInsightsClient contactCenterInsightsClient =
     ContactCenterInsightsClient.create()) {
   Conversation conversation = Conversation.newBuilder().build();
   FieldMask updateMask = FieldMask.newBuilder().build();
   Conversation response =
       contactCenterInsightsClient.updateConversation(conversation, updateMask);
 }
 
Parameters
NameDescription
conversationConversation

Required. The new values for the conversation.

updateMaskFieldMask

The list of fields to be updated.

Returns
TypeDescription
Conversation

updateConversation(UpdateConversationRequest request)

public final Conversation updateConversation(UpdateConversationRequest request)

Updates a conversation.

Sample code:


 // This snippet has been automatically generated for illustrative purposes only.
 // It may require modifications to work in your environment.
 try (ContactCenterInsightsClient contactCenterInsightsClient =
     ContactCenterInsightsClient.create()) {
   UpdateConversationRequest request =
       UpdateConversationRequest.newBuilder()
           .setConversation(Conversation.newBuilder().build())
           .setUpdateMask(FieldMask.newBuilder().build())
           .build();
   Conversation response = contactCenterInsightsClient.updateConversation(request);
 }
 
Parameter
NameDescription
requestUpdateConversationRequest

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

Returns
TypeDescription
Conversation

updateConversationCallable()

public final UnaryCallable<UpdateConversationRequest,Conversation> updateConversationCallable()

Updates a conversation.

Sample code:


 // This snippet has been automatically generated for illustrative purposes only.
 // It may require modifications to work in your environment.
 try (ContactCenterInsightsClient contactCenterInsightsClient =
     ContactCenterInsightsClient.create()) {
   UpdateConversationRequest request =
       UpdateConversationRequest.newBuilder()
           .setConversation(Conversation.newBuilder().build())
           .setUpdateMask(FieldMask.newBuilder().build())
           .build();
   ApiFuture<Conversation> future =
       contactCenterInsightsClient.updateConversationCallable().futureCall(request);
   // Do something.
   Conversation response = future.get();
 }
 
Returns
TypeDescription
UnaryCallable<UpdateConversationRequest,Conversation>

updateIssue(Issue issue, FieldMask updateMask)

public final Issue updateIssue(Issue issue, FieldMask updateMask)

Updates an issue.

Sample code:


 // This snippet has been automatically generated for illustrative purposes only.
 // It may require modifications to work in your environment.
 try (ContactCenterInsightsClient contactCenterInsightsClient =
     ContactCenterInsightsClient.create()) {
   Issue issue = Issue.newBuilder().build();
   FieldMask updateMask = FieldMask.newBuilder().build();
   Issue response = contactCenterInsightsClient.updateIssue(issue, updateMask);
 }
 
Parameters
NameDescription
issueIssue

Required. The new values for the issue.

updateMaskFieldMask

The list of fields to be updated.

Returns
TypeDescription
Issue

updateIssue(UpdateIssueRequest request)

public final Issue updateIssue(UpdateIssueRequest request)

Updates an issue.

Sample code:


 // This snippet has been automatically generated for illustrative purposes only.
 // It may require modifications to work in your environment.
 try (ContactCenterInsightsClient contactCenterInsightsClient =
     ContactCenterInsightsClient.create()) {
   UpdateIssueRequest request =
       UpdateIssueRequest.newBuilder()
           .setIssue(Issue.newBuilder().build())
           .setUpdateMask(FieldMask.newBuilder().build())
           .build();
   Issue response = contactCenterInsightsClient.updateIssue(request);
 }
 
Parameter
NameDescription
requestUpdateIssueRequest

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

Returns
TypeDescription
Issue

updateIssueCallable()

public final UnaryCallable<UpdateIssueRequest,Issue> updateIssueCallable()

Updates an issue.

Sample code:


 // This snippet has been automatically generated for illustrative purposes only.
 // It may require modifications to work in your environment.
 try (ContactCenterInsightsClient contactCenterInsightsClient =
     ContactCenterInsightsClient.create()) {
   UpdateIssueRequest request =
       UpdateIssueRequest.newBuilder()
           .setIssue(Issue.newBuilder().build())
           .setUpdateMask(FieldMask.newBuilder().build())
           .build();
   ApiFuture<Issue> future =
       contactCenterInsightsClient.updateIssueCallable().futureCall(request);
   // Do something.
   Issue response = future.get();
 }
 
Returns
TypeDescription
UnaryCallable<UpdateIssueRequest,Issue>

updateIssueModel(IssueModel issueModel, FieldMask updateMask)

public final IssueModel updateIssueModel(IssueModel issueModel, FieldMask updateMask)

Updates an issue model.

Sample code:


 // This snippet has been automatically generated for illustrative purposes only.
 // It may require modifications to work in your environment.
 try (ContactCenterInsightsClient contactCenterInsightsClient =
     ContactCenterInsightsClient.create()) {
   IssueModel issueModel = IssueModel.newBuilder().build();
   FieldMask updateMask = FieldMask.newBuilder().build();
   IssueModel response = contactCenterInsightsClient.updateIssueModel(issueModel, updateMask);
 }
 
Parameters
NameDescription
issueModelIssueModel

Required. The new values for the issue model.

updateMaskFieldMask

The list of fields to be updated.

Returns
TypeDescription
IssueModel

updateIssueModel(UpdateIssueModelRequest request)

public final IssueModel updateIssueModel(UpdateIssueModelRequest request)

Updates an issue model.

Sample code:


 // This snippet has been automatically generated for illustrative purposes only.
 // It may require modifications to work in your environment.
 try (ContactCenterInsightsClient contactCenterInsightsClient =
     ContactCenterInsightsClient.create()) {
   UpdateIssueModelRequest request =
       UpdateIssueModelRequest.newBuilder()
           .setIssueModel(IssueModel.newBuilder().build())
           .setUpdateMask(FieldMask.newBuilder().build())
           .build();
   IssueModel response = contactCenterInsightsClient.updateIssueModel(request);
 }
 
Parameter
NameDescription
requestUpdateIssueModelRequest

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

Returns
TypeDescription
IssueModel

updateIssueModelCallable()

public final UnaryCallable<UpdateIssueModelRequest,IssueModel> updateIssueModelCallable()

Updates an issue model.

Sample code:


 // This snippet has been automatically generated for illustrative purposes only.
 // It may require modifications to work in your environment.
 try (ContactCenterInsightsClient contactCenterInsightsClient =
     ContactCenterInsightsClient.create()) {
   UpdateIssueModelRequest request =
       UpdateIssueModelRequest.newBuilder()
           .setIssueModel(IssueModel.newBuilder().build())
           .setUpdateMask(FieldMask.newBuilder().build())
           .build();
   ApiFuture<IssueModel> future =
       contactCenterInsightsClient.updateIssueModelCallable().futureCall(request);
   // Do something.
   IssueModel response = future.get();
 }
 
Returns
TypeDescription
UnaryCallable<UpdateIssueModelRequest,IssueModel>

updatePhraseMatcher(PhraseMatcher phraseMatcher, FieldMask updateMask)

public final PhraseMatcher updatePhraseMatcher(PhraseMatcher phraseMatcher, FieldMask updateMask)

Updates a phrase matcher.

Sample code:


 // This snippet has been automatically generated for illustrative purposes only.
 // It may require modifications to work in your environment.
 try (ContactCenterInsightsClient contactCenterInsightsClient =
     ContactCenterInsightsClient.create()) {
   PhraseMatcher phraseMatcher = PhraseMatcher.newBuilder().build();
   FieldMask updateMask = FieldMask.newBuilder().build();
   PhraseMatcher response =
       contactCenterInsightsClient.updatePhraseMatcher(phraseMatcher, updateMask);
 }
 
Parameters
NameDescription
phraseMatcherPhraseMatcher

Required. The new values for the phrase matcher.

updateMaskFieldMask

The list of fields to be updated.

Returns
TypeDescription
PhraseMatcher

updatePhraseMatcher(UpdatePhraseMatcherRequest request)

public final PhraseMatcher updatePhraseMatcher(UpdatePhraseMatcherRequest request)

Updates a phrase matcher.

Sample code:


 // This snippet has been automatically generated for illustrative purposes only.
 // It may require modifications to work in your environment.
 try (ContactCenterInsightsClient contactCenterInsightsClient =
     ContactCenterInsightsClient.create()) {
   UpdatePhraseMatcherRequest request =
       UpdatePhraseMatcherRequest.newBuilder()
           .setPhraseMatcher(PhraseMatcher.newBuilder().build())
           .setUpdateMask(FieldMask.newBuilder().build())
           .build();
   PhraseMatcher response = contactCenterInsightsClient.updatePhraseMatcher(request);
 }
 
Parameter
NameDescription
requestUpdatePhraseMatcherRequest

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

Returns
TypeDescription
PhraseMatcher

updatePhraseMatcherCallable()

public final UnaryCallable<UpdatePhraseMatcherRequest,PhraseMatcher> updatePhraseMatcherCallable()

Updates a phrase matcher.

Sample code:


 // This snippet has been automatically generated for illustrative purposes only.
 // It may require modifications to work in your environment.
 try (ContactCenterInsightsClient contactCenterInsightsClient =
     ContactCenterInsightsClient.create()) {
   UpdatePhraseMatcherRequest request =
       UpdatePhraseMatcherRequest.newBuilder()
           .setPhraseMatcher(PhraseMatcher.newBuilder().build())
           .setUpdateMask(FieldMask.newBuilder().build())
           .build();
   ApiFuture<PhraseMatcher> future =
       contactCenterInsightsClient.updatePhraseMatcherCallable().futureCall(request);
   // Do something.
   PhraseMatcher response = future.get();
 }
 
Returns
TypeDescription
UnaryCallable<UpdatePhraseMatcherRequest,PhraseMatcher>

updateSettings(Settings settings, FieldMask updateMask)

public final Settings updateSettings(Settings settings, FieldMask updateMask)

Updates project-level settings.

Sample code:


 // This snippet has been automatically generated for illustrative purposes only.
 // It may require modifications to work in your environment.
 try (ContactCenterInsightsClient contactCenterInsightsClient =
     ContactCenterInsightsClient.create()) {
   Settings settings = Settings.newBuilder().build();
   FieldMask updateMask = FieldMask.newBuilder().build();
   Settings response = contactCenterInsightsClient.updateSettings(settings, updateMask);
 }
 
Parameters
NameDescription
settingsSettings

Required. The new settings values.

updateMaskFieldMask

Required. The list of fields to be updated.

Returns
TypeDescription
Settings

updateSettings(UpdateSettingsRequest request)

public final Settings updateSettings(UpdateSettingsRequest request)

Updates project-level settings.

Sample code:


 // This snippet has been automatically generated for illustrative purposes only.
 // It may require modifications to work in your environment.
 try (ContactCenterInsightsClient contactCenterInsightsClient =
     ContactCenterInsightsClient.create()) {
   UpdateSettingsRequest request =
       UpdateSettingsRequest.newBuilder()
           .setSettings(Settings.newBuilder().build())
           .setUpdateMask(FieldMask.newBuilder().build())
           .build();
   Settings response = contactCenterInsightsClient.updateSettings(request);
 }
 
Parameter
NameDescription
requestUpdateSettingsRequest

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

Returns
TypeDescription
Settings

updateSettingsCallable()

public final UnaryCallable<UpdateSettingsRequest,Settings> updateSettingsCallable()

Updates project-level settings.

Sample code:


 // This snippet has been automatically generated for illustrative purposes only.
 // It may require modifications to work in your environment.
 try (ContactCenterInsightsClient contactCenterInsightsClient =
     ContactCenterInsightsClient.create()) {
   UpdateSettingsRequest request =
       UpdateSettingsRequest.newBuilder()
           .setSettings(Settings.newBuilder().build())
           .setUpdateMask(FieldMask.newBuilder().build())
           .build();
   ApiFuture<Settings> future =
       contactCenterInsightsClient.updateSettingsCallable().futureCall(request);
   // Do something.
   Settings response = future.get();
 }
 
Returns
TypeDescription
UnaryCallable<UpdateSettingsRequest,Settings>

updateView(UpdateViewRequest request)

public final View updateView(UpdateViewRequest request)

Updates a view.

Sample code:


 // This snippet has been automatically generated for illustrative purposes only.
 // It may require modifications to work in your environment.
 try (ContactCenterInsightsClient contactCenterInsightsClient =
     ContactCenterInsightsClient.create()) {
   UpdateViewRequest request =
       UpdateViewRequest.newBuilder()
           .setView(View.newBuilder().build())
           .setUpdateMask(FieldMask.newBuilder().build())
           .build();
   View response = contactCenterInsightsClient.updateView(request);
 }
 
Parameter
NameDescription
requestUpdateViewRequest

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

Returns
TypeDescription
View

updateView(View view, FieldMask updateMask)

public final View updateView(View view, FieldMask updateMask)

Updates a view.

Sample code:


 // This snippet has been automatically generated for illustrative purposes only.
 // It may require modifications to work in your environment.
 try (ContactCenterInsightsClient contactCenterInsightsClient =
     ContactCenterInsightsClient.create()) {
   View view = View.newBuilder().build();
   FieldMask updateMask = FieldMask.newBuilder().build();
   View response = contactCenterInsightsClient.updateView(view, updateMask);
 }
 
Parameters
NameDescription
viewView

Required. The new view.

updateMaskFieldMask

The list of fields to be updated.

Returns
TypeDescription
View

updateViewCallable()

public final UnaryCallable<UpdateViewRequest,View> updateViewCallable()

Updates a view.

Sample code:


 // This snippet has been automatically generated for illustrative purposes only.
 // It may require modifications to work in your environment.
 try (ContactCenterInsightsClient contactCenterInsightsClient =
     ContactCenterInsightsClient.create()) {
   UpdateViewRequest request =
       UpdateViewRequest.newBuilder()
           .setView(View.newBuilder().build())
           .setUpdateMask(FieldMask.newBuilder().build())
           .build();
   ApiFuture<View> future = contactCenterInsightsClient.updateViewCallable().futureCall(request);
   // Do something.
   View response = future.get();
 }
 
Returns
TypeDescription
UnaryCallable<UpdateViewRequest,View>