Class Settings (2.34.0)

public final class Settings extends GeneratedMessageV3 implements SettingsOrBuilder

The settings resource.

Protobuf type google.cloud.contactcenterinsights.v1.Settings

Implements

SettingsOrBuilder

Static Fields

ANALYSIS_CONFIG_FIELD_NUMBER

public static final int ANALYSIS_CONFIG_FIELD_NUMBER
Field Value
TypeDescription
int

CONVERSATION_TTL_FIELD_NUMBER

public static final int CONVERSATION_TTL_FIELD_NUMBER
Field Value
TypeDescription
int

CREATE_TIME_FIELD_NUMBER

public static final int CREATE_TIME_FIELD_NUMBER
Field Value
TypeDescription
int

LANGUAGE_CODE_FIELD_NUMBER

public static final int LANGUAGE_CODE_FIELD_NUMBER
Field Value
TypeDescription
int

NAME_FIELD_NUMBER

public static final int NAME_FIELD_NUMBER
Field Value
TypeDescription
int

PUBSUB_NOTIFICATION_SETTINGS_FIELD_NUMBER

public static final int PUBSUB_NOTIFICATION_SETTINGS_FIELD_NUMBER
Field Value
TypeDescription
int

REDACTION_CONFIG_FIELD_NUMBER

public static final int REDACTION_CONFIG_FIELD_NUMBER
Field Value
TypeDescription
int

SPEECH_CONFIG_FIELD_NUMBER

public static final int SPEECH_CONFIG_FIELD_NUMBER
Field Value
TypeDescription
int

UPDATE_TIME_FIELD_NUMBER

public static final int UPDATE_TIME_FIELD_NUMBER
Field Value
TypeDescription
int

Static Methods

getDefaultInstance()

public static Settings getDefaultInstance()
Returns
TypeDescription
Settings

getDescriptor()

public static final Descriptors.Descriptor getDescriptor()
Returns
TypeDescription
Descriptor

newBuilder()

public static Settings.Builder newBuilder()
Returns
TypeDescription
Settings.Builder

newBuilder(Settings prototype)

public static Settings.Builder newBuilder(Settings prototype)
Parameter
NameDescription
prototypeSettings
Returns
TypeDescription
Settings.Builder

parseDelimitedFrom(InputStream input)

public static Settings parseDelimitedFrom(InputStream input)
Parameter
NameDescription
inputInputStream
Returns
TypeDescription
Settings
Exceptions
TypeDescription
IOException

parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

public static Settings parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
NameDescription
inputInputStream
extensionRegistryExtensionRegistryLite
Returns
TypeDescription
Settings
Exceptions
TypeDescription
IOException

parseFrom(byte[] data)

public static Settings parseFrom(byte[] data)
Parameter
NameDescription
databyte[]
Returns
TypeDescription
Settings
Exceptions
TypeDescription
InvalidProtocolBufferException

parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)

public static Settings parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)
Parameters
NameDescription
databyte[]
extensionRegistryExtensionRegistryLite
Returns
TypeDescription
Settings
Exceptions
TypeDescription
InvalidProtocolBufferException

parseFrom(ByteString data)

public static Settings parseFrom(ByteString data)
Parameter
NameDescription
dataByteString
Returns
TypeDescription
Settings
Exceptions
TypeDescription
InvalidProtocolBufferException

parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)

public static Settings parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)
Parameters
NameDescription
dataByteString
extensionRegistryExtensionRegistryLite
Returns
TypeDescription
Settings
Exceptions
TypeDescription
InvalidProtocolBufferException

parseFrom(CodedInputStream input)

public static Settings parseFrom(CodedInputStream input)
Parameter
NameDescription
inputCodedInputStream
Returns
TypeDescription
Settings
Exceptions
TypeDescription
IOException

parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

public static Settings parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
NameDescription
inputCodedInputStream
extensionRegistryExtensionRegistryLite
Returns
TypeDescription
Settings
Exceptions
TypeDescription
IOException

parseFrom(InputStream input)

public static Settings parseFrom(InputStream input)
Parameter
NameDescription
inputInputStream
Returns
TypeDescription
Settings
Exceptions
TypeDescription
IOException

parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

public static Settings parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
NameDescription
inputInputStream
extensionRegistryExtensionRegistryLite
Returns
TypeDescription
Settings
Exceptions
TypeDescription
IOException

parseFrom(ByteBuffer data)

public static Settings parseFrom(ByteBuffer data)
Parameter
NameDescription
dataByteBuffer
Returns
TypeDescription
Settings
Exceptions
TypeDescription
InvalidProtocolBufferException

parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)

public static Settings parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)
Parameters
NameDescription
dataByteBuffer
extensionRegistryExtensionRegistryLite
Returns
TypeDescription
Settings
Exceptions
TypeDescription
InvalidProtocolBufferException

parser()

public static Parser<Settings> parser()
Returns
TypeDescription
Parser<Settings>

Methods

containsPubsubNotificationSettings(String key)

public 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
NameDescription
keyString
Returns
TypeDescription
boolean

equals(Object obj)

public boolean equals(Object obj)
Parameter
NameDescription
objObject
Returns
TypeDescription
boolean
Overrides

getAnalysisConfig()

public Settings.AnalysisConfig getAnalysisConfig()

Default analysis settings.

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

Returns
TypeDescription
Settings.AnalysisConfig

The analysisConfig.

getAnalysisConfigOrBuilder()

public Settings.AnalysisConfigOrBuilder getAnalysisConfigOrBuilder()

Default analysis settings.

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

Returns
TypeDescription
Settings.AnalysisConfigOrBuilder

getConversationTtl()

public 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
TypeDescription
Duration

The conversationTtl.

getConversationTtlOrBuilder()

public DurationOrBuilder getConversationTtlOrBuilder()

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

getCreateTime()

public 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
TypeDescription
Timestamp

The createTime.

getCreateTimeOrBuilder()

public 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
TypeDescription
TimestampOrBuilder

getDefaultInstanceForType()

public Settings getDefaultInstanceForType()
Returns
TypeDescription
Settings

getLanguageCode()

public 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
TypeDescription
String

The languageCode.

getLanguageCodeBytes()

public 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
TypeDescription
ByteString

The bytes for languageCode.

getName()

public 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
TypeDescription
String

The name.

getNameBytes()

public 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
TypeDescription
ByteString

The bytes for name.

getParserForType()

public Parser<Settings> getParserForType()
Returns
TypeDescription
Parser<Settings>
Overrides

getPubsubNotificationSettings() (deprecated)

public Map<String,String> getPubsubNotificationSettings()
Returns
TypeDescription
Map<String,String>

getPubsubNotificationSettingsCount()

public 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
TypeDescription
int

getPubsubNotificationSettingsMap()

public 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
TypeDescription
Map<String,String>

getPubsubNotificationSettingsOrDefault(String key, String defaultValue)

public 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
NameDescription
keyString
defaultValueString
Returns
TypeDescription
String

getPubsubNotificationSettingsOrThrow(String key)

public 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
NameDescription
keyString
Returns
TypeDescription
String

getRedactionConfig()

public RedactionConfig getRedactionConfig()

Default DLP redaction resources to be applied while ingesting conversations.

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

Returns
TypeDescription
RedactionConfig

The redactionConfig.

getRedactionConfigOrBuilder()

public RedactionConfigOrBuilder getRedactionConfigOrBuilder()

Default DLP redaction resources to be applied while ingesting conversations.

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

Returns
TypeDescription
RedactionConfigOrBuilder

getSerializedSize()

public int getSerializedSize()
Returns
TypeDescription
int
Overrides

getSpeechConfig()

public 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
TypeDescription
SpeechConfig

The speechConfig.

getSpeechConfigOrBuilder()

public 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
TypeDescription
SpeechConfigOrBuilder

getUpdateTime()

public 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
TypeDescription
Timestamp

The updateTime.

getUpdateTimeOrBuilder()

public 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
TypeDescription
TimestampOrBuilder

hasAnalysisConfig()

public boolean hasAnalysisConfig()

Default analysis settings.

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

Returns
TypeDescription
boolean

Whether the analysisConfig field is set.

hasConversationTtl()

public boolean hasConversationTtl()

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

Whether the conversationTtl field is set.

hasCreateTime()

public 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
TypeDescription
boolean

Whether the createTime field is set.

hasRedactionConfig()

public boolean hasRedactionConfig()

Default DLP redaction resources to be applied while ingesting conversations.

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

Returns
TypeDescription
boolean

Whether the redactionConfig field is set.

hasSpeechConfig()

public 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
TypeDescription
boolean

Whether the speechConfig field is set.

hasUpdateTime()

public 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
TypeDescription
boolean

Whether the updateTime field is set.

hashCode()

public int hashCode()
Returns
TypeDescription
int
Overrides

internalGetFieldAccessorTable()

protected GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
Returns
TypeDescription
FieldAccessorTable
Overrides

internalGetMapField(int number)

protected MapField internalGetMapField(int number)
Parameter
NameDescription
numberint
Returns
TypeDescription
MapField
Overrides

isInitialized()

public final boolean isInitialized()
Returns
TypeDescription
boolean
Overrides

newBuilderForType()

public Settings.Builder newBuilderForType()
Returns
TypeDescription
Settings.Builder

newBuilderForType(GeneratedMessageV3.BuilderParent parent)

protected Settings.Builder newBuilderForType(GeneratedMessageV3.BuilderParent parent)
Parameter
NameDescription
parentBuilderParent
Returns
TypeDescription
Settings.Builder
Overrides

newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)

protected Object newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)
Parameter
NameDescription
unusedUnusedPrivateParameter
Returns
TypeDescription
Object
Overrides

toBuilder()

public Settings.Builder toBuilder()
Returns
TypeDescription
Settings.Builder

writeTo(CodedOutputStream output)

public void writeTo(CodedOutputStream output)
Parameter
NameDescription
outputCodedOutputStream
Overrides
Exceptions
TypeDescription
IOException