Class PhraseMatcher (2.19.0)

public final class PhraseMatcher extends GeneratedMessageV3 implements PhraseMatcherOrBuilder

The phrase matcher resource.

Protobuf type google.cloud.contactcenterinsights.v1.PhraseMatcher

Static Fields

ACTIVATION_UPDATE_TIME_FIELD_NUMBER

public static final int ACTIVATION_UPDATE_TIME_FIELD_NUMBER
Field Value
TypeDescription
int

ACTIVE_FIELD_NUMBER

public static final int ACTIVE_FIELD_NUMBER
Field Value
TypeDescription
int

DISPLAY_NAME_FIELD_NUMBER

public static final int DISPLAY_NAME_FIELD_NUMBER
Field Value
TypeDescription
int

NAME_FIELD_NUMBER

public static final int NAME_FIELD_NUMBER
Field Value
TypeDescription
int

PHRASE_MATCH_RULE_GROUPS_FIELD_NUMBER

public static final int PHRASE_MATCH_RULE_GROUPS_FIELD_NUMBER
Field Value
TypeDescription
int

REVISION_CREATE_TIME_FIELD_NUMBER

public static final int REVISION_CREATE_TIME_FIELD_NUMBER
Field Value
TypeDescription
int

REVISION_ID_FIELD_NUMBER

public static final int REVISION_ID_FIELD_NUMBER
Field Value
TypeDescription
int

ROLE_MATCH_FIELD_NUMBER

public static final int ROLE_MATCH_FIELD_NUMBER
Field Value
TypeDescription
int

TYPE_FIELD_NUMBER

public static final int TYPE_FIELD_NUMBER
Field Value
TypeDescription
int

UPDATE_TIME_FIELD_NUMBER

public static final int UPDATE_TIME_FIELD_NUMBER
Field Value
TypeDescription
int

VERSION_TAG_FIELD_NUMBER

public static final int VERSION_TAG_FIELD_NUMBER
Field Value
TypeDescription
int

Static Methods

getDefaultInstance()

public static PhraseMatcher getDefaultInstance()
Returns
TypeDescription
PhraseMatcher

getDescriptor()

public static final Descriptors.Descriptor getDescriptor()
Returns
TypeDescription
Descriptor

newBuilder()

public static PhraseMatcher.Builder newBuilder()
Returns
TypeDescription
PhraseMatcher.Builder

newBuilder(PhraseMatcher prototype)

public static PhraseMatcher.Builder newBuilder(PhraseMatcher prototype)
Parameter
NameDescription
prototypePhraseMatcher
Returns
TypeDescription
PhraseMatcher.Builder

parseDelimitedFrom(InputStream input)

public static PhraseMatcher parseDelimitedFrom(InputStream input)
Parameter
NameDescription
inputInputStream
Returns
TypeDescription
PhraseMatcher
Exceptions
TypeDescription
IOException

parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

public static PhraseMatcher parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
NameDescription
inputInputStream
extensionRegistryExtensionRegistryLite
Returns
TypeDescription
PhraseMatcher
Exceptions
TypeDescription
IOException

parseFrom(byte[] data)

public static PhraseMatcher parseFrom(byte[] data)
Parameter
NameDescription
databyte[]
Returns
TypeDescription
PhraseMatcher
Exceptions
TypeDescription
InvalidProtocolBufferException

parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)

public static PhraseMatcher parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)
Parameters
NameDescription
databyte[]
extensionRegistryExtensionRegistryLite
Returns
TypeDescription
PhraseMatcher
Exceptions
TypeDescription
InvalidProtocolBufferException

parseFrom(ByteString data)

public static PhraseMatcher parseFrom(ByteString data)
Parameter
NameDescription
dataByteString
Returns
TypeDescription
PhraseMatcher
Exceptions
TypeDescription
InvalidProtocolBufferException

parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)

public static PhraseMatcher parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)
Parameters
NameDescription
dataByteString
extensionRegistryExtensionRegistryLite
Returns
TypeDescription
PhraseMatcher
Exceptions
TypeDescription
InvalidProtocolBufferException

parseFrom(CodedInputStream input)

public static PhraseMatcher parseFrom(CodedInputStream input)
Parameter
NameDescription
inputCodedInputStream
Returns
TypeDescription
PhraseMatcher
Exceptions
TypeDescription
IOException

parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

public static PhraseMatcher parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
NameDescription
inputCodedInputStream
extensionRegistryExtensionRegistryLite
Returns
TypeDescription
PhraseMatcher
Exceptions
TypeDescription
IOException

parseFrom(InputStream input)

public static PhraseMatcher parseFrom(InputStream input)
Parameter
NameDescription
inputInputStream
Returns
TypeDescription
PhraseMatcher
Exceptions
TypeDescription
IOException

parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

public static PhraseMatcher parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
NameDescription
inputInputStream
extensionRegistryExtensionRegistryLite
Returns
TypeDescription
PhraseMatcher
Exceptions
TypeDescription
IOException

parseFrom(ByteBuffer data)

public static PhraseMatcher parseFrom(ByteBuffer data)
Parameter
NameDescription
dataByteBuffer
Returns
TypeDescription
PhraseMatcher
Exceptions
TypeDescription
InvalidProtocolBufferException

parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)

public static PhraseMatcher parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)
Parameters
NameDescription
dataByteBuffer
extensionRegistryExtensionRegistryLite
Returns
TypeDescription
PhraseMatcher
Exceptions
TypeDescription
InvalidProtocolBufferException

parser()

public static Parser<PhraseMatcher> parser()
Returns
TypeDescription
Parser<PhraseMatcher>

Methods

equals(Object obj)

public boolean equals(Object obj)
Parameter
NameDescription
objObject
Returns
TypeDescription
boolean
Overrides

getActivationUpdateTime()

public 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
TypeDescription
Timestamp

The activationUpdateTime.

getActivationUpdateTimeOrBuilder()

public 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
TypeDescription
TimestampOrBuilder

getActive()

public boolean getActive()

Applies the phrase matcher only when it is active.

bool active = 7;

Returns
TypeDescription
boolean

The active.

getDefaultInstanceForType()

public PhraseMatcher getDefaultInstanceForType()
Returns
TypeDescription
PhraseMatcher

getDisplayName()

public String getDisplayName()

The human-readable name of the phrase matcher.

string display_name = 5;

Returns
TypeDescription
String

The displayName.

getDisplayNameBytes()

public ByteString getDisplayNameBytes()

The human-readable name of the phrase matcher.

string display_name = 5;

Returns
TypeDescription
ByteString

The bytes for displayName.

getName()

public String getName()

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

string name = 1;

Returns
TypeDescription
String

The name.

getNameBytes()

public ByteString getNameBytes()

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

string name = 1;

Returns
TypeDescription
ByteString

The bytes for name.

getParserForType()

public Parser<PhraseMatcher> getParserForType()
Returns
TypeDescription
Parser<PhraseMatcher>
Overrides

getPhraseMatchRuleGroups(int index)

public 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
NameDescription
indexint
Returns
TypeDescription
PhraseMatchRuleGroup

getPhraseMatchRuleGroupsCount()

public 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
TypeDescription
int

getPhraseMatchRuleGroupsList()

public 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
TypeDescription
List<PhraseMatchRuleGroup>

getPhraseMatchRuleGroupsOrBuilder(int index)

public 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
NameDescription
indexint
Returns
TypeDescription
PhraseMatchRuleGroupOrBuilder

getPhraseMatchRuleGroupsOrBuilderList()

public 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
TypeDescription
List<? extends com.google.cloud.contactcenterinsights.v1.PhraseMatchRuleGroupOrBuilder>

getRevisionCreateTime()

public 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
TypeDescription
Timestamp

The revisionCreateTime.

getRevisionCreateTimeOrBuilder()

public 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
TypeDescription
TimestampOrBuilder

getRevisionId()

public 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
TypeDescription
String

The revisionId.

getRevisionIdBytes()

public 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
TypeDescription
ByteString

The bytes for revisionId.

getRoleMatch()

public 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
TypeDescription
ConversationParticipant.Role

The roleMatch.

getRoleMatchValue()

public 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
TypeDescription
int

The enum numeric value on the wire for roleMatch.

getSerializedSize()

public int getSerializedSize()
Returns
TypeDescription
int
Overrides

getType()

public PhraseMatcher.PhraseMatcherType getType()

Required. The type of this phrase matcher.

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

Returns
TypeDescription
PhraseMatcher.PhraseMatcherType

The type.

getTypeValue()

public int getTypeValue()

Required. The type of this phrase matcher.

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

Returns
TypeDescription
int

The enum numeric value on the wire for type.

getUpdateTime()

public 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
TypeDescription
Timestamp

The updateTime.

getUpdateTimeOrBuilder()

public 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
TypeDescription
TimestampOrBuilder

getVersionTag()

public 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
TypeDescription
String

The versionTag.

getVersionTagBytes()

public 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
TypeDescription
ByteString

The bytes for versionTag.

hasActivationUpdateTime()

public 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
TypeDescription
boolean

Whether the activationUpdateTime field is set.

hasRevisionCreateTime()

public 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
TypeDescription
boolean

Whether the revisionCreateTime field is set.

hasUpdateTime()

public 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
TypeDescription
boolean

Whether the updateTime field is set.

hashCode()

public int hashCode()
Returns
TypeDescription
int
Overrides

internalGetFieldAccessorTable()

protected GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
Returns
TypeDescription
FieldAccessorTable
Overrides

isInitialized()

public final boolean isInitialized()
Returns
TypeDescription
boolean
Overrides

newBuilderForType()

public PhraseMatcher.Builder newBuilderForType()
Returns
TypeDescription
PhraseMatcher.Builder

newBuilderForType(GeneratedMessageV3.BuilderParent parent)

protected PhraseMatcher.Builder newBuilderForType(GeneratedMessageV3.BuilderParent parent)
Parameter
NameDescription
parentBuilderParent
Returns
TypeDescription
PhraseMatcher.Builder
Overrides

newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)

protected Object newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)
Parameter
NameDescription
unusedUnusedPrivateParameter
Returns
TypeDescription
Object
Overrides

toBuilder()

public PhraseMatcher.Builder toBuilder()
Returns
TypeDescription
PhraseMatcher.Builder

writeTo(CodedOutputStream output)

public void writeTo(CodedOutputStream output)
Parameter
NameDescription
outputCodedOutputStream
Overrides
Exceptions
TypeDescription
IOException