Package com.google.cloud.contactcenterinsights.v1

Interface PhraseMatcherOrBuilder

  • All Superinterfaces:
    com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder
    All Known Implementing Classes:
    PhraseMatcher, PhraseMatcher.Builder
    public interface PhraseMatcherOrBuilder
extends com.google.protobuf.MessageOrBuilder

    • Method Detail

      • getName

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

      • getNameBytes

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

      • getRevisionId

        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:
        The revisionId.

      • getRevisionIdBytes

        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];
        Returns:
        The bytes for revisionId.

      • getVersionTag

        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:
        The versionTag.

      • getVersionTagBytes

        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;
        Returns:
        The bytes for versionTag.

      • hasRevisionCreateTime

        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:
        Whether the revisionCreateTime field is set.

      • getRevisionCreateTime

        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];
        Returns:
        The revisionCreateTime.

      • getRevisionCreateTimeOrBuilder

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

      • getDisplayName

        String getDisplayName()
         The human-readable name of the phrase matcher.
        string display_name = 5;
        Returns:
        The displayName.

      • getDisplayNameBytes

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

      • getTypeValue

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

      • getType

        PhraseMatcher.PhraseMatcherType getType()
         Required. The type of this phrase matcher.
        .google.cloud.contactcenterinsights.v1.PhraseMatcher.PhraseMatcherType type = 6 [(.google.api.field_behavior) = REQUIRED];
        Returns:
        The type.

      • getActive

        boolean getActive()
         Applies the phrase matcher only when it is active.
        bool active = 7;
        Returns:
        The active.

      • getPhraseMatchRuleGroupsList

        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;

      • getPhraseMatchRuleGroups

        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;

      • getPhraseMatchRuleGroupsCount

        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;

      • getPhraseMatchRuleGroupsOrBuilderList

        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;

      • getPhraseMatchRuleGroupsOrBuilder

        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;

      • hasActivationUpdateTime

        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:
        Whether the activationUpdateTime field is set.

      • getActivationUpdateTime

        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];
        Returns:
        The activationUpdateTime.

      • getActivationUpdateTimeOrBuilder

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

      • getRoleMatchValue

        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:
        The enum numeric value on the wire for roleMatch.

      • getRoleMatch

        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:
        The roleMatch.

      • hasUpdateTime

        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:
        Whether the updateTime field is set.

      • getUpdateTime

        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];
        Returns:
        The updateTime.

      • getUpdateTimeOrBuilder

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