Class AnalysisRule.Builder (2.54.0) 

public static final class AnalysisRule.Builder extends 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

Inheritance

Object > AbstractMessageLite.Builder<MessageType,BuilderType> > AbstractMessage.Builder<BuilderType> > GeneratedMessageV3.Builder > AnalysisRule.Builder

Static Methods

getDescriptor()

public static final Descriptors.Descriptor getDescriptor()
Returns
Type Description
Descriptor

Methods

addRepeatedField(Descriptors.FieldDescriptor field, Object value)

public AnalysisRule.Builder addRepeatedField(Descriptors.FieldDescriptor field, Object value)
Parameters
Name Description
field FieldDescriptor
value Object
Returns
Type Description
AnalysisRule.Builder
Overrides

build()

public AnalysisRule build()
Returns
Type Description
AnalysisRule

buildPartial()

public AnalysisRule buildPartial()
Returns
Type Description
AnalysisRule

clear()

public AnalysisRule.Builder clear()
Returns
Type Description
AnalysisRule.Builder
Overrides

clearActive()

public AnalysisRule.Builder clearActive()

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

bool active = 8;

Returns
Type Description
AnalysisRule.Builder

This builder for chaining.

clearAnalysisPercentage()

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;

Returns
Type Description
AnalysisRule.Builder

This builder for chaining.

clearAnnotatorSelector()

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;

Returns
Type Description
AnalysisRule.Builder

clearConversationFilter()

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;

Returns
Type Description
AnalysisRule.Builder

This builder for chaining.

clearCreateTime()

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];

Returns
Type Description
AnalysisRule.Builder

clearDisplayName()

public AnalysisRule.Builder clearDisplayName()

Display Name of the analysis rule.

optional string display_name = 4;

Returns
Type Description
AnalysisRule.Builder

This builder for chaining.

clearField(Descriptors.FieldDescriptor field)

public AnalysisRule.Builder clearField(Descriptors.FieldDescriptor field)
Parameter
Name Description
field FieldDescriptor
Returns
Type Description
AnalysisRule.Builder
Overrides

clearName()

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];

Returns
Type Description
AnalysisRule.Builder

This builder for chaining.

clearOneof(Descriptors.OneofDescriptor oneof)

public AnalysisRule.Builder clearOneof(Descriptors.OneofDescriptor oneof)
Parameter
Name Description
oneof OneofDescriptor
Returns
Type Description
AnalysisRule.Builder
Overrides

clearUpdateTime()

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];

Returns
Type Description
AnalysisRule.Builder

clone()

public AnalysisRule.Builder clone()
Returns
Type Description
AnalysisRule.Builder
Overrides

getActive()

public boolean getActive()

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

bool active = 8;

Returns
Type Description
boolean

The active.

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;

Returns
Type Description
double

The analysisPercentage.

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;

Returns
Type Description
AnnotatorSelector

The annotatorSelector.

getAnnotatorSelectorBuilder()

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;

Returns
Type Description
AnnotatorSelector.Builder

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;

Returns
Type Description
AnnotatorSelectorOrBuilder

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;

Returns
Type Description
String

The conversationFilter.

getConversationFilterBytes()

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

Returns
Type Description
ByteString

The bytes for conversationFilter.

getCreateTime()

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

Returns
Type Description
Timestamp

The createTime.

getCreateTimeBuilder()

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

Returns
Type Description
Builder

getCreateTimeOrBuilder()

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

Returns
Type Description
TimestampOrBuilder

getDefaultInstanceForType()

public AnalysisRule getDefaultInstanceForType()
Returns
Type Description
AnalysisRule

getDescriptorForType()

public Descriptors.Descriptor getDescriptorForType()
Returns
Type Description
Descriptor
Overrides

getDisplayName()

public String getDisplayName()

Display Name of the analysis rule.

optional string display_name = 4;

Returns
Type Description
String

The displayName.

getDisplayNameBytes()

public ByteString getDisplayNameBytes()

Display Name of the analysis rule.

optional string display_name = 4;

Returns
Type Description
ByteString

The bytes for displayName.

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];

Returns
Type Description
String

The name.

getNameBytes()

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

Returns
Type Description
ByteString

The bytes for name.

getUpdateTime()

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

Returns
Type Description
Timestamp

The updateTime.

getUpdateTimeBuilder()

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

Returns
Type Description
Builder

getUpdateTimeOrBuilder()

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

Returns
Type Description
TimestampOrBuilder

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;

Returns
Type Description
boolean

Whether the annotatorSelector field is set.

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];

Returns
Type Description
boolean

Whether the createTime field is set.

hasDisplayName()

public boolean hasDisplayName()

Display Name of the analysis rule.

optional string display_name = 4;

Returns
Type Description
boolean

Whether the displayName field is set.

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];

Returns
Type Description
boolean

Whether the updateTime field is set.

internalGetFieldAccessorTable()

protected GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
Returns
Type Description
FieldAccessorTable
Overrides

isInitialized()

public final boolean isInitialized()
Returns
Type Description
boolean
Overrides

mergeAnnotatorSelector(AnnotatorSelector value)

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;

Parameter
Name Description
value AnnotatorSelector
Returns
Type Description
AnalysisRule.Builder

mergeCreateTime(Timestamp value)

public AnalysisRule.Builder mergeCreateTime(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];

Parameter
Name Description
value Timestamp
Returns
Type Description
AnalysisRule.Builder

mergeFrom(AnalysisRule other)

public AnalysisRule.Builder mergeFrom(AnalysisRule other)
Parameter
Name Description
other AnalysisRule
Returns
Type Description
AnalysisRule.Builder

mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

public AnalysisRule.Builder mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
input CodedInputStream
extensionRegistry ExtensionRegistryLite
Returns
Type Description
AnalysisRule.Builder
Overrides
Exceptions
Type Description
IOException

mergeFrom(Message other)

public AnalysisRule.Builder mergeFrom(Message other)
Parameter
Name Description
other Message
Returns
Type Description
AnalysisRule.Builder
Overrides

mergeUnknownFields(UnknownFieldSet unknownFields)

public final AnalysisRule.Builder mergeUnknownFields(UnknownFieldSet unknownFields)
Parameter
Name Description
unknownFields UnknownFieldSet
Returns
Type Description
AnalysisRule.Builder
Overrides

mergeUpdateTime(Timestamp value)

public AnalysisRule.Builder mergeUpdateTime(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];

Parameter
Name Description
value Timestamp
Returns
Type Description
AnalysisRule.Builder

setActive(boolean value)

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

Parameter
Name Description
value boolean

The active to set.
Returns
Type Description
AnalysisRule.Builder

This builder for chaining.

setAnalysisPercentage(double value)

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

Parameter
Name Description
value double

The analysisPercentage to set.
Returns
Type Description
AnalysisRule.Builder

This builder for chaining.

setAnnotatorSelector(AnnotatorSelector value)

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

Parameter
Name Description
value AnnotatorSelector
Returns
Type Description
AnalysisRule.Builder

setAnnotatorSelector(AnnotatorSelector.Builder builderForValue)

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;

Parameter
Name Description
builderForValue AnnotatorSelector.Builder
Returns
Type Description
AnalysisRule.Builder

setConversationFilter(String value)

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

Parameter
Name Description
value String

The conversationFilter to set.
Returns
Type Description
AnalysisRule.Builder

This builder for chaining.

setConversationFilterBytes(ByteString value)

public AnalysisRule.Builder setConversationFilterBytes(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;

Parameter
Name Description
value ByteString

The bytes for conversationFilter to set.
Returns
Type Description
AnalysisRule.Builder

This builder for chaining.

setCreateTime(Timestamp value)

public AnalysisRule.Builder setCreateTime(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];

Parameter
Name Description
value Timestamp
Returns
Type Description
AnalysisRule.Builder

setCreateTime(Timestamp.Builder builderForValue)

public AnalysisRule.Builder setCreateTime(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];

Parameter
Name Description
builderForValue Builder
Returns
Type Description
AnalysisRule.Builder

setDisplayName(String value)

public AnalysisRule.Builder setDisplayName(String value)

Display Name of the analysis rule.

optional string display_name = 4;

Parameter
Name Description
value String

The displayName to set.
Returns
Type Description
AnalysisRule.Builder

This builder for chaining.

setDisplayNameBytes(ByteString value)

public AnalysisRule.Builder setDisplayNameBytes(ByteString value)

Display Name of the analysis rule.

optional string display_name = 4;

Parameter
Name Description
value ByteString

The bytes for displayName to set.
Returns
Type Description
AnalysisRule.Builder

This builder for chaining.

setField(Descriptors.FieldDescriptor field, Object value)

public AnalysisRule.Builder setField(Descriptors.FieldDescriptor field, Object value)
Parameters
Name Description
field FieldDescriptor
value Object
Returns
Type Description
AnalysisRule.Builder
Overrides

setName(String value)

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

Parameter
Name Description
value String

The name to set.
Returns
Type Description
AnalysisRule.Builder

This builder for chaining.

setNameBytes(ByteString value)

public AnalysisRule.Builder setNameBytes(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];

Parameter
Name Description
value ByteString

The bytes for name to set.
Returns
Type Description
AnalysisRule.Builder

This builder for chaining.

setRepeatedField(Descriptors.FieldDescriptor field, int index, Object value)

public AnalysisRule.Builder setRepeatedField(Descriptors.FieldDescriptor field, int index, Object value)
Parameters
Name Description
field FieldDescriptor
index int
value Object
Returns
Type Description
AnalysisRule.Builder
Overrides

setUnknownFields(UnknownFieldSet unknownFields)

public final AnalysisRule.Builder setUnknownFields(UnknownFieldSet unknownFields)
Parameter
Name Description
unknownFields UnknownFieldSet
Returns
Type Description
AnalysisRule.Builder
Overrides

setUpdateTime(Timestamp value)

public AnalysisRule.Builder setUpdateTime(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];

Parameter
Name Description
value Timestamp
Returns
Type Description
AnalysisRule.Builder

setUpdateTime(Timestamp.Builder builderForValue)

public AnalysisRule.Builder setUpdateTime(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];

Parameter
Name Description
builderForValue Builder
Returns
Type Description
AnalysisRule.Builder