Class ContactCenterInsightsSettings (2.53.0)

public class ContactCenterInsightsSettings extends ClientSettings<ContactCenterInsightsSettings>

Settings class to configure an instance of ContactCenterInsightsClient.

The default instance has everything set to sensible defaults:

  • The default service address (contactcenterinsights.googleapis.com) and default port (443) are used.
  • Credentials are acquired automatically through Application Default Credentials.
  • Retries are configured for idempotent methods but not for non-idempotent methods.

The builder of this class is recursive, so contained classes are themselves builders. When build() is called, the tree of builders is called to create the complete settings object.

For example, to set the RetrySettings of createConversation:


 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 ContactCenterInsightsSettings.Builder contactCenterInsightsSettingsBuilder =
     ContactCenterInsightsSettings.newBuilder();
 contactCenterInsightsSettingsBuilder
     .createConversationSettings()
     .setRetrySettings(
         contactCenterInsightsSettingsBuilder
             .createConversationSettings()
             .getRetrySettings()
             .toBuilder()
             .setInitialRetryDelayDuration(Duration.ofSeconds(1))
             .setInitialRpcTimeoutDuration(Duration.ofSeconds(5))
             .setMaxAttempts(5)
             .setMaxRetryDelayDuration(Duration.ofSeconds(30))
             .setMaxRpcTimeoutDuration(Duration.ofSeconds(60))
             .setRetryDelayMultiplier(1.3)
             .setRpcTimeoutMultiplier(1.5)
             .setTotalTimeoutDuration(Duration.ofSeconds(300))
             .build());
 ContactCenterInsightsSettings contactCenterInsightsSettings =
     contactCenterInsightsSettingsBuilder.build();
 

Please refer to the Client Side Retry Guide for additional support in setting retries.

To configure the RetrySettings of a Long Running Operation method, create an OperationTimedPollAlgorithm object and update the RPC's polling algorithm. For example, to configure the RetrySettings for uploadConversation:


 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 ContactCenterInsightsSettings.Builder contactCenterInsightsSettingsBuilder =
     ContactCenterInsightsSettings.newBuilder();
 TimedRetryAlgorithm timedRetryAlgorithm =
     OperationalTimedPollAlgorithm.create(
         RetrySettings.newBuilder()
             .setInitialRetryDelayDuration(Duration.ofMillis(500))
             .setRetryDelayMultiplier(1.5)
             .setMaxRetryDelay(Duration.ofMillis(5000))
             .setTotalTimeoutDuration(Duration.ofHours(24))
             .build());
 contactCenterInsightsSettingsBuilder
     .createClusterOperationSettings()
     .setPollingAlgorithm(timedRetryAlgorithm)
     .build();
 

Inheritance

java.lang.Object > ClientSettings > ContactCenterInsightsSettings

Static Methods

create(ContactCenterInsightsStubSettings stub)

public static final ContactCenterInsightsSettings create(ContactCenterInsightsStubSettings stub)
Parameter
Name Description
stub ContactCenterInsightsStubSettings
Returns
Type Description
ContactCenterInsightsSettings
Exceptions
Type Description
IOException

defaultApiClientHeaderProviderBuilder()

public static ApiClientHeaderProvider.Builder defaultApiClientHeaderProviderBuilder()
Returns
Type Description
Builder

defaultCredentialsProviderBuilder()

public static GoogleCredentialsProvider.Builder defaultCredentialsProviderBuilder()

Returns a builder for the default credentials for this service.

Returns
Type Description
Builder

defaultExecutorProviderBuilder()

public static InstantiatingExecutorProvider.Builder defaultExecutorProviderBuilder()

Returns a builder for the default ExecutorProvider for this service.

Returns
Type Description
Builder

defaultGrpcTransportProviderBuilder()

public static InstantiatingGrpcChannelProvider.Builder defaultGrpcTransportProviderBuilder()

Returns a builder for the default gRPC ChannelProvider for this service.

Returns
Type Description
Builder

defaultHttpJsonTransportProviderBuilder()

public static InstantiatingHttpJsonChannelProvider.Builder defaultHttpJsonTransportProviderBuilder()

Returns a builder for the default REST ChannelProvider for this service.

Returns
Type Description
Builder

defaultTransportChannelProvider()

public static TransportChannelProvider defaultTransportChannelProvider()
Returns
Type Description
TransportChannelProvider

getDefaultEndpoint()

public static String getDefaultEndpoint()

Returns the default service endpoint.

Returns
Type Description
String

getDefaultServiceScopes()

public static List<String> getDefaultServiceScopes()

Returns the default service scopes.

Returns
Type Description
List<String>

newBuilder()

public static ContactCenterInsightsSettings.Builder newBuilder()

Returns a new gRPC builder for this class.

Returns
Type Description
ContactCenterInsightsSettings.Builder

newBuilder(ClientContext clientContext)

public static ContactCenterInsightsSettings.Builder newBuilder(ClientContext clientContext)

Returns a new builder for this class.

Parameter
Name Description
clientContext ClientContext
Returns
Type Description
ContactCenterInsightsSettings.Builder

newHttpJsonBuilder()

public static ContactCenterInsightsSettings.Builder newHttpJsonBuilder()

Returns a new REST builder for this class.

Returns
Type Description
ContactCenterInsightsSettings.Builder

Constructors

ContactCenterInsightsSettings(ContactCenterInsightsSettings.Builder settingsBuilder)

protected ContactCenterInsightsSettings(ContactCenterInsightsSettings.Builder settingsBuilder)
Parameter
Name Description
settingsBuilder ContactCenterInsightsSettings.Builder

Methods

bulkAnalyzeConversationsOperationSettings()

public OperationCallSettings<BulkAnalyzeConversationsRequest,BulkAnalyzeConversationsResponse,BulkAnalyzeConversationsMetadata> bulkAnalyzeConversationsOperationSettings()

Returns the object with the settings used for calls to bulkAnalyzeConversations.

Returns
Type Description
OperationCallSettings<BulkAnalyzeConversationsRequest,BulkAnalyzeConversationsResponse,BulkAnalyzeConversationsMetadata>

bulkAnalyzeConversationsSettings()

public UnaryCallSettings<BulkAnalyzeConversationsRequest,Operation> bulkAnalyzeConversationsSettings()

Returns the object with the settings used for calls to bulkAnalyzeConversations.

Returns
Type Description
UnaryCallSettings<BulkAnalyzeConversationsRequest,Operation>

bulkDeleteConversationsOperationSettings()

public OperationCallSettings<BulkDeleteConversationsRequest,BulkDeleteConversationsResponse,BulkDeleteConversationsMetadata> bulkDeleteConversationsOperationSettings()

Returns the object with the settings used for calls to bulkDeleteConversations.

Returns
Type Description
OperationCallSettings<BulkDeleteConversationsRequest,BulkDeleteConversationsResponse,BulkDeleteConversationsMetadata>

bulkDeleteConversationsSettings()

public UnaryCallSettings<BulkDeleteConversationsRequest,Operation> bulkDeleteConversationsSettings()

Returns the object with the settings used for calls to bulkDeleteConversations.

Returns
Type Description
UnaryCallSettings<BulkDeleteConversationsRequest,Operation>

calculateIssueModelStatsSettings()

public UnaryCallSettings<CalculateIssueModelStatsRequest,CalculateIssueModelStatsResponse> calculateIssueModelStatsSettings()

Returns the object with the settings used for calls to calculateIssueModelStats.

Returns
Type Description
UnaryCallSettings<CalculateIssueModelStatsRequest,CalculateIssueModelStatsResponse>

calculateStatsSettings()

public UnaryCallSettings<CalculateStatsRequest,CalculateStatsResponse> calculateStatsSettings()

Returns the object with the settings used for calls to calculateStats.

Returns
Type Description
UnaryCallSettings<CalculateStatsRequest,CalculateStatsResponse>

createAnalysisOperationSettings()

public OperationCallSettings<CreateAnalysisRequest,Analysis,CreateAnalysisOperationMetadata> createAnalysisOperationSettings()

Returns the object with the settings used for calls to createAnalysis.

Returns
Type Description
OperationCallSettings<CreateAnalysisRequest,Analysis,CreateAnalysisOperationMetadata>

createAnalysisSettings()

public UnaryCallSettings<CreateAnalysisRequest,Operation> createAnalysisSettings()

Returns the object with the settings used for calls to createAnalysis.

Returns
Type Description
UnaryCallSettings<CreateAnalysisRequest,Operation>

createConversationSettings()

public UnaryCallSettings<CreateConversationRequest,Conversation> createConversationSettings()

Returns the object with the settings used for calls to createConversation.

Returns
Type Description
UnaryCallSettings<CreateConversationRequest,Conversation>

createIssueModelOperationSettings()

public OperationCallSettings<CreateIssueModelRequest,IssueModel,CreateIssueModelMetadata> createIssueModelOperationSettings()

Returns the object with the settings used for calls to createIssueModel.

Returns
Type Description
OperationCallSettings<CreateIssueModelRequest,IssueModel,CreateIssueModelMetadata>

createIssueModelSettings()

public UnaryCallSettings<CreateIssueModelRequest,Operation> createIssueModelSettings()

Returns the object with the settings used for calls to createIssueModel.

Returns
Type Description
UnaryCallSettings<CreateIssueModelRequest,Operation>

createPhraseMatcherSettings()

public UnaryCallSettings<CreatePhraseMatcherRequest,PhraseMatcher> createPhraseMatcherSettings()

Returns the object with the settings used for calls to createPhraseMatcher.

Returns
Type Description
UnaryCallSettings<CreatePhraseMatcherRequest,PhraseMatcher>

createViewSettings()

public UnaryCallSettings<CreateViewRequest,View> createViewSettings()

Returns the object with the settings used for calls to createView.

Returns
Type Description
UnaryCallSettings<CreateViewRequest,View>

deleteAnalysisSettings()

public UnaryCallSettings<DeleteAnalysisRequest,Empty> deleteAnalysisSettings()

Returns the object with the settings used for calls to deleteAnalysis.

Returns
Type Description
UnaryCallSettings<DeleteAnalysisRequest,Empty>

deleteConversationSettings()

public UnaryCallSettings<DeleteConversationRequest,Empty> deleteConversationSettings()

Returns the object with the settings used for calls to deleteConversation.

Returns
Type Description
UnaryCallSettings<DeleteConversationRequest,Empty>

deleteIssueModelOperationSettings()

public OperationCallSettings<DeleteIssueModelRequest,Empty,DeleteIssueModelMetadata> deleteIssueModelOperationSettings()

Returns the object with the settings used for calls to deleteIssueModel.

Returns
Type Description
OperationCallSettings<DeleteIssueModelRequest,Empty,DeleteIssueModelMetadata>

deleteIssueModelSettings()

public UnaryCallSettings<DeleteIssueModelRequest,Operation> deleteIssueModelSettings()

Returns the object with the settings used for calls to deleteIssueModel.

Returns
Type Description
UnaryCallSettings<DeleteIssueModelRequest,Operation>

deleteIssueSettings()

public UnaryCallSettings<DeleteIssueRequest,Empty> deleteIssueSettings()

Returns the object with the settings used for calls to deleteIssue.

Returns
Type Description
UnaryCallSettings<DeleteIssueRequest,Empty>

deletePhraseMatcherSettings()

public UnaryCallSettings<DeletePhraseMatcherRequest,Empty> deletePhraseMatcherSettings()

Returns the object with the settings used for calls to deletePhraseMatcher.

Returns
Type Description
UnaryCallSettings<DeletePhraseMatcherRequest,Empty>

deleteViewSettings()

public UnaryCallSettings<DeleteViewRequest,Empty> deleteViewSettings()

Returns the object with the settings used for calls to deleteView.

Returns
Type Description
UnaryCallSettings<DeleteViewRequest,Empty>

deployIssueModelOperationSettings()

public OperationCallSettings<DeployIssueModelRequest,DeployIssueModelResponse,DeployIssueModelMetadata> deployIssueModelOperationSettings()

Returns the object with the settings used for calls to deployIssueModel.

Returns
Type Description
OperationCallSettings<DeployIssueModelRequest,DeployIssueModelResponse,DeployIssueModelMetadata>

deployIssueModelSettings()

public UnaryCallSettings<DeployIssueModelRequest,Operation> deployIssueModelSettings()

Returns the object with the settings used for calls to deployIssueModel.

Returns
Type Description
UnaryCallSettings<DeployIssueModelRequest,Operation>

exportInsightsDataOperationSettings()

public OperationCallSettings<ExportInsightsDataRequest,ExportInsightsDataResponse,ExportInsightsDataMetadata> exportInsightsDataOperationSettings()

Returns the object with the settings used for calls to exportInsightsData.

Returns
Type Description
OperationCallSettings<ExportInsightsDataRequest,ExportInsightsDataResponse,ExportInsightsDataMetadata>

exportInsightsDataSettings()

public UnaryCallSettings<ExportInsightsDataRequest,Operation> exportInsightsDataSettings()

Returns the object with the settings used for calls to exportInsightsData.

Returns
Type Description
UnaryCallSettings<ExportInsightsDataRequest,Operation>

exportIssueModelOperationSettings()

public OperationCallSettings<ExportIssueModelRequest,ExportIssueModelResponse,ExportIssueModelMetadata> exportIssueModelOperationSettings()

Returns the object with the settings used for calls to exportIssueModel.

Returns
Type Description
OperationCallSettings<ExportIssueModelRequest,ExportIssueModelResponse,ExportIssueModelMetadata>

exportIssueModelSettings()

public UnaryCallSettings<ExportIssueModelRequest,Operation> exportIssueModelSettings()

Returns the object with the settings used for calls to exportIssueModel.

Returns
Type Description
UnaryCallSettings<ExportIssueModelRequest,Operation>

getAnalysisSettings()

public UnaryCallSettings<GetAnalysisRequest,Analysis> getAnalysisSettings()

Returns the object with the settings used for calls to getAnalysis.

Returns
Type Description
UnaryCallSettings<GetAnalysisRequest,Analysis>

getConversationSettings()

public UnaryCallSettings<GetConversationRequest,Conversation> getConversationSettings()

Returns the object with the settings used for calls to getConversation.

Returns
Type Description
UnaryCallSettings<GetConversationRequest,Conversation>

getEncryptionSpecSettings()

public UnaryCallSettings<GetEncryptionSpecRequest,EncryptionSpec> getEncryptionSpecSettings()

Returns the object with the settings used for calls to getEncryptionSpec.

Returns
Type Description
UnaryCallSettings<GetEncryptionSpecRequest,EncryptionSpec>

getIssueModelSettings()

public UnaryCallSettings<GetIssueModelRequest,IssueModel> getIssueModelSettings()

Returns the object with the settings used for calls to getIssueModel.

Returns
Type Description
UnaryCallSettings<GetIssueModelRequest,IssueModel>

getIssueSettings()

public UnaryCallSettings<GetIssueRequest,Issue> getIssueSettings()

Returns the object with the settings used for calls to getIssue.

Returns
Type Description
UnaryCallSettings<GetIssueRequest,Issue>

getPhraseMatcherSettings()

public UnaryCallSettings<GetPhraseMatcherRequest,PhraseMatcher> getPhraseMatcherSettings()

Returns the object with the settings used for calls to getPhraseMatcher.

Returns
Type Description
UnaryCallSettings<GetPhraseMatcherRequest,PhraseMatcher>

getSettingsSettings()

public UnaryCallSettings<GetSettingsRequest,Settings> getSettingsSettings()

Returns the object with the settings used for calls to getSettings.

Returns
Type Description
UnaryCallSettings<GetSettingsRequest,Settings>

getViewSettings()

public UnaryCallSettings<GetViewRequest,View> getViewSettings()

Returns the object with the settings used for calls to getView.

Returns
Type Description
UnaryCallSettings<GetViewRequest,View>

importIssueModelOperationSettings()

public OperationCallSettings<ImportIssueModelRequest,ImportIssueModelResponse,ImportIssueModelMetadata> importIssueModelOperationSettings()

Returns the object with the settings used for calls to importIssueModel.

Returns
Type Description
OperationCallSettings<ImportIssueModelRequest,ImportIssueModelResponse,ImportIssueModelMetadata>

importIssueModelSettings()

public UnaryCallSettings<ImportIssueModelRequest,Operation> importIssueModelSettings()

Returns the object with the settings used for calls to importIssueModel.

Returns
Type Description
UnaryCallSettings<ImportIssueModelRequest,Operation>

ingestConversationsOperationSettings()

public OperationCallSettings<IngestConversationsRequest,IngestConversationsResponse,IngestConversationsMetadata> ingestConversationsOperationSettings()

Returns the object with the settings used for calls to ingestConversations.

Returns
Type Description
OperationCallSettings<IngestConversationsRequest,IngestConversationsResponse,IngestConversationsMetadata>

ingestConversationsSettings()

public UnaryCallSettings<IngestConversationsRequest,Operation> ingestConversationsSettings()

Returns the object with the settings used for calls to ingestConversations.

Returns
Type Description
UnaryCallSettings<IngestConversationsRequest,Operation>

initializeEncryptionSpecOperationSettings()

public OperationCallSettings<InitializeEncryptionSpecRequest,InitializeEncryptionSpecResponse,InitializeEncryptionSpecMetadata> initializeEncryptionSpecOperationSettings()

Returns the object with the settings used for calls to initializeEncryptionSpec.

Returns
Type Description
OperationCallSettings<InitializeEncryptionSpecRequest,InitializeEncryptionSpecResponse,InitializeEncryptionSpecMetadata>

initializeEncryptionSpecSettings()

public UnaryCallSettings<InitializeEncryptionSpecRequest,Operation> initializeEncryptionSpecSettings()

Returns the object with the settings used for calls to initializeEncryptionSpec.

Returns
Type Description
UnaryCallSettings<InitializeEncryptionSpecRequest,Operation>

listAnalysesSettings()

public PagedCallSettings<ListAnalysesRequest,ListAnalysesResponse,ContactCenterInsightsClient.ListAnalysesPagedResponse> listAnalysesSettings()

Returns the object with the settings used for calls to listAnalyses.

Returns
Type Description
PagedCallSettings<ListAnalysesRequest,ListAnalysesResponse,ListAnalysesPagedResponse>

listConversationsSettings()

public PagedCallSettings<ListConversationsRequest,ListConversationsResponse,ContactCenterInsightsClient.ListConversationsPagedResponse> listConversationsSettings()

Returns the object with the settings used for calls to listConversations.

Returns
Type Description
PagedCallSettings<ListConversationsRequest,ListConversationsResponse,ListConversationsPagedResponse>

listIssueModelsSettings()

public UnaryCallSettings<ListIssueModelsRequest,ListIssueModelsResponse> listIssueModelsSettings()

Returns the object with the settings used for calls to listIssueModels.

Returns
Type Description
UnaryCallSettings<ListIssueModelsRequest,ListIssueModelsResponse>

listIssuesSettings()

public UnaryCallSettings<ListIssuesRequest,ListIssuesResponse> listIssuesSettings()

Returns the object with the settings used for calls to listIssues.

Returns
Type Description
UnaryCallSettings<ListIssuesRequest,ListIssuesResponse>

listPhraseMatchersSettings()

public PagedCallSettings<ListPhraseMatchersRequest,ListPhraseMatchersResponse,ContactCenterInsightsClient.ListPhraseMatchersPagedResponse> listPhraseMatchersSettings()

Returns the object with the settings used for calls to listPhraseMatchers.

Returns
Type Description
PagedCallSettings<ListPhraseMatchersRequest,ListPhraseMatchersResponse,ListPhraseMatchersPagedResponse>

listViewsSettings()

public PagedCallSettings<ListViewsRequest,ListViewsResponse,ContactCenterInsightsClient.ListViewsPagedResponse> listViewsSettings()

Returns the object with the settings used for calls to listViews.

Returns
Type Description
PagedCallSettings<ListViewsRequest,ListViewsResponse,ListViewsPagedResponse>

toBuilder()

public ContactCenterInsightsSettings.Builder toBuilder()

Returns a builder containing all the values of this settings class.

Returns
Type Description
ContactCenterInsightsSettings.Builder
Overrides

undeployIssueModelOperationSettings()

public OperationCallSettings<UndeployIssueModelRequest,UndeployIssueModelResponse,UndeployIssueModelMetadata> undeployIssueModelOperationSettings()

Returns the object with the settings used for calls to undeployIssueModel.

Returns
Type Description
OperationCallSettings<UndeployIssueModelRequest,UndeployIssueModelResponse,UndeployIssueModelMetadata>

undeployIssueModelSettings()

public UnaryCallSettings<UndeployIssueModelRequest,Operation> undeployIssueModelSettings()

Returns the object with the settings used for calls to undeployIssueModel.

Returns
Type Description
UnaryCallSettings<UndeployIssueModelRequest,Operation>

updateConversationSettings()

public UnaryCallSettings<UpdateConversationRequest,Conversation> updateConversationSettings()

Returns the object with the settings used for calls to updateConversation.

Returns
Type Description
UnaryCallSettings<UpdateConversationRequest,Conversation>

updateIssueModelSettings()

public UnaryCallSettings<UpdateIssueModelRequest,IssueModel> updateIssueModelSettings()

Returns the object with the settings used for calls to updateIssueModel.

Returns
Type Description
UnaryCallSettings<UpdateIssueModelRequest,IssueModel>

updateIssueSettings()

public UnaryCallSettings<UpdateIssueRequest,Issue> updateIssueSettings()

Returns the object with the settings used for calls to updateIssue.

Returns
Type Description
UnaryCallSettings<UpdateIssueRequest,Issue>

updatePhraseMatcherSettings()

public UnaryCallSettings<UpdatePhraseMatcherRequest,PhraseMatcher> updatePhraseMatcherSettings()

Returns the object with the settings used for calls to updatePhraseMatcher.

Returns
Type Description
UnaryCallSettings<UpdatePhraseMatcherRequest,PhraseMatcher>

updateSettingsSettings()

public UnaryCallSettings<UpdateSettingsRequest,Settings> updateSettingsSettings()

Returns the object with the settings used for calls to updateSettings.

Returns
Type Description
UnaryCallSettings<UpdateSettingsRequest,Settings>

updateViewSettings()

public UnaryCallSettings<UpdateViewRequest,View> updateViewSettings()

Returns the object with the settings used for calls to updateView.

Returns
Type Description
UnaryCallSettings<UpdateViewRequest,View>

uploadConversationOperationSettings()

public OperationCallSettings<UploadConversationRequest,Conversation,UploadConversationMetadata> uploadConversationOperationSettings()

Returns the object with the settings used for calls to uploadConversation.

Returns
Type Description
OperationCallSettings<UploadConversationRequest,Conversation,UploadConversationMetadata>

uploadConversationSettings()

public UnaryCallSettings<UploadConversationRequest,Operation> uploadConversationSettings()

Returns the object with the settings used for calls to uploadConversation.

Returns
Type Description
UnaryCallSettings<UploadConversationRequest,Operation>