Interface SettingsOrBuilder (2.37.0)

public interface SettingsOrBuilder extends MessageOrBuilder

Implements

MessageOrBuilder

Methods

containsPubsubNotificationSettings(String key)

public abstract boolean containsPubsubNotificationSettings(String key)

A map that maps a notification trigger to a Pub/Sub topic. Each time a specified trigger occurs, Insights will notify the corresponding Pub/Sub topic.

Keys are notification triggers. Supported keys are:

"all-triggers": Notify each time any of the supported triggers occurs.
"create-analysis": Notify each time an analysis is created.
"create-conversation": Notify each time a conversation is created.
"export-insights-data": Notify each time an export is complete.
"update-conversation": Notify each time a conversation is updated via UpdateConversation.

Values are Pub/Sub topics. The format of each Pub/Sub topic is: projects/{project}/topics/{topic}

map<string, string> pubsub_notification_settings = 6;

Parameter
Name	Description
`key`	`String`

Returns
Type	Description
`boolean`

getAnalysisConfig()

public abstract Settings.AnalysisConfig getAnalysisConfig()

Default analysis settings.

.google.cloud.contactcenterinsights.v1.Settings.AnalysisConfig analysis_config = 7;

Returns
Type	Description
`Settings.AnalysisConfig`	The analysisConfig.

getAnalysisConfigOrBuilder()

public abstract Settings.AnalysisConfigOrBuilder getAnalysisConfigOrBuilder()

Default analysis settings.

.google.cloud.contactcenterinsights.v1.Settings.AnalysisConfig analysis_config = 7;

Returns
Type	Description
`Settings.AnalysisConfigOrBuilder`

getConversationTtl()

public abstract Duration getConversationTtl()

The default TTL for newly-created conversations. If a conversation has a specified expiration, that value will be used instead. Changing this value will not change the expiration of existing conversations. Conversations with no expire time persist until they are deleted.

.google.protobuf.Duration conversation_ttl = 5;

Returns
Type	Description
`Duration`	The conversationTtl.

getConversationTtlOrBuilder()

public abstract DurationOrBuilder getConversationTtlOrBuilder()

.google.protobuf.Duration conversation_ttl = 5;

Returns
Type	Description
`DurationOrBuilder`

getCreateTime()

public abstract Timestamp getCreateTime()

Output only. The time at which the settings was created.

.google.protobuf.Timestamp create_time = 2 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type	Description
`Timestamp`	The createTime.

getCreateTimeOrBuilder()

public abstract TimestampOrBuilder getCreateTimeOrBuilder()

Output only. The time at which the settings was created.

.google.protobuf.Timestamp create_time = 2 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type	Description
`TimestampOrBuilder`

getLanguageCode()

public abstract String getLanguageCode()

A language code to be applied to each transcript segment unless the segment already specifies a language code. Language code defaults to "en-US" if it is neither specified on the segment nor here.

string language_code = 4;

Returns
Type	Description
`String`	The languageCode.

getLanguageCodeBytes()

public abstract ByteString getLanguageCodeBytes()

A language code to be applied to each transcript segment unless the segment already specifies a language code. Language code defaults to "en-US" if it is neither specified on the segment nor here.

string language_code = 4;

Returns
Type	Description
`ByteString`	The bytes for languageCode.

getName()

public abstract String getName()

Immutable. The resource name of the settings resource. Format: projects/{project}/locations/{location}/settings

string name = 1 [(.google.api.field_behavior) = IMMUTABLE];

Returns
Type	Description
`String`	The name.

getNameBytes()

public abstract ByteString getNameBytes()

Immutable. The resource name of the settings resource. Format: projects/{project}/locations/{location}/settings

string name = 1 [(.google.api.field_behavior) = IMMUTABLE];

Returns
Type	Description
`ByteString`	The bytes for name.

getPubsubNotificationSettings() (deprecated)

public abstract Map<String,String> getPubsubNotificationSettings()

Use #getPubsubNotificationSettingsMap() instead.

Returns
Type	Description
`Map<String,String>`

getPubsubNotificationSettingsCount()

public abstract int getPubsubNotificationSettingsCount()

A map that maps a notification trigger to a Pub/Sub topic. Each time a specified trigger occurs, Insights will notify the corresponding Pub/Sub topic.

Keys are notification triggers. Supported keys are:

"all-triggers": Notify each time any of the supported triggers occurs.
"create-analysis": Notify each time an analysis is created.
"create-conversation": Notify each time a conversation is created.
"export-insights-data": Notify each time an export is complete.
"update-conversation": Notify each time a conversation is updated via UpdateConversation.

Values are Pub/Sub topics. The format of each Pub/Sub topic is: projects/{project}/topics/{topic}

map<string, string> pubsub_notification_settings = 6;

Returns
Type	Description
`int`

getPubsubNotificationSettingsMap()

public abstract Map<String,String> getPubsubNotificationSettingsMap()

A map that maps a notification trigger to a Pub/Sub topic. Each time a specified trigger occurs, Insights will notify the corresponding Pub/Sub topic.

Keys are notification triggers. Supported keys are:

"all-triggers": Notify each time any of the supported triggers occurs.
"create-analysis": Notify each time an analysis is created.
"create-conversation": Notify each time a conversation is created.
"export-insights-data": Notify each time an export is complete.
"update-conversation": Notify each time a conversation is updated via UpdateConversation.

Values are Pub/Sub topics. The format of each Pub/Sub topic is: projects/{project}/topics/{topic}

map<string, string> pubsub_notification_settings = 6;

Returns
Type	Description
`Map<String,String>`

getPubsubNotificationSettingsOrDefault(String key, String defaultValue)

public abstract String getPubsubNotificationSettingsOrDefault(String key, String defaultValue)

A map that maps a notification trigger to a Pub/Sub topic. Each time a specified trigger occurs, Insights will notify the corresponding Pub/Sub topic.

Keys are notification triggers. Supported keys are:

"all-triggers": Notify each time any of the supported triggers occurs.
"create-analysis": Notify each time an analysis is created.
"create-conversation": Notify each time a conversation is created.
"export-insights-data": Notify each time an export is complete.
"update-conversation": Notify each time a conversation is updated via UpdateConversation.

Values are Pub/Sub topics. The format of each Pub/Sub topic is: projects/{project}/topics/{topic}

map<string, string> pubsub_notification_settings = 6;

Parameters
Name	Description
`key`	`String`
`defaultValue`	`String`

Returns
Type	Description
`String`

getPubsubNotificationSettingsOrThrow(String key)

public abstract String getPubsubNotificationSettingsOrThrow(String key)

A map that maps a notification trigger to a Pub/Sub topic. Each time a specified trigger occurs, Insights will notify the corresponding Pub/Sub topic.

Keys are notification triggers. Supported keys are:

"all-triggers": Notify each time any of the supported triggers occurs.
"create-analysis": Notify each time an analysis is created.
"create-conversation": Notify each time a conversation is created.
"export-insights-data": Notify each time an export is complete.
"update-conversation": Notify each time a conversation is updated via UpdateConversation.

Values are Pub/Sub topics. The format of each Pub/Sub topic is: projects/{project}/topics/{topic}

map<string, string> pubsub_notification_settings = 6;

Parameter
Name	Description
`key`	`String`

Returns
Type	Description
`String`

getRedactionConfig()

public abstract RedactionConfig getRedactionConfig()

Default DLP redaction resources to be applied while ingesting conversations.

.google.cloud.contactcenterinsights.v1.RedactionConfig redaction_config = 10;

Returns
Type	Description
`RedactionConfig`	The redactionConfig.

getRedactionConfigOrBuilder()

public abstract RedactionConfigOrBuilder getRedactionConfigOrBuilder()

Default DLP redaction resources to be applied while ingesting conversations.

.google.cloud.contactcenterinsights.v1.RedactionConfig redaction_config = 10;

Returns
Type	Description
`RedactionConfigOrBuilder`

getSpeechConfig()

public abstract SpeechConfig getSpeechConfig()

Optional. Default Speech-to-Text resources to be used while ingesting audio files. Optional, CCAI Insights will create a default if not provided.

.google.cloud.contactcenterinsights.v1.SpeechConfig speech_config = 11 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type	Description
`SpeechConfig`	The speechConfig.

getSpeechConfigOrBuilder()

public abstract SpeechConfigOrBuilder getSpeechConfigOrBuilder()

Optional. Default Speech-to-Text resources to be used while ingesting audio files. Optional, CCAI Insights will create a default if not provided.

.google.cloud.contactcenterinsights.v1.SpeechConfig speech_config = 11 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type	Description
`SpeechConfigOrBuilder`

getUpdateTime()

public abstract Timestamp getUpdateTime()

Output only. The time at which the settings were last updated.

.google.protobuf.Timestamp update_time = 3 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type	Description
`Timestamp`	The updateTime.

getUpdateTimeOrBuilder()

public abstract TimestampOrBuilder getUpdateTimeOrBuilder()

Output only. The time at which the settings were last updated.

.google.protobuf.Timestamp update_time = 3 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type	Description
`TimestampOrBuilder`

hasAnalysisConfig()

public abstract boolean hasAnalysisConfig()

Default analysis settings.

.google.cloud.contactcenterinsights.v1.Settings.AnalysisConfig analysis_config = 7;

Returns
Type	Description
`boolean`	Whether the analysisConfig field is set.

hasConversationTtl()

public abstract boolean hasConversationTtl()

.google.protobuf.Duration conversation_ttl = 5;

Returns
Type	Description
`boolean`	Whether the conversationTtl field is set.

hasCreateTime()

public abstract boolean hasCreateTime()

Output only. The time at which the settings was created.

.google.protobuf.Timestamp create_time = 2 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type	Description
`boolean`	Whether the createTime field is set.

hasRedactionConfig()

public abstract boolean hasRedactionConfig()

Default DLP redaction resources to be applied while ingesting conversations.

.google.cloud.contactcenterinsights.v1.RedactionConfig redaction_config = 10;

Returns
Type	Description
`boolean`	Whether the redactionConfig field is set.

hasSpeechConfig()

public abstract boolean hasSpeechConfig()

Optional. Default Speech-to-Text resources to be used while ingesting audio files. Optional, CCAI Insights will create a default if not provided.

.google.cloud.contactcenterinsights.v1.SpeechConfig speech_config = 11 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type	Description
`boolean`	Whether the speechConfig field is set.

hasUpdateTime()

public abstract boolean hasUpdateTime()

Output only. The time at which the settings were last updated.

.google.protobuf.Timestamp update_time = 3 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type	Description
`boolean`	Whether the updateTime field is set.