Class Settings (2.9.0)

Version 2.9.0

• 2.53.0 (latest)
• 2.52.0
• 2.51.0
• 2.49.0
• 2.48.0
• 2.47.0
• 2.46.0
• 2.45.0
• 2.44.0
• 2.43.0
• 2.42.0
• 2.41.0
• 2.40.0
• 2.39.0
• 2.37.0
• 2.36.0
• 2.35.0
• 2.34.0
• 2.33.0
• 2.32.0
• 2.31.0
• 2.30.0
• 2.29.0
• 2.28.0
• 2.27.0
• 2.24.0
• 2.23.0
• 2.22.0
• 2.21.0
• 2.20.0
• 2.19.0
• 2.18.0
• 2.17.0
• 2.16.0
• 2.15.0
• 2.14.0
• 2.13.0
• 2.12.0
• 2.11.0
• 2.10.0
• 2.9.0
• 2.8.0
• 2.7.0
• 2.6.0
• 2.5.0
• 2.4.0
• 2.3.10
• 2.2.7

public final class Settings extends GeneratedMessageV3 implements SettingsOrBuilder

The settings resource.

Protobuf type google.cloud.contactcenterinsights.v1.Settings

Inheritance

Object > AbstractMessageLite<MessageType,BuilderType> > AbstractMessage > GeneratedMessageV3 > Settings

Implements

SettingsOrBuilder

Inherited Members

AbstractMessage.equals(Object)

AbstractMessage.findInitializationErrors()

AbstractMessage.getInitializationErrorString()

AbstractMessage.hashBoolean(boolean)

AbstractMessage.hashCode()

AbstractMessage.hashEnum(Internal.EnumLite)

AbstractMessage.hashEnumList(List<? extends Internal.EnumLite>)

AbstractMessage.hashFields(int,Map<Descriptors.FieldDescriptor,Object>)

AbstractMessage.hashLong(long)

AbstractMessage.toString()

AbstractMessageLite.<T>addAll(Iterable<T>,Collection<? super T>)

AbstractMessageLite.<T>addAll(Iterable<T>,List<? super T>)

AbstractMessageLite.checkByteStringIsUtf8(ByteString)

AbstractMessageLite.toByteArray()

AbstractMessageLite.toByteString()

AbstractMessageLite.writeDelimitedTo(OutputStream)

AbstractMessageLite.writeTo(OutputStream)

GeneratedMessageV3.<M>parseDelimitedWithIOException(Parser<M>,InputStream)

GeneratedMessageV3.<M>parseDelimitedWithIOException(Parser<M>,InputStream,ExtensionRegistryLite)

GeneratedMessageV3.<M>parseWithIOException(Parser<M>,CodedInputStream)

GeneratedMessageV3.<M>parseWithIOException(Parser<M>,CodedInputStream,ExtensionRegistryLite)

GeneratedMessageV3.<M>parseWithIOException(Parser<M>,InputStream)

GeneratedMessageV3.<M>parseWithIOException(Parser<M>,InputStream,ExtensionRegistryLite)

GeneratedMessageV3.<V>serializeBooleanMapTo(CodedOutputStream,MapField<Boolean,V>,MapEntry<Boolean,V>,int)

GeneratedMessageV3.<V>serializeIntegerMapTo(CodedOutputStream,MapField<Integer,V>,MapEntry<Integer,V>,int)

GeneratedMessageV3.<V>serializeLongMapTo(CodedOutputStream,MapField<Long,V>,MapEntry<Long,V>,int)

GeneratedMessageV3.<V>serializeStringMapTo(CodedOutputStream,MapField<String,V>,MapEntry<String,V>,int)

GeneratedMessageV3.canUseUnsafe()

GeneratedMessageV3.computeStringSize(int,Object)

GeneratedMessageV3.computeStringSizeNoTag(Object)

GeneratedMessageV3.emptyBooleanList()

GeneratedMessageV3.emptyDoubleList()

GeneratedMessageV3.emptyFloatList()

GeneratedMessageV3.emptyIntList()

GeneratedMessageV3.emptyLongList()

GeneratedMessageV3.getAllFields()

GeneratedMessageV3.getDescriptorForType()

GeneratedMessageV3.getField(Descriptors.FieldDescriptor)

GeneratedMessageV3.getOneofFieldDescriptor(Descriptors.OneofDescriptor)

GeneratedMessageV3.getParserForType()

GeneratedMessageV3.getRepeatedField(Descriptors.FieldDescriptor,int)

GeneratedMessageV3.getRepeatedFieldCount(Descriptors.FieldDescriptor)

GeneratedMessageV3.getSerializedSize()

GeneratedMessageV3.getUnknownFields()

GeneratedMessageV3.hasField(Descriptors.FieldDescriptor)

GeneratedMessageV3.hasOneof(Descriptors.OneofDescriptor)

GeneratedMessageV3.internalGetFieldAccessorTable()

GeneratedMessageV3.internalGetMapField(int)

GeneratedMessageV3.isInitialized()

GeneratedMessageV3.isStringEmpty(Object)

GeneratedMessageV3.makeExtensionsImmutable()

GeneratedMessageV3.mergeFromAndMakeImmutableInternal(CodedInputStream,ExtensionRegistryLite)

GeneratedMessageV3.mutableCopy(Internal.BooleanList)

GeneratedMessageV3.mutableCopy(Internal.DoubleList)

GeneratedMessageV3.mutableCopy(Internal.FloatList)

GeneratedMessageV3.mutableCopy(Internal.IntList)

GeneratedMessageV3.mutableCopy(Internal.LongList)

GeneratedMessageV3.newBooleanList()

GeneratedMessageV3.newBuilderForType(AbstractMessage.BuilderParent)

GeneratedMessageV3.newBuilderForType(GeneratedMessageV3.BuilderParent)

GeneratedMessageV3.newDoubleList()

GeneratedMessageV3.newFloatList()

GeneratedMessageV3.newInstance(GeneratedMessageV3.UnusedPrivateParameter)

GeneratedMessageV3.newIntList()

GeneratedMessageV3.newLongList()

GeneratedMessageV3.parseUnknownField(CodedInputStream,UnknownFieldSet.Builder,ExtensionRegistryLite,int)

GeneratedMessageV3.parseUnknownFieldProto3(CodedInputStream,UnknownFieldSet.Builder,ExtensionRegistryLite,int)

GeneratedMessageV3.writeReplace()

GeneratedMessageV3.writeString(CodedOutputStream,int,Object)

GeneratedMessageV3.writeStringNoTag(CodedOutputStream,Object)

GeneratedMessageV3.writeTo(CodedOutputStream)

Object.clone()

Object.finalize()

Object.getClass()

Object.notify()

Object.notifyAll()

Object.wait()

Object.wait(long)

Object.wait(long,int)

Static Fields

ANALYSIS_CONFIG_FIELD_NUMBER

public static final int ANALYSIS_CONFIG_FIELD_NUMBER

Field Value

Type	Description
int

CONVERSATION_TTL_FIELD_NUMBER

public static final int CONVERSATION_TTL_FIELD_NUMBER

Field Value

Type	Description
int

CREATE_TIME_FIELD_NUMBER

public static final int CREATE_TIME_FIELD_NUMBER

Field Value

Type	Description
int

LANGUAGE_CODE_FIELD_NUMBER

public static final int LANGUAGE_CODE_FIELD_NUMBER

Field Value

Type	Description
int

NAME_FIELD_NUMBER

public static final int NAME_FIELD_NUMBER

Field Value

Type	Description
int

PUBSUB_NOTIFICATION_SETTINGS_FIELD_NUMBER

public static final int PUBSUB_NOTIFICATION_SETTINGS_FIELD_NUMBER

Field Value

Type	Description
int

UPDATE_TIME_FIELD_NUMBER

public static final int UPDATE_TIME_FIELD_NUMBER

Field Value

Type	Description
int

Static Methods

getDefaultInstance()

public static Settings getDefaultInstance()

Returns

Type	Description
Settings

getDescriptor()

public static final Descriptors.Descriptor getDescriptor()

Returns

Type	Description
Descriptor

newBuilder()

public static Settings.Builder newBuilder()

Returns

Type	Description
Settings.Builder

newBuilder(Settings prototype)

public static Settings.Builder newBuilder(Settings prototype)

Parameter

Name	Description
prototype	Settings

Returns

Type	Description
Settings.Builder

parseDelimitedFrom(InputStream input)

public static Settings parseDelimitedFrom(InputStream input)

Parameter

Name	Description
input	InputStream

Returns

Type	Description
Settings

Exceptions

Type	Description
IOException

parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

public static Settings parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

Parameters

Name	Description
input	InputStream
extensionRegistry	ExtensionRegistryLite

Returns

Type	Description
Settings

Exceptions

Type	Description
IOException

parseFrom(byte[] data)

public static Settings parseFrom(byte[] data)

Parameter

Name	Description
data	byte[]

Returns

Type	Description
Settings

Exceptions

Type	Description
InvalidProtocolBufferException

parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)

public static Settings parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)

Parameters

Name	Description
data	byte[]
extensionRegistry	ExtensionRegistryLite

Returns

Type	Description
Settings

Exceptions

Type	Description
InvalidProtocolBufferException

parseFrom(ByteString data)

public static Settings parseFrom(ByteString data)

Parameter

Name	Description
data	ByteString

Returns

Type	Description
Settings

Exceptions

Type	Description
InvalidProtocolBufferException

parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)

public static Settings parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)

Parameters

Name	Description
data	ByteString
extensionRegistry	ExtensionRegistryLite

Returns

Type	Description
Settings

Exceptions

Type	Description
InvalidProtocolBufferException

parseFrom(CodedInputStream input)

public static Settings parseFrom(CodedInputStream input)

Parameter

Name	Description
input	CodedInputStream

Returns

Type	Description
Settings

Exceptions

Type	Description
IOException

parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

public static Settings parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

Parameters

Name	Description
input	CodedInputStream
extensionRegistry	ExtensionRegistryLite

Returns

Type	Description
Settings

Exceptions

Type	Description
IOException

parseFrom(InputStream input)

public static Settings parseFrom(InputStream input)

Parameter

Name	Description
input	InputStream

Returns

Type	Description
Settings

Exceptions

Type	Description
IOException

parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

public static Settings parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

Parameters

Name	Description
input	InputStream
extensionRegistry	ExtensionRegistryLite

Returns

Type	Description
Settings

Exceptions

Type	Description
IOException

parseFrom(ByteBuffer data)

public static Settings parseFrom(ByteBuffer data)

Parameter

Name	Description
data	ByteBuffer

Returns

Type	Description
Settings

Exceptions

Type	Description
InvalidProtocolBufferException

parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)

public static Settings parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)

Parameters

Name	Description
data	ByteBuffer
extensionRegistry	ExtensionRegistryLite

Returns

Type	Description
Settings

Exceptions

Type	Description
InvalidProtocolBufferException

parser()

public static Parser<Settings> parser()

Returns

Type	Description
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

Name	Description
key	String

Returns

Type	Description
boolean

equals(Object obj)

public boolean equals(Object obj)

Parameter

Name	Description
obj	Object

Returns

Type	Description
boolean

Overrides

AbstractMessage.equals(Object other)

getAnalysisConfig()

public Settings.AnalysisConfig getAnalysisConfig()

Default analysis settings.

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

Returns

Type	Description
Settings.AnalysisConfig	The analysisConfig.

getAnalysisConfigOrBuilder()

public Settings.AnalysisConfigOrBuilder getAnalysisConfigOrBuilder()

Default analysis settings.

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

Returns

Type	Description
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

Type	Description
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

Type	Description
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

Type	Description
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

Type	Description
TimestampOrBuilder

getDefaultInstanceForType()

public Settings getDefaultInstanceForType()

Returns

Type	Description
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

Type	Description
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

Type	Description
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

Type	Description
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

Type	Description
ByteString	The bytes for name.

getParserForType()

public Parser<Settings> getParserForType()

Returns

Type	Description
Parser<Settings>

Overrides

GeneratedMessageV3.getParserForType()

getPubsubNotificationSettings()

public Map<String,String> getPubsubNotificationSettings()

Use #getPubsubNotificationSettingsMap() instead.

Returns

Type	Description
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

Type	Description
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

Type	Description
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

Name	Description
key	String
defaultValue	String

Returns

Type	Description
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

Name	Description
key	String

Returns

Type	Description
String

getSerializedSize()

public int getSerializedSize()

Returns

Type	Description
int

Overrides

GeneratedMessageV3.getSerializedSize()

getUnknownFields()

public final UnknownFieldSet getUnknownFields()

Returns

Type	Description
UnknownFieldSet

Overrides

GeneratedMessageV3.getUnknownFields()

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

Type	Description
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

Type	Description
TimestampOrBuilder

hasAnalysisConfig()

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

Type	Description
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

Type	Description
boolean	Whether the createTime 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

Type	Description
boolean	Whether the updateTime field is set.

hashCode()

public int hashCode()

Returns

Type	Description
int

Overrides

AbstractMessage.hashCode()

internalGetFieldAccessorTable()

protected GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()

Returns

Type	Description
FieldAccessorTable

Overrides

GeneratedMessageV3.internalGetFieldAccessorTable()

internalGetMapField(int number)

protected MapField internalGetMapField(int number)

Parameter

Name	Description
number	int

Returns

Type	Description
MapField

Overrides

GeneratedMessageV3.internalGetMapField(int fieldNumber)

isInitialized()

public final boolean isInitialized()

Returns

Type	Description
boolean

Overrides

GeneratedMessageV3.isInitialized()

newBuilderForType()

public Settings.Builder newBuilderForType()

Returns

Type	Description
Settings.Builder

newBuilderForType(GeneratedMessageV3.BuilderParent parent)

protected Settings.Builder newBuilderForType(GeneratedMessageV3.BuilderParent parent)

Parameter

Name	Description
parent	BuilderParent

Returns

Type	Description
Settings.Builder

Overrides

GeneratedMessageV3.newBuilderForType(GeneratedMessageV3.BuilderParent parent)

newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)

protected Object newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)

Parameter

Name	Description
unused	UnusedPrivateParameter

Returns

Type	Description
Object

Overrides

GeneratedMessageV3.newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)

toBuilder()

public Settings.Builder toBuilder()

Returns

Type	Description
Settings.Builder

writeTo(CodedOutputStream output)

public void writeTo(CodedOutputStream output)

Parameter

Name	Description
output	CodedOutputStream

Overrides

GeneratedMessageV3.writeTo(CodedOutputStream output)

Exceptions

Type	Description
IOException