Interface PhraseMatcherOrBuilder (2.48.0) 

public interface PhraseMatcherOrBuilder extends MessageOrBuilder

Implements

MessageOrBuilder

Methods

getActivationUpdateTime()

public abstract Timestamp getActivationUpdateTime()

Output only. The most recent time at which the activation status was updated.

.google.protobuf.Timestamp activation_update_time = 9 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
Timestamp

The activationUpdateTime.

getActivationUpdateTimeOrBuilder()

public abstract TimestampOrBuilder getActivationUpdateTimeOrBuilder()

Output only. The most recent time at which the activation status was updated.

.google.protobuf.Timestamp activation_update_time = 9 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
TimestampOrBuilder

getActive()

public abstract boolean getActive()

Applies the phrase matcher only when it is active.

bool active = 7;

Returns
Type Description
boolean

The active.

getDisplayName()

public abstract String getDisplayName()

The human-readable name of the phrase matcher.

string display_name = 5;

Returns
Type Description
String

The displayName.

getDisplayNameBytes()

public abstract ByteString getDisplayNameBytes()

The human-readable name of the phrase matcher.

string display_name = 5;

Returns
Type Description
ByteString

The bytes for displayName.

getName()

public abstract String getName()

The resource name of the phrase matcher. Format: projects/{project}/locations/{location}/phraseMatchers/{phrase_matcher}

string name = 1;

Returns
Type Description
String

The name.

getNameBytes()

public abstract ByteString getNameBytes()

The resource name of the phrase matcher. Format: projects/{project}/locations/{location}/phraseMatchers/{phrase_matcher}

string name = 1;

Returns
Type Description
ByteString

The bytes for name.

getPhraseMatchRuleGroups(int index)

public abstract PhraseMatchRuleGroup getPhraseMatchRuleGroups(int index)

A list of phase match rule groups that are included in this matcher.

repeated .google.cloud.contactcenterinsights.v1.PhraseMatchRuleGroup phrase_match_rule_groups = 8;

Parameter
Name Description
index int
Returns
Type Description
PhraseMatchRuleGroup

getPhraseMatchRuleGroupsCount()

public abstract int getPhraseMatchRuleGroupsCount()

A list of phase match rule groups that are included in this matcher.

repeated .google.cloud.contactcenterinsights.v1.PhraseMatchRuleGroup phrase_match_rule_groups = 8;

Returns
Type Description
int

getPhraseMatchRuleGroupsList()

public abstract List<PhraseMatchRuleGroup> getPhraseMatchRuleGroupsList()

A list of phase match rule groups that are included in this matcher.

repeated .google.cloud.contactcenterinsights.v1.PhraseMatchRuleGroup phrase_match_rule_groups = 8;

Returns
Type Description
List<PhraseMatchRuleGroup>

getPhraseMatchRuleGroupsOrBuilder(int index)

public abstract PhraseMatchRuleGroupOrBuilder getPhraseMatchRuleGroupsOrBuilder(int index)

A list of phase match rule groups that are included in this matcher.

repeated .google.cloud.contactcenterinsights.v1.PhraseMatchRuleGroup phrase_match_rule_groups = 8;

Parameter
Name Description
index int
Returns
Type Description
PhraseMatchRuleGroupOrBuilder

getPhraseMatchRuleGroupsOrBuilderList()

public abstract List<? extends PhraseMatchRuleGroupOrBuilder> getPhraseMatchRuleGroupsOrBuilderList()

A list of phase match rule groups that are included in this matcher.

repeated .google.cloud.contactcenterinsights.v1.PhraseMatchRuleGroup phrase_match_rule_groups = 8;

Returns
Type Description
List<? extends com.google.cloud.contactcenterinsights.v1.PhraseMatchRuleGroupOrBuilder>

getRevisionCreateTime()

public abstract Timestamp getRevisionCreateTime()

Output only. The timestamp of when the revision was created. It is also the create time when a new matcher is added.

.google.protobuf.Timestamp revision_create_time = 4 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
Timestamp

The revisionCreateTime.

getRevisionCreateTimeOrBuilder()

public abstract TimestampOrBuilder getRevisionCreateTimeOrBuilder()

Output only. The timestamp of when the revision was created. It is also the create time when a new matcher is added.

.google.protobuf.Timestamp revision_create_time = 4 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
TimestampOrBuilder

getRevisionId()

public abstract String getRevisionId()

Output only. Immutable. The revision ID of the phrase matcher. A new revision is committed whenever the matcher is changed, except when it is activated or deactivated. A server generated random ID will be used. Example: locations/global/phraseMatchers/my-first-matcher@1234567

string revision_id = 2 [(.google.api.field_behavior) = IMMUTABLE, (.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
String

The revisionId.

getRevisionIdBytes()

public abstract ByteString getRevisionIdBytes()

Output only. Immutable. The revision ID of the phrase matcher. A new revision is committed whenever the matcher is changed, except when it is activated or deactivated. A server generated random ID will be used. Example: locations/global/phraseMatchers/my-first-matcher@1234567

string revision_id = 2 [(.google.api.field_behavior) = IMMUTABLE, (.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
ByteString

The bytes for revisionId.

getRoleMatch()

public abstract ConversationParticipant.Role getRoleMatch()

The role whose utterances the phrase matcher should be matched against. If the role is ROLE_UNSPECIFIED it will be matched against any utterances in the transcript.

.google.cloud.contactcenterinsights.v1.ConversationParticipant.Role role_match = 10;

Returns
Type Description
ConversationParticipant.Role

The roleMatch.

getRoleMatchValue()

public abstract int getRoleMatchValue()

The role whose utterances the phrase matcher should be matched against. If the role is ROLE_UNSPECIFIED it will be matched against any utterances in the transcript.

.google.cloud.contactcenterinsights.v1.ConversationParticipant.Role role_match = 10;

Returns
Type Description
int

The enum numeric value on the wire for roleMatch.

getType()

public abstract PhraseMatcher.PhraseMatcherType getType()

Required. The type of this phrase matcher.

.google.cloud.contactcenterinsights.v1.PhraseMatcher.PhraseMatcherType type = 6 [(.google.api.field_behavior) = REQUIRED];

Returns
Type Description
PhraseMatcher.PhraseMatcherType

The type.

getTypeValue()

public abstract int getTypeValue()

Required. The type of this phrase matcher.

.google.cloud.contactcenterinsights.v1.PhraseMatcher.PhraseMatcherType type = 6 [(.google.api.field_behavior) = REQUIRED];

Returns
Type Description
int

The enum numeric value on the wire for type.

getUpdateTime()

public abstract Timestamp getUpdateTime()

Output only. The most recent time at which the phrase matcher was updated.

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

Returns
Type Description
Timestamp

The updateTime.

getUpdateTimeOrBuilder()

public abstract TimestampOrBuilder getUpdateTimeOrBuilder()

Output only. The most recent time at which the phrase matcher was updated.

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

Returns
Type Description
TimestampOrBuilder

getVersionTag()

public abstract String getVersionTag()

The customized version tag to use for the phrase matcher. If not specified, it will default to revision_id.

string version_tag = 3;

Returns
Type Description
String

The versionTag.

getVersionTagBytes()

public abstract ByteString getVersionTagBytes()

The customized version tag to use for the phrase matcher. If not specified, it will default to revision_id.

string version_tag = 3;

Returns
Type Description
ByteString

The bytes for versionTag.

hasActivationUpdateTime()

public abstract boolean hasActivationUpdateTime()

Output only. The most recent time at which the activation status was updated.

.google.protobuf.Timestamp activation_update_time = 9 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
boolean

Whether the activationUpdateTime field is set.

hasRevisionCreateTime()

public abstract boolean hasRevisionCreateTime()

Output only. The timestamp of when the revision was created. It is also the create time when a new matcher is added.

.google.protobuf.Timestamp revision_create_time = 4 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
boolean

Whether the revisionCreateTime field is set.

hasUpdateTime()

public abstract boolean hasUpdateTime()

Output only. The most recent time at which the phrase matcher was updated.

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

Returns
Type Description
boolean

Whether the updateTime field is set.