Package com.google.cloud.contactcenterinsights.v1

Class PhraseMatcher

  • All Implemented Interfaces:
    PhraseMatcherOrBuilder, com.google.protobuf.Message, com.google.protobuf.MessageLite, com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder, Serializable
    public final class PhraseMatcher
extends com.google.protobuf.GeneratedMessageV3
implements PhraseMatcherOrBuilder
     The phrase matcher resource.
    Protobuf type google.cloud.contactcenterinsights.v1.PhraseMatcher
    See Also:
    Serialized Form

    • Field Detail

      • REVISION_ID_FIELD_NUMBER

        public static final int REVISION_ID_FIELD_NUMBER
        See Also:
        Constant Field Values

      • VERSION_TAG_FIELD_NUMBER

        public static final int VERSION_TAG_FIELD_NUMBER
        See Also:
        Constant Field Values

      • REVISION_CREATE_TIME_FIELD_NUMBER

        public static final int REVISION_CREATE_TIME_FIELD_NUMBER
        See Also:
        Constant Field Values

      • DISPLAY_NAME_FIELD_NUMBER

        public static final int DISPLAY_NAME_FIELD_NUMBER
        See Also:
        Constant Field Values

      • PHRASE_MATCH_RULE_GROUPS_FIELD_NUMBER

        public static final int PHRASE_MATCH_RULE_GROUPS_FIELD_NUMBER
        See Also:
        Constant Field Values

      • ACTIVATION_UPDATE_TIME_FIELD_NUMBER

        public static final int ACTIVATION_UPDATE_TIME_FIELD_NUMBER
        See Also:
        Constant Field Values

      • ROLE_MATCH_FIELD_NUMBER

        public static final int ROLE_MATCH_FIELD_NUMBER
        See Also:
        Constant Field Values

      • UPDATE_TIME_FIELD_NUMBER

        public static final int UPDATE_TIME_FIELD_NUMBER
        See Also:
        Constant Field Values

    • Method Detail

      • newInstance

        protected Object newInstance​(com.google.protobuf.GeneratedMessageV3.UnusedPrivateParameter unused)
        Overrides:
        newInstance in class com.google.protobuf.GeneratedMessageV3

      • getDescriptor

        public static final com.google.protobuf.Descriptors.Descriptor getDescriptor()

      • internalGetFieldAccessorTable

        protected com.google.protobuf.GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
        Specified by:
        internalGetFieldAccessorTable in class com.google.protobuf.GeneratedMessageV3

      • getName

        public String getName()
         The resource name of the phrase matcher.
 Format:
 projects/{project}/locations/{location}/phraseMatchers/{phrase_matcher}
        string name = 1;
        Specified by:
        getName in interface PhraseMatcherOrBuilder
        Returns:
        The name.

      • getNameBytes

        public com.google.protobuf.ByteString getNameBytes()
         The resource name of the phrase matcher.
 Format:
 projects/{project}/locations/{location}/phraseMatchers/{phrase_matcher}
        string name = 1;
        Specified by:
        getNameBytes in interface PhraseMatcherOrBuilder
        Returns:
        The bytes for name.

      • 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];
        Specified by:
        getRevisionId in interface PhraseMatcherOrBuilder
        Returns:
        The revisionId.

      • getRevisionIdBytes

        public com.google.protobuf.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];
        Specified by:
        getRevisionIdBytes in interface PhraseMatcherOrBuilder
        Returns:
        The bytes for revisionId.

      • 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;
        Specified by:
        getVersionTag in interface PhraseMatcherOrBuilder
        Returns:
        The versionTag.

      • getVersionTagBytes

        public com.google.protobuf.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;
        Specified by:
        getVersionTagBytes in interface PhraseMatcherOrBuilder
        Returns:
        The bytes for versionTag.

      • 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];
        Specified by:
        hasRevisionCreateTime in interface PhraseMatcherOrBuilder
        Returns:
        Whether the revisionCreateTime field is set.

      • getRevisionCreateTime

        public com.google.protobuf.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];
        Specified by:
        getRevisionCreateTime in interface PhraseMatcherOrBuilder
        Returns:
        The revisionCreateTime.

      • getRevisionCreateTimeOrBuilder

        public com.google.protobuf.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];
        Specified by:
        getRevisionCreateTimeOrBuilder in interface PhraseMatcherOrBuilder

      • getDisplayName

        public String getDisplayName()
         The human-readable name of the phrase matcher.
        string display_name = 5;
        Specified by:
        getDisplayName in interface PhraseMatcherOrBuilder
        Returns:
        The displayName.

      • getDisplayNameBytes

        public com.google.protobuf.ByteString getDisplayNameBytes()
         The human-readable name of the phrase matcher.
        string display_name = 5;
        Specified by:
        getDisplayNameBytes in interface PhraseMatcherOrBuilder
        Returns:
        The bytes for displayName.

      • getTypeValue

        public int getTypeValue()
         Required. The type of this phrase matcher.
        .google.cloud.contactcenterinsights.v1.PhraseMatcher.PhraseMatcherType type = 6 [(.google.api.field_behavior) = REQUIRED];
        Specified by:
        getTypeValue in interface PhraseMatcherOrBuilder
        Returns:
        The enum numeric value on the wire for type.

      • 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];
        Specified by:
        getType in interface PhraseMatcherOrBuilder
        Returns:
        The type.

      • getActive

        public boolean getActive()
         Applies the phrase matcher only when it is active.
        bool active = 7;
        Specified by:
        getActive in interface PhraseMatcherOrBuilder
        Returns:
        The active.

      • 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;
        Specified by:
        getPhraseMatchRuleGroupsCount in interface PhraseMatcherOrBuilder

      • getPhraseMatchRuleGroups

        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;
        Specified by:
        getPhraseMatchRuleGroups in interface PhraseMatcherOrBuilder

      • 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];
        Specified by:
        hasActivationUpdateTime in interface PhraseMatcherOrBuilder
        Returns:
        Whether the activationUpdateTime field is set.

      • getActivationUpdateTime

        public com.google.protobuf.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];
        Specified by:
        getActivationUpdateTime in interface PhraseMatcherOrBuilder
        Returns:
        The activationUpdateTime.

      • getActivationUpdateTimeOrBuilder

        public com.google.protobuf.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];
        Specified by:
        getActivationUpdateTimeOrBuilder in interface PhraseMatcherOrBuilder

      • 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;
        Specified by:
        getRoleMatchValue in interface PhraseMatcherOrBuilder
        Returns:
        The enum numeric value on the wire for roleMatch.

      • 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;
        Specified by:
        getRoleMatch in interface PhraseMatcherOrBuilder
        Returns:
        The roleMatch.

      • 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];
        Specified by:
        hasUpdateTime in interface PhraseMatcherOrBuilder
        Returns:
        Whether the updateTime field is set.

      • getUpdateTime

        public com.google.protobuf.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];
        Specified by:
        getUpdateTime in interface PhraseMatcherOrBuilder
        Returns:
        The updateTime.

      • getUpdateTimeOrBuilder

        public com.google.protobuf.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];
        Specified by:
        getUpdateTimeOrBuilder in interface PhraseMatcherOrBuilder

      • isInitialized

        public final boolean isInitialized()
        Specified by:
        isInitialized in interface com.google.protobuf.MessageLiteOrBuilder
        Overrides:
        isInitialized in class com.google.protobuf.GeneratedMessageV3

      • writeTo

        public void writeTo​(com.google.protobuf.CodedOutputStream output)
             throws IOException
        Specified by:
        writeTo in interface com.google.protobuf.MessageLite
        Overrides:
        writeTo in class com.google.protobuf.GeneratedMessageV3
        Throws:
        IOException

      • getSerializedSize

        public int getSerializedSize()
        Specified by:
        getSerializedSize in interface com.google.protobuf.MessageLite
        Overrides:
        getSerializedSize in class com.google.protobuf.GeneratedMessageV3

      • equals

        public boolean equals​(Object obj)
        Specified by:
        equals in interface com.google.protobuf.Message
        Overrides:
        equals in class com.google.protobuf.AbstractMessage

      • hashCode

        public int hashCode()
        Specified by:
        hashCode in interface com.google.protobuf.Message
        Overrides:
        hashCode in class com.google.protobuf.AbstractMessage

      • parseFrom

        public static PhraseMatcher parseFrom​(ByteBuffer data)
                               throws com.google.protobuf.InvalidProtocolBufferException
        Throws:
        com.google.protobuf.InvalidProtocolBufferException

      • parseFrom

        public static PhraseMatcher parseFrom​(ByteBuffer data,
                                      com.google.protobuf.ExtensionRegistryLite extensionRegistry)
                               throws com.google.protobuf.InvalidProtocolBufferException
        Throws:
        com.google.protobuf.InvalidProtocolBufferException

      • parseFrom

        public static PhraseMatcher parseFrom​(com.google.protobuf.ByteString data)
                               throws com.google.protobuf.InvalidProtocolBufferException
        Throws:
        com.google.protobuf.InvalidProtocolBufferException

      • parseFrom

        public static PhraseMatcher parseFrom​(com.google.protobuf.ByteString data,
                                      com.google.protobuf.ExtensionRegistryLite extensionRegistry)
                               throws com.google.protobuf.InvalidProtocolBufferException
        Throws:
        com.google.protobuf.InvalidProtocolBufferException

      • parseFrom

        public static PhraseMatcher parseFrom​(byte[] data)
                               throws com.google.protobuf.InvalidProtocolBufferException
        Throws:
        com.google.protobuf.InvalidProtocolBufferException

      • parseFrom

        public static PhraseMatcher parseFrom​(byte[] data,
                                      com.google.protobuf.ExtensionRegistryLite extensionRegistry)
                               throws com.google.protobuf.InvalidProtocolBufferException
        Throws:
        com.google.protobuf.InvalidProtocolBufferException

      • parseFrom

        public static PhraseMatcher parseFrom​(com.google.protobuf.CodedInputStream input,
                                      com.google.protobuf.ExtensionRegistryLite extensionRegistry)
                               throws IOException
        Throws:
        IOException

      • newBuilderForType

        public PhraseMatcher.Builder newBuilderForType()
        Specified by:
        newBuilderForType in interface com.google.protobuf.Message
        Specified by:
        newBuilderForType in interface com.google.protobuf.MessageLite

      • toBuilder

        public PhraseMatcher.Builder toBuilder()
        Specified by:
        toBuilder in interface com.google.protobuf.Message
        Specified by:
        toBuilder in interface com.google.protobuf.MessageLite

      • newBuilderForType

        protected PhraseMatcher.Builder newBuilderForType​(com.google.protobuf.GeneratedMessageV3.BuilderParent parent)
        Specified by:
        newBuilderForType in class com.google.protobuf.GeneratedMessageV3

      • getDefaultInstance

        public static PhraseMatcher getDefaultInstance()

      • parser

        public static com.google.protobuf.Parser<PhraseMatcher> parser()

      • getParserForType

        public com.google.protobuf.Parser<PhraseMatcher> getParserForType()
        Specified by:
        getParserForType in interface com.google.protobuf.Message
        Specified by:
        getParserForType in interface com.google.protobuf.MessageLite
        Overrides:
        getParserForType in class com.google.protobuf.GeneratedMessageV3

      • getDefaultInstanceForType

        public PhraseMatcher getDefaultInstanceForType()
        Specified by:
        getDefaultInstanceForType in interface com.google.protobuf.MessageLiteOrBuilder
        Specified by:
        getDefaultInstanceForType in interface com.google.protobuf.MessageOrBuilder