com.google.cloud.contactcenterinsights.v1

Interface AnalysisRuleOrBuilder

All Superinterfaces:

com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder

All Known Implementing Classes:

AnalysisRule, AnalysisRule.Builder

public interface AnalysisRuleOrBuilder
extends com.google.protobuf.MessageOrBuilder

Method Summary

Modifier and Type	Method and Description
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.
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.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.

Methods inherited from interface com.google.protobuf.MessageOrBuilder

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

Methods inherited from interface com.google.protobuf.MessageLiteOrBuilder

isInitialized

Method Detail

getName

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:

The name.

getNameBytes

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

Returns:

The bytes for name.

hasCreateTime

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:

Whether the createTime field is set.

getCreateTime

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

Returns:

The createTime.

getCreateTimeOrBuilder

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

hasUpdateTime

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:

Whether the updateTime field is set.

getUpdateTime

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

Returns:

The updateTime.

getUpdateTimeOrBuilder

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

hasDisplayName

boolean hasDisplayName()

 Display Name of the analysis rule.
 

optional string display_name = 4;

Returns:

Whether the displayName field is set.

getDisplayName

String getDisplayName()

 Display Name of the analysis rule.
 

optional string display_name = 4;

Returns:

The displayName.

getDisplayNameBytes

com.google.protobuf.ByteString getDisplayNameBytes()

 Display Name of the analysis rule.
 

optional string display_name = 4;

Returns:

The bytes for displayName.

getConversationFilter

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:

The conversationFilter.

getConversationFilterBytes

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;

Returns:

The bytes for conversationFilter.

hasAnnotatorSelector

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:

Whether the annotatorSelector field is set.

getAnnotatorSelector

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:

The annotatorSelector.

getAnnotatorSelectorOrBuilder

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;

getAnalysisPercentage

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:

The analysisPercentage.

getActive

boolean getActive()

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

bool active = 8;

Returns:

The active.