public static final class AnalysisRule.Builder extends com.google.protobuf.GeneratedMessageV3.Builder<AnalysisRule.Builder> 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| Modifier and Type | Method and Description |
|---|---|
AnalysisRule.Builder |
addRepeatedField(com.google.protobuf.Descriptors.FieldDescriptor field,
Object value) |
AnalysisRule |
build() |
AnalysisRule |
buildPartial() |
AnalysisRule.Builder |
clear() |
AnalysisRule.Builder |
clearActive()
If true, apply this rule to conversations.
|
AnalysisRule.Builder |
clearAnalysisPercentage()
Percentage of conversations that we should apply this analysis setting
automatically, between [0, 1].
|
AnalysisRule.Builder |
clearAnnotatorSelector()
Selector of annotators to run and the phrase matchers to use for
conversations that matches the conversation_filter.
|
AnalysisRule.Builder |
clearConversationFilter()
Filter for the conversations that should apply this analysis
rule.
|
AnalysisRule.Builder |
clearCreateTime()
Output only.
|
AnalysisRule.Builder |
clearDisplayName()
Display Name of the analysis rule.
|
AnalysisRule.Builder |
clearField(com.google.protobuf.Descriptors.FieldDescriptor field) |
AnalysisRule.Builder |
clearName()
Identifier.
|
AnalysisRule.Builder |
clearOneof(com.google.protobuf.Descriptors.OneofDescriptor oneof) |
AnalysisRule.Builder |
clearUpdateTime()
Output only.
|
AnalysisRule.Builder |
clone() |
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.
|
AnnotatorSelector.Builder |
getAnnotatorSelectorBuilder()
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.Timestamp.Builder |
getCreateTimeBuilder()
Output only.
|
com.google.protobuf.TimestampOrBuilder |
getCreateTimeOrBuilder()
Output only.
|
AnalysisRule |
getDefaultInstanceForType() |
static com.google.protobuf.Descriptors.Descriptor |
getDescriptor() |
com.google.protobuf.Descriptors.Descriptor |
getDescriptorForType() |
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.Timestamp |
getUpdateTime()
Output only.
|
com.google.protobuf.Timestamp.Builder |
getUpdateTimeBuilder()
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.
|
boolean |
hasUpdateTime()
Output only.
|
protected com.google.protobuf.GeneratedMessageV3.FieldAccessorTable |
internalGetFieldAccessorTable() |
boolean |
isInitialized() |
AnalysisRule.Builder |
mergeAnnotatorSelector(AnnotatorSelector value)
Selector of annotators to run and the phrase matchers to use for
conversations that matches the conversation_filter.
|
AnalysisRule.Builder |
mergeCreateTime(com.google.protobuf.Timestamp value)
Output only.
|
AnalysisRule.Builder |
mergeFrom(AnalysisRule other) |
AnalysisRule.Builder |
mergeFrom(com.google.protobuf.CodedInputStream input,
com.google.protobuf.ExtensionRegistryLite extensionRegistry) |
AnalysisRule.Builder |
mergeFrom(com.google.protobuf.Message other) |
AnalysisRule.Builder |
mergeUnknownFields(com.google.protobuf.UnknownFieldSet unknownFields) |
AnalysisRule.Builder |
mergeUpdateTime(com.google.protobuf.Timestamp value)
Output only.
|
AnalysisRule.Builder |
setActive(boolean value)
If true, apply this rule to conversations.
|
AnalysisRule.Builder |
setAnalysisPercentage(double value)
Percentage of conversations that we should apply this analysis setting
automatically, between [0, 1].
|
AnalysisRule.Builder |
setAnnotatorSelector(AnnotatorSelector.Builder builderForValue)
Selector of annotators to run and the phrase matchers to use for
conversations that matches the conversation_filter.
|
AnalysisRule.Builder |
setAnnotatorSelector(AnnotatorSelector value)
Selector of annotators to run and the phrase matchers to use for
conversations that matches the conversation_filter.
|
AnalysisRule.Builder |
setConversationFilter(String value)
Filter for the conversations that should apply this analysis
rule.
|
AnalysisRule.Builder |
setConversationFilterBytes(com.google.protobuf.ByteString value)
Filter for the conversations that should apply this analysis
rule.
|
AnalysisRule.Builder |
setCreateTime(com.google.protobuf.Timestamp.Builder builderForValue)
Output only.
|
AnalysisRule.Builder |
setCreateTime(com.google.protobuf.Timestamp value)
Output only.
|
AnalysisRule.Builder |
setDisplayName(String value)
Display Name of the analysis rule.
|
AnalysisRule.Builder |
setDisplayNameBytes(com.google.protobuf.ByteString value)
Display Name of the analysis rule.
|
AnalysisRule.Builder |
setField(com.google.protobuf.Descriptors.FieldDescriptor field,
Object value) |
AnalysisRule.Builder |
setName(String value)
Identifier.
|
AnalysisRule.Builder |
setNameBytes(com.google.protobuf.ByteString value)
Identifier.
|
AnalysisRule.Builder |
setRepeatedField(com.google.protobuf.Descriptors.FieldDescriptor field,
int index,
Object value) |
AnalysisRule.Builder |
setUnknownFields(com.google.protobuf.UnknownFieldSet unknownFields) |
AnalysisRule.Builder |
setUpdateTime(com.google.protobuf.Timestamp.Builder builderForValue)
Output only.
|
AnalysisRule.Builder |
setUpdateTime(com.google.protobuf.Timestamp value)
Output only.
|
getAllFields, getField, getFieldBuilder, getOneofFieldDescriptor, getParentForChildren, getRepeatedField, getRepeatedFieldBuilder, getRepeatedFieldCount, getUnknownFields, getUnknownFieldSetBuilder, hasField, hasOneof, internalGetMapField, internalGetMapFieldReflection, internalGetMutableMapField, internalGetMutableMapFieldReflection, isClean, markClean, mergeUnknownLengthDelimitedField, mergeUnknownVarintField, newBuilderForField, onBuilt, onChanged, parseUnknownField, setUnknownFieldSetBuilder, setUnknownFieldsProto3findInitializationErrors, getInitializationErrorString, internalMergeFrom, mergeFrom, mergeFrom, mergeFrom, mergeFrom, mergeFrom, mergeFrom, mergeFrom, mergeFrom, mergeFrom, newUninitializedMessageException, toStringaddAll, addAll, mergeDelimitedFrom, mergeDelimitedFrom, newUninitializedMessageExceptionequals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, waitpublic static final com.google.protobuf.Descriptors.Descriptor getDescriptor()
protected com.google.protobuf.GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
internalGetFieldAccessorTable in class com.google.protobuf.GeneratedMessageV3.Builder<AnalysisRule.Builder>public AnalysisRule.Builder clear()
clear in interface com.google.protobuf.Message.Builderclear in interface com.google.protobuf.MessageLite.Builderclear in class com.google.protobuf.GeneratedMessageV3.Builder<AnalysisRule.Builder>public com.google.protobuf.Descriptors.Descriptor getDescriptorForType()
getDescriptorForType in interface com.google.protobuf.Message.BuildergetDescriptorForType in interface com.google.protobuf.MessageOrBuildergetDescriptorForType in class com.google.protobuf.GeneratedMessageV3.Builder<AnalysisRule.Builder>public AnalysisRule getDefaultInstanceForType()
getDefaultInstanceForType in interface com.google.protobuf.MessageLiteOrBuildergetDefaultInstanceForType in interface com.google.protobuf.MessageOrBuilderpublic AnalysisRule build()
build in interface com.google.protobuf.Message.Builderbuild in interface com.google.protobuf.MessageLite.Builderpublic AnalysisRule buildPartial()
buildPartial in interface com.google.protobuf.Message.BuilderbuildPartial in interface com.google.protobuf.MessageLite.Builderpublic AnalysisRule.Builder clone()
clone in interface com.google.protobuf.Message.Builderclone in interface com.google.protobuf.MessageLite.Builderclone in class com.google.protobuf.GeneratedMessageV3.Builder<AnalysisRule.Builder>public AnalysisRule.Builder setField(com.google.protobuf.Descriptors.FieldDescriptor field, Object value)
setField in interface com.google.protobuf.Message.BuildersetField in class com.google.protobuf.GeneratedMessageV3.Builder<AnalysisRule.Builder>public AnalysisRule.Builder clearField(com.google.protobuf.Descriptors.FieldDescriptor field)
clearField in interface com.google.protobuf.Message.BuilderclearField in class com.google.protobuf.GeneratedMessageV3.Builder<AnalysisRule.Builder>public AnalysisRule.Builder clearOneof(com.google.protobuf.Descriptors.OneofDescriptor oneof)
clearOneof in interface com.google.protobuf.Message.BuilderclearOneof in class com.google.protobuf.GeneratedMessageV3.Builder<AnalysisRule.Builder>public AnalysisRule.Builder setRepeatedField(com.google.protobuf.Descriptors.FieldDescriptor field, int index, Object value)
setRepeatedField in interface com.google.protobuf.Message.BuildersetRepeatedField in class com.google.protobuf.GeneratedMessageV3.Builder<AnalysisRule.Builder>public AnalysisRule.Builder addRepeatedField(com.google.protobuf.Descriptors.FieldDescriptor field, Object value)
addRepeatedField in interface com.google.protobuf.Message.BuilderaddRepeatedField in class com.google.protobuf.GeneratedMessageV3.Builder<AnalysisRule.Builder>public AnalysisRule.Builder mergeFrom(com.google.protobuf.Message other)
mergeFrom in interface com.google.protobuf.Message.BuildermergeFrom in class com.google.protobuf.AbstractMessage.Builder<AnalysisRule.Builder>public AnalysisRule.Builder mergeFrom(AnalysisRule other)
public final boolean isInitialized()
isInitialized in interface com.google.protobuf.MessageLiteOrBuilderisInitialized in class com.google.protobuf.GeneratedMessageV3.Builder<AnalysisRule.Builder>public AnalysisRule.Builder mergeFrom(com.google.protobuf.CodedInputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws IOException
mergeFrom in interface com.google.protobuf.Message.BuildermergeFrom in interface com.google.protobuf.MessageLite.BuildermergeFrom in class com.google.protobuf.AbstractMessage.Builder<AnalysisRule.Builder>IOExceptionpublic 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];getName in interface AnalysisRuleOrBuilderpublic 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];getNameBytes in interface AnalysisRuleOrBuilderpublic AnalysisRule.Builder setName(String value)
Identifier. The resource name of the analysis rule.
Format:
projects/{project}/locations/{location}/analysisRules/{analysis_rule}
string name = 1 [(.google.api.field_behavior) = IDENTIFIER];value - The name to set.public AnalysisRule.Builder clearName()
Identifier. The resource name of the analysis rule.
Format:
projects/{project}/locations/{location}/analysisRules/{analysis_rule}
string name = 1 [(.google.api.field_behavior) = IDENTIFIER];public AnalysisRule.Builder setNameBytes(com.google.protobuf.ByteString value)
Identifier. The resource name of the analysis rule.
Format:
projects/{project}/locations/{location}/analysisRules/{analysis_rule}
string name = 1 [(.google.api.field_behavior) = IDENTIFIER];value - The bytes for name to set.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];
hasCreateTime in interface AnalysisRuleOrBuilderpublic 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];
getCreateTime in interface AnalysisRuleOrBuilderpublic AnalysisRule.Builder setCreateTime(com.google.protobuf.Timestamp value)
Output only. The time at which this analysis rule was created.
.google.protobuf.Timestamp create_time = 2 [(.google.api.field_behavior) = OUTPUT_ONLY];
public AnalysisRule.Builder setCreateTime(com.google.protobuf.Timestamp.Builder builderForValue)
Output only. The time at which this analysis rule was created.
.google.protobuf.Timestamp create_time = 2 [(.google.api.field_behavior) = OUTPUT_ONLY];
public AnalysisRule.Builder mergeCreateTime(com.google.protobuf.Timestamp value)
Output only. The time at which this analysis rule was created.
.google.protobuf.Timestamp create_time = 2 [(.google.api.field_behavior) = OUTPUT_ONLY];
public AnalysisRule.Builder clearCreateTime()
Output only. The time at which this analysis rule was created.
.google.protobuf.Timestamp create_time = 2 [(.google.api.field_behavior) = OUTPUT_ONLY];
public com.google.protobuf.Timestamp.Builder getCreateTimeBuilder()
Output only. The time at which this analysis rule was created.
.google.protobuf.Timestamp create_time = 2 [(.google.api.field_behavior) = OUTPUT_ONLY];
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];
getCreateTimeOrBuilder in interface AnalysisRuleOrBuilderpublic 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];
hasUpdateTime in interface AnalysisRuleOrBuilderpublic 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];
getUpdateTime in interface AnalysisRuleOrBuilderpublic AnalysisRule.Builder setUpdateTime(com.google.protobuf.Timestamp value)
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];
public AnalysisRule.Builder setUpdateTime(com.google.protobuf.Timestamp.Builder builderForValue)
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];
public AnalysisRule.Builder mergeUpdateTime(com.google.protobuf.Timestamp value)
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];
public AnalysisRule.Builder clearUpdateTime()
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];
public com.google.protobuf.Timestamp.Builder getUpdateTimeBuilder()
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];
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];
getUpdateTimeOrBuilder in interface AnalysisRuleOrBuilderpublic boolean hasDisplayName()
Display Name of the analysis rule.
optional string display_name = 4;hasDisplayName in interface AnalysisRuleOrBuilderpublic String getDisplayName()
Display Name of the analysis rule.
optional string display_name = 4;getDisplayName in interface AnalysisRuleOrBuilderpublic com.google.protobuf.ByteString getDisplayNameBytes()
Display Name of the analysis rule.
optional string display_name = 4;getDisplayNameBytes in interface AnalysisRuleOrBuilderpublic AnalysisRule.Builder setDisplayName(String value)
Display Name of the analysis rule.
optional string display_name = 4;value - The displayName to set.public AnalysisRule.Builder clearDisplayName()
Display Name of the analysis rule.
optional string display_name = 4;public AnalysisRule.Builder setDisplayNameBytes(com.google.protobuf.ByteString value)
Display Name of the analysis rule.
optional string display_name = 4;value - The bytes for displayName to set.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;getConversationFilter in interface AnalysisRuleOrBuilderpublic 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;getConversationFilterBytes in interface AnalysisRuleOrBuilderpublic AnalysisRule.Builder setConversationFilter(String value)
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;value - The conversationFilter to set.public AnalysisRule.Builder clearConversationFilter()
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;public AnalysisRule.Builder setConversationFilterBytes(com.google.protobuf.ByteString value)
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;value - The bytes for conversationFilter to set.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;hasAnnotatorSelector in interface AnalysisRuleOrBuilderpublic 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;getAnnotatorSelector in interface AnalysisRuleOrBuilderpublic AnalysisRule.Builder setAnnotatorSelector(AnnotatorSelector value)
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;public AnalysisRule.Builder setAnnotatorSelector(AnnotatorSelector.Builder builderForValue)
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;public AnalysisRule.Builder mergeAnnotatorSelector(AnnotatorSelector value)
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;public AnalysisRule.Builder clearAnnotatorSelector()
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;public AnnotatorSelector.Builder getAnnotatorSelectorBuilder()
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;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;getAnnotatorSelectorOrBuilder in interface AnalysisRuleOrBuilderpublic 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;getAnalysisPercentage in interface AnalysisRuleOrBuilderpublic AnalysisRule.Builder setAnalysisPercentage(double value)
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;value - The analysisPercentage to set.public AnalysisRule.Builder clearAnalysisPercentage()
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;public boolean getActive()
If true, apply this rule to conversations. Otherwise, this rule is inactive and saved as a draft.
bool active = 8;getActive in interface AnalysisRuleOrBuilderpublic AnalysisRule.Builder setActive(boolean value)
If true, apply this rule to conversations. Otherwise, this rule is inactive and saved as a draft.
bool active = 8;value - The active to set.public AnalysisRule.Builder clearActive()
If true, apply this rule to conversations. Otherwise, this rule is inactive and saved as a draft.
bool active = 8;public final AnalysisRule.Builder setUnknownFields(com.google.protobuf.UnknownFieldSet unknownFields)
setUnknownFields in interface com.google.protobuf.Message.BuildersetUnknownFields in class com.google.protobuf.GeneratedMessageV3.Builder<AnalysisRule.Builder>public final AnalysisRule.Builder mergeUnknownFields(com.google.protobuf.UnknownFieldSet unknownFields)
mergeUnknownFields in interface com.google.protobuf.Message.BuildermergeUnknownFields in class com.google.protobuf.GeneratedMessageV3.Builder<AnalysisRule.Builder>Copyright © 2025 Google LLC. All rights reserved.