com.google.cloud.contactcenterinsights.v1

Class AnalysisRule

java.lang.Object

com.google.protobuf.AbstractMessageLite

com.google.protobuf.AbstractMessage

com.google.protobuf.GeneratedMessageV3

com.google.cloud.contactcenterinsights.v1.AnalysisRule

All Implemented Interfaces:

AnalysisRuleOrBuilder, com.google.protobuf.Message, com.google.protobuf.MessageLite, com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder, Serializable

public final class AnalysisRule
extends com.google.protobuf.GeneratedMessageV3
implements AnalysisRuleOrBuilder

 The CCAI Insights project wide analysis rule. This rule will be applied to
 all conversations that match the filter defined in the rule. For a
 conversation matches the filter, the annotators specified in the rule will be
 run. If a conversation matches multiple rules, a union of all the annotators
 will be run. One project can have multiple analysis rules.
 

Protobuf type google.cloud.contactcenterinsights.v1.AnalysisRule

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	AnalysisRule.Builder The CCAI Insights project wide analysis rule.

Nested classes/interfaces inherited from class com.google.protobuf.GeneratedMessageV3

com.google.protobuf.GeneratedMessageV3.BuilderParent, com.google.protobuf.GeneratedMessageV3.ExtendableBuilder<MessageT extends com.google.protobuf.GeneratedMessageV3.ExtendableMessage<MessageT>,BuilderT extends com.google.protobuf.GeneratedMessageV3.ExtendableBuilder<MessageT,BuilderT>>, com.google.protobuf.GeneratedMessageV3.ExtendableMessage<MessageT extends com.google.protobuf.GeneratedMessageV3.ExtendableMessage<MessageT>>, com.google.protobuf.GeneratedMessageV3.ExtendableMessageOrBuilder<MessageT extends com.google.protobuf.GeneratedMessageV3.ExtendableMessage<MessageT>>, com.google.protobuf.GeneratedMessageV3.FieldAccessorTable, com.google.protobuf.GeneratedMessageV3.UnusedPrivateParameter

Nested classes/interfaces inherited from class com.google.protobuf.AbstractMessageLite

com.google.protobuf.AbstractMessageLite.InternalOneOfEnum

Field Summary

Fields

Modifier and Type	Field and Description
static int	ACTIVE_FIELD_NUMBER
static int	ANALYSIS_PERCENTAGE_FIELD_NUMBER
static int	ANNOTATOR_SELECTOR_FIELD_NUMBER
static int	CONVERSATION_FILTER_FIELD_NUMBER
static int	CREATE_TIME_FIELD_NUMBER
static int	DISPLAY_NAME_FIELD_NUMBER
static int	NAME_FIELD_NUMBER
static int	UPDATE_TIME_FIELD_NUMBER

Fields inherited from class com.google.protobuf.GeneratedMessageV3

alwaysUseFieldBuilders, unknownFields

Fields inherited from class com.google.protobuf.AbstractMessage

memoizedSize

Fields inherited from class com.google.protobuf.AbstractMessageLite

memoizedHashCode

Method Summary

Modifier and Type	Method and Description
boolean	equals(Object obj)
boolean	getActive() If true, apply this rule to conversations.
double	getAnalysisPercentage() Percentage of conversations that we should apply this analysis setting automatically, between [0, 1].
AnnotatorSelector	getAnnotatorSelector() Selector of annotators to run and the phrase matchers to use for conversations that matches the conversation_filter.
AnnotatorSelectorOrBuilder	getAnnotatorSelectorOrBuilder() Selector of annotators to run and the phrase matchers to use for conversations that matches the conversation_filter.
String	getConversationFilter() Filter for the conversations that should apply this analysis rule.
com.google.protobuf.ByteString	getConversationFilterBytes() Filter for the conversations that should apply this analysis rule.
com.google.protobuf.Timestamp	getCreateTime() Output only.
com.google.protobuf.TimestampOrBuilder	getCreateTimeOrBuilder() Output only.
static AnalysisRule	getDefaultInstance()
AnalysisRule	getDefaultInstanceForType()
static com.google.protobuf.Descriptors.Descriptor	getDescriptor()
String	getDisplayName() Display Name of the analysis rule.
com.google.protobuf.ByteString	getDisplayNameBytes() Display Name of the analysis rule.
String	getName() Identifier.
com.google.protobuf.ByteString	getNameBytes() Identifier.
com.google.protobuf.Parser<AnalysisRule>	getParserForType()
int	getSerializedSize()
com.google.protobuf.Timestamp	getUpdateTime() Output only.
com.google.protobuf.TimestampOrBuilder	getUpdateTimeOrBuilder() Output only.
boolean	hasAnnotatorSelector() Selector of annotators to run and the phrase matchers to use for conversations that matches the conversation_filter.
boolean	hasCreateTime() Output only.
boolean	hasDisplayName() Display Name of the analysis rule.
int	hashCode()
boolean	hasUpdateTime() Output only.
protected com.google.protobuf.GeneratedMessageV3.FieldAccessorTable	internalGetFieldAccessorTable()
boolean	isInitialized()
static AnalysisRule.Builder	newBuilder()
static AnalysisRule.Builder	newBuilder(AnalysisRule prototype)
AnalysisRule.Builder	newBuilderForType()
protected AnalysisRule.Builder	newBuilderForType(com.google.protobuf.GeneratedMessageV3.BuilderParent parent)
protected Object	newInstance(com.google.protobuf.GeneratedMessageV3.UnusedPrivateParameter unused)
static AnalysisRule	parseDelimitedFrom(InputStream input)
static AnalysisRule	parseDelimitedFrom(InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
static AnalysisRule	parseFrom(byte[] data)
static AnalysisRule	parseFrom(byte[] data, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
static AnalysisRule	parseFrom(ByteBuffer data)
static AnalysisRule	parseFrom(ByteBuffer data, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
static AnalysisRule	parseFrom(com.google.protobuf.ByteString data)
static AnalysisRule	parseFrom(com.google.protobuf.ByteString data, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
static AnalysisRule	parseFrom(com.google.protobuf.CodedInputStream input)
static AnalysisRule	parseFrom(com.google.protobuf.CodedInputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
static AnalysisRule	parseFrom(InputStream input)
static AnalysisRule	parseFrom(InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
static com.google.protobuf.Parser<AnalysisRule>	parser()
AnalysisRule.Builder	toBuilder()
void	writeTo(com.google.protobuf.CodedOutputStream output)

Methods inherited from class com.google.protobuf.GeneratedMessageV3

canUseUnsafe, computeStringSize, computeStringSizeNoTag, emptyBooleanList, emptyDoubleList, emptyFloatList, emptyIntList, emptyList, emptyLongList, getAllFields, getDescriptorForType, getField, getOneofFieldDescriptor, getRepeatedField, getRepeatedFieldCount, getUnknownFields, hasField, hasOneof, internalGetMapField, internalGetMapFieldReflection, isStringEmpty, makeExtensionsImmutable, makeMutableCopy, makeMutableCopy, mergeFromAndMakeImmutableInternal, mutableCopy, mutableCopy, mutableCopy, mutableCopy, mutableCopy, newBooleanList, newBuilderForType, newDoubleList, newFloatList, newIntList, newLongList, parseDelimitedWithIOException, parseDelimitedWithIOException, parseUnknownField, parseUnknownFieldProto3, parseWithIOException, parseWithIOException, parseWithIOException, parseWithIOException, serializeBooleanMapTo, serializeIntegerMapTo, serializeLongMapTo, serializeStringMapTo, writeReplace, writeString, writeStringNoTag

Methods inherited from class com.google.protobuf.AbstractMessage

findInitializationErrors, getInitializationErrorString, hashBoolean, hashEnum, hashEnumList, hashFields, hashLong, toString

Methods inherited from class com.google.protobuf.AbstractMessageLite

addAll, addAll, checkByteStringIsUtf8, toByteArray, toByteString, writeDelimitedTo, writeTo

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface com.google.protobuf.MessageOrBuilder

findInitializationErrors, getAllFields, getDescriptorForType, getField, getInitializationErrorString, getOneofFieldDescriptor, getRepeatedField, getRepeatedFieldCount, getUnknownFields, hasField, hasOneof

Methods inherited from interface com.google.protobuf.MessageLite

toByteArray, toByteString, writeDelimitedTo, writeTo

Field Detail

NAME_FIELD_NUMBER

public static final int NAME_FIELD_NUMBER

See Also:

Constant Field Values

CREATE_TIME_FIELD_NUMBER

public static final int CREATE_TIME_FIELD_NUMBER

See Also:

Constant Field Values

UPDATE_TIME_FIELD_NUMBER

public static final int UPDATE_TIME_FIELD_NUMBER

See Also:

Constant Field Values

DISPLAY_NAME_FIELD_NUMBER

public static final int DISPLAY_NAME_FIELD_NUMBER

See Also:

Constant Field Values

CONVERSATION_FILTER_FIELD_NUMBER

public static final int CONVERSATION_FILTER_FIELD_NUMBER

See Also:

Constant Field Values

ANNOTATOR_SELECTOR_FIELD_NUMBER

public static final int ANNOTATOR_SELECTOR_FIELD_NUMBER

See Also:

Constant Field Values

ANALYSIS_PERCENTAGE_FIELD_NUMBER

public static final int ANALYSIS_PERCENTAGE_FIELD_NUMBER

See Also:

Constant Field Values

ACTIVE_FIELD_NUMBER

public static final int ACTIVE_FIELD_NUMBER

See Also:

Constant Field Values

Method Detail

newInstance

protected Object newInstance(com.google.protobuf.GeneratedMessageV3.UnusedPrivateParameter unused)

Overrides:

newInstance in class com.google.protobuf.GeneratedMessageV3

getDescriptor

public static final com.google.protobuf.Descriptors.Descriptor getDescriptor()

internalGetFieldAccessorTable

protected com.google.protobuf.GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()

Specified by:

internalGetFieldAccessorTable in class com.google.protobuf.GeneratedMessageV3

getName

public String getName()

 Identifier. The resource name of the analysis rule.
 Format:
 projects/{project}/locations/{location}/analysisRules/{analysis_rule}
 

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

Specified by:

getName in interface AnalysisRuleOrBuilder

Returns:

The name.

getNameBytes

public com.google.protobuf.ByteString getNameBytes()

 Identifier. The resource name of the analysis rule.
 Format:
 projects/{project}/locations/{location}/analysisRules/{analysis_rule}
 

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

Specified by:

getNameBytes in interface AnalysisRuleOrBuilder

Returns:

The bytes for name.

hasCreateTime

public boolean hasCreateTime()

 Output only. The time at which this analysis rule was created.
 

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

Specified by:

hasCreateTime in interface AnalysisRuleOrBuilder

Returns:

Whether the createTime field is set.

getCreateTime

public com.google.protobuf.Timestamp getCreateTime()

 Output only. The time at which this analysis rule was created.
 

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

Specified by:

getCreateTime in interface AnalysisRuleOrBuilder

Returns:

The createTime.

getCreateTimeOrBuilder

public com.google.protobuf.TimestampOrBuilder getCreateTimeOrBuilder()

 Output only. The time at which this analysis rule was created.
 

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

Specified by:

getCreateTimeOrBuilder in interface AnalysisRuleOrBuilder

hasUpdateTime

public boolean hasUpdateTime()

 Output only. The most recent time at which this analysis rule was updated.
 

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

Specified by:

hasUpdateTime in interface AnalysisRuleOrBuilder

Returns:

Whether the updateTime field is set.

getUpdateTime

public com.google.protobuf.Timestamp getUpdateTime()

 Output only. The most recent time at which this analysis rule was updated.
 

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

Specified by:

getUpdateTime in interface AnalysisRuleOrBuilder

Returns:

The updateTime.

getUpdateTimeOrBuilder

public com.google.protobuf.TimestampOrBuilder getUpdateTimeOrBuilder()

 Output only. The most recent time at which this analysis rule was updated.
 

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

Specified by:

getUpdateTimeOrBuilder in interface AnalysisRuleOrBuilder

hasDisplayName

public boolean hasDisplayName()

 Display Name of the analysis rule.
 

optional string display_name = 4;

Specified by:

hasDisplayName in interface AnalysisRuleOrBuilder

Returns:

Whether the displayName field is set.

getDisplayName

public String getDisplayName()

 Display Name of the analysis rule.
 

optional string display_name = 4;

Specified by:

getDisplayName in interface AnalysisRuleOrBuilder

Returns:

The displayName.

getDisplayNameBytes

public com.google.protobuf.ByteString getDisplayNameBytes()

 Display Name of the analysis rule.
 

optional string display_name = 4;

Specified by:

getDisplayNameBytes in interface AnalysisRuleOrBuilder

Returns:

The bytes for displayName.

getConversationFilter

public String getConversationFilter()

 Filter for the conversations that should apply this analysis
 rule. An empty filter means this analysis rule applies to all
 conversations.
 

string conversation_filter = 5;

Specified by:

getConversationFilter in interface AnalysisRuleOrBuilder

Returns:

The conversationFilter.

getConversationFilterBytes

public com.google.protobuf.ByteString getConversationFilterBytes()

 Filter for the conversations that should apply this analysis
 rule. An empty filter means this analysis rule applies to all
 conversations.
 

string conversation_filter = 5;

Specified by:

getConversationFilterBytes in interface AnalysisRuleOrBuilder

Returns:

The bytes for conversationFilter.

hasAnnotatorSelector

public boolean hasAnnotatorSelector()

 Selector of annotators to run and the phrase matchers to use for
 conversations that matches the conversation_filter. If not specified, NO
 annotators will be run.
 

.google.cloud.contactcenterinsights.v1.AnnotatorSelector annotator_selector = 6;

Specified by:

hasAnnotatorSelector in interface AnalysisRuleOrBuilder

Returns:

Whether the annotatorSelector field is set.

getAnnotatorSelector

public AnnotatorSelector getAnnotatorSelector()

 Selector of annotators to run and the phrase matchers to use for
 conversations that matches the conversation_filter. If not specified, NO
 annotators will be run.
 

.google.cloud.contactcenterinsights.v1.AnnotatorSelector annotator_selector = 6;

Specified by:

getAnnotatorSelector in interface AnalysisRuleOrBuilder

Returns:

The annotatorSelector.

getAnnotatorSelectorOrBuilder

public AnnotatorSelectorOrBuilder getAnnotatorSelectorOrBuilder()

 Selector of annotators to run and the phrase matchers to use for
 conversations that matches the conversation_filter. If not specified, NO
 annotators will be run.
 

.google.cloud.contactcenterinsights.v1.AnnotatorSelector annotator_selector = 6;

Specified by:

getAnnotatorSelectorOrBuilder in interface AnalysisRuleOrBuilder

getAnalysisPercentage

public double getAnalysisPercentage()

 Percentage of conversations that we should apply this analysis setting
 automatically, between [0, 1]. For example, 0.1 means 10%. Conversations
 are sampled in a determenestic way. The original runtime_percentage &
 upload percentage will be replaced by defining filters on the conversation.
 

double analysis_percentage = 7;

Specified by:

getAnalysisPercentage in interface AnalysisRuleOrBuilder

Returns:

The analysisPercentage.

getActive

public boolean getActive()

 If true, apply this rule to conversations. Otherwise, this rule is
 inactive and saved as a draft.
 

bool active = 8;

Specified by:

getActive in interface AnalysisRuleOrBuilder

Returns:

The active.

isInitialized

public final boolean isInitialized()

Specified by:

isInitialized in interface com.google.protobuf.MessageLiteOrBuilder

Overrides:

isInitialized in class com.google.protobuf.GeneratedMessageV3

writeTo

public void writeTo(com.google.protobuf.CodedOutputStream output)
             throws IOException

Specified by:

writeTo in interface com.google.protobuf.MessageLite

Overrides:

writeTo in class com.google.protobuf.GeneratedMessageV3

Throws:

IOException

getSerializedSize

public int getSerializedSize()

Specified by:

getSerializedSize in interface com.google.protobuf.MessageLite

Overrides:

getSerializedSize in class com.google.protobuf.GeneratedMessageV3

equals

public boolean equals(Object obj)

Specified by:

equals in interface com.google.protobuf.Message

Overrides:

equals in class com.google.protobuf.AbstractMessage

hashCode

public int hashCode()

Specified by:

hashCode in interface com.google.protobuf.Message

Overrides:

hashCode in class com.google.protobuf.AbstractMessage

parseFrom

public static AnalysisRule parseFrom(ByteBuffer data)
                              throws com.google.protobuf.InvalidProtocolBufferException

Throws:

com.google.protobuf.InvalidProtocolBufferException

parseFrom

public static AnalysisRule parseFrom(ByteBuffer data,
                                     com.google.protobuf.ExtensionRegistryLite extensionRegistry)
                              throws com.google.protobuf.InvalidProtocolBufferException

Throws:

com.google.protobuf.InvalidProtocolBufferException

parseFrom

public static AnalysisRule parseFrom(com.google.protobuf.ByteString data)
                              throws com.google.protobuf.InvalidProtocolBufferException

Throws:

com.google.protobuf.InvalidProtocolBufferException

parseFrom

public static AnalysisRule parseFrom(com.google.protobuf.ByteString data,
                                     com.google.protobuf.ExtensionRegistryLite extensionRegistry)
                              throws com.google.protobuf.InvalidProtocolBufferException

Throws:

com.google.protobuf.InvalidProtocolBufferException

parseFrom

public static AnalysisRule parseFrom(byte[] data)
                              throws com.google.protobuf.InvalidProtocolBufferException

Throws:

com.google.protobuf.InvalidProtocolBufferException

parseFrom

public static AnalysisRule parseFrom(byte[] data,
                                     com.google.protobuf.ExtensionRegistryLite extensionRegistry)
                              throws com.google.protobuf.InvalidProtocolBufferException

Throws:

com.google.protobuf.InvalidProtocolBufferException

parseFrom

public static AnalysisRule parseFrom(InputStream input)
                              throws IOException

Throws:

IOException

parseFrom

public static AnalysisRule parseFrom(InputStream input,
                                     com.google.protobuf.ExtensionRegistryLite extensionRegistry)
                              throws IOException

Throws:

IOException

parseDelimitedFrom

public static AnalysisRule parseDelimitedFrom(InputStream input)
                                       throws IOException

Throws:

IOException

parseDelimitedFrom

public static AnalysisRule parseDelimitedFrom(InputStream input,
                                              com.google.protobuf.ExtensionRegistryLite extensionRegistry)
                                       throws IOException

Throws:

IOException

parseFrom

public static AnalysisRule parseFrom(com.google.protobuf.CodedInputStream input)
                              throws IOException

Throws:

IOException

parseFrom

public static AnalysisRule parseFrom(com.google.protobuf.CodedInputStream input,
                                     com.google.protobuf.ExtensionRegistryLite extensionRegistry)
                              throws IOException

Throws:

IOException

newBuilderForType

public AnalysisRule.Builder newBuilderForType()

Specified by:

newBuilderForType in interface com.google.protobuf.Message

Specified by:

newBuilderForType in interface com.google.protobuf.MessageLite

newBuilder

public static AnalysisRule.Builder newBuilder()

newBuilder

public static AnalysisRule.Builder newBuilder(AnalysisRule prototype)

toBuilder

public AnalysisRule.Builder toBuilder()

Specified by:

toBuilder in interface com.google.protobuf.Message

Specified by:

toBuilder in interface com.google.protobuf.MessageLite

newBuilderForType

protected AnalysisRule.Builder newBuilderForType(com.google.protobuf.GeneratedMessageV3.BuilderParent parent)

Specified by:

newBuilderForType in class com.google.protobuf.GeneratedMessageV3

getDefaultInstance

public static AnalysisRule getDefaultInstance()

parser

public static com.google.protobuf.Parser<AnalysisRule> parser()

getParserForType

public com.google.protobuf.Parser<AnalysisRule> getParserForType()

Specified by:

getParserForType in interface com.google.protobuf.Message

Specified by:

getParserForType in interface com.google.protobuf.MessageLite

Overrides:

getParserForType in class com.google.protobuf.GeneratedMessageV3

getDefaultInstanceForType

public AnalysisRule getDefaultInstanceForType()

Specified by:

getDefaultInstanceForType in interface com.google.protobuf.MessageLiteOrBuilder

Specified by:

getDefaultInstanceForType in interface com.google.protobuf.MessageOrBuilder