public final class PhraseMatcher extends GeneratedMessageV3 implements PhraseMatcherOrBuilder
   
   The phrase matcher resource.
 Protobuf type google.cloud.contactcenterinsights.v1.PhraseMatcher
 
  
  
  
  Static Fields
  
  
  
    public static final int ACTIVATION_UPDATE_TIME_FIELD_NUMBER
   
  Field Value
  
  
  
    public static final int ACTIVE_FIELD_NUMBER
   
  Field Value
  
  
  
    public static final int DISPLAY_NAME_FIELD_NUMBER
   
  Field Value
  
  
  
    public static final int NAME_FIELD_NUMBER
   
  Field Value
  
  
  
    public static final int PHRASE_MATCH_RULE_GROUPS_FIELD_NUMBER
   
  Field Value
  
  
  
    public static final int REVISION_CREATE_TIME_FIELD_NUMBER
   
  Field Value
  
  
  
    public static final int REVISION_ID_FIELD_NUMBER
   
  Field Value
  
  
  
    public static final int ROLE_MATCH_FIELD_NUMBER
   
  Field Value
  
  
  
    public static final int TYPE_FIELD_NUMBER
   
  Field Value
  
  
  
    public static final int UPDATE_TIME_FIELD_NUMBER
   
  Field Value
  
  
  
    public static final int VERSION_TAG_FIELD_NUMBER
   
  Field Value
  
  Static Methods
  
  
  
  
    public static PhraseMatcher getDefaultInstance()
   
  Returns
  
  
  
  
    public static final Descriptors.Descriptor getDescriptor()
   
  Returns
  
  
  
  
    public static PhraseMatcher.Builder newBuilder()
   
  Returns
  
  
  
  
    public static PhraseMatcher.Builder newBuilder(PhraseMatcher prototype)
   
  Parameter
  
  Returns
  
  
  
  
    public static PhraseMatcher parseDelimitedFrom(InputStream input)
   
  Parameter
  
  Returns
  
  Exceptions
  
  
  
  
    public static PhraseMatcher parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
   
  Parameters
  
  Returns
  
  Exceptions
  
  
  
  
    public static PhraseMatcher parseFrom(byte[] data)
   
  Parameter
  
    
      
        | Name | 
        Description | 
      
      
        | data | 
        byte[]
  | 
      
    
  
  Returns
  
  Exceptions
  
  
  
  
    public static PhraseMatcher parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)
   
  Parameters
  
  Returns
  
  Exceptions
  
  
  
  
    public static PhraseMatcher parseFrom(ByteString data)
   
  Parameter
  
  Returns
  
  Exceptions
  
  
  
  
    public static PhraseMatcher parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)
   
  Parameters
  
  Returns
  
  Exceptions
  
  
  
  
    public static PhraseMatcher parseFrom(CodedInputStream input)
   
  Parameter
  
  Returns
  
  Exceptions
  
  
  
  
    public static PhraseMatcher parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
   
  Parameters
  
  Returns
  
  Exceptions
  
  
  
  
    public static PhraseMatcher parseFrom(InputStream input)
   
  Parameter
  
  Returns
  
  Exceptions
  
  
  
  
    public static PhraseMatcher parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
   
  Parameters
  
  Returns
  
  Exceptions
  
  
  
  
    public static PhraseMatcher parseFrom(ByteBuffer data)
   
  Parameter
  
  Returns
  
  Exceptions
  
  
  
  
    public static PhraseMatcher parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)
   
  Parameters
  
  Returns
  
  Exceptions
  
  
  
  
    public static Parser<PhraseMatcher> parser()
   
  Returns
  
  Methods
  
  
  
  
    public boolean equals(Object obj)
   
  Parameter
  
  Returns
  
  Overrides
  
  
  
  
    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
  
    
      
        | Type | 
        Description | 
      
      
        | Timestamp | 
        The activationUpdateTime. 
 | 
      
    
  
  
  
  
    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
  
  
  
  
    public boolean getActive()
   
   Applies the phrase matcher only when it is active.
 bool active = 7;
 
  Returns
  
    
      
        | Type | 
        Description | 
      
      
        | boolean | 
        The active. 
 | 
      
    
  
  
  
  
    public PhraseMatcher getDefaultInstanceForType()
   
  Returns
  
  
  
  
    public String getDisplayName()
   
   The human-readable name of the phrase matcher.
 string display_name = 5;
 
  Returns
  
    
      
        | Type | 
        Description | 
      
      
        | String | 
        The displayName. 
 | 
      
    
  
  
  
  
    public ByteString getDisplayNameBytes()
   
   The human-readable name of the phrase matcher.
 string display_name = 5;
 
  Returns
  
    
      
        | Type | 
        Description | 
      
      
        | ByteString | 
        The bytes for displayName. 
 | 
      
    
  
  
  
  
   The resource name of the phrase matcher.
 Format:
 projects/{project}/locations/{location}/phraseMatchers/{phrase_matcher}
 string name = 1;
 
  Returns
  
    
      
        | Type | 
        Description | 
      
      
        | String | 
        The name. 
 | 
      
    
  
  
  
  
    public ByteString getNameBytes()
   
   The resource name of the phrase matcher.
 Format:
 projects/{project}/locations/{location}/phraseMatchers/{phrase_matcher}
 string name = 1;
 
  Returns
  
  
  
  
    public Parser<PhraseMatcher> getParserForType()
   
  Returns
  
  Overrides
  
  
  
  
    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
  
    
      
        | Name | 
        Description | 
      
      
        | index | 
        int
  | 
      
    
  
  Returns
  
  
  
  
    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
  
  
  
  
    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
  
  
  
  
    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
  
    
      
        | Name | 
        Description | 
      
      
        | index | 
        int
  | 
      
    
  
  Returns
  
  
  
  
    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
  
    
      
        | Type | 
        Description | 
      
      
        | List<? extends com.google.cloud.contactcenterinsights.v1.PhraseMatchRuleGroupOrBuilder> | 
         | 
      
    
  
  
  
  
    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
  
    
      
        | Type | 
        Description | 
      
      
        | Timestamp | 
        The revisionCreateTime. 
 | 
      
    
  
  
  
  
    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
  
  
  
  
    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
  
    
      
        | Type | 
        Description | 
      
      
        | String | 
        The revisionId. 
 | 
      
    
  
  
  
  
    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
  
    
      
        | Type | 
        Description | 
      
      
        | ByteString | 
        The bytes for revisionId. 
 | 
      
    
  
  
  
  
    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
  
  
  
  
    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
  
    
      
        | Type | 
        Description | 
      
      
        | int | 
        The enum numeric value on the wire for roleMatch. 
 | 
      
    
  
  
  
  
    public int getSerializedSize()
   
  Returns
  
  Overrides
  
  
  
  
    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
  
  
  
  
    public 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. 
 | 
      
    
  
  
  
  
    public final UnknownFieldSet getUnknownFields()
   
  Returns
  
  Overrides
  
  
  
  
    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
  
  
  
  
    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
  
  
  
  
    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
  
    
      
        | Type | 
        Description | 
      
      
        | String | 
        The versionTag. 
 | 
      
    
  
  
  
  
    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
  
    
      
        | Type | 
        Description | 
      
      
        | ByteString | 
        The bytes for versionTag. 
 | 
      
    
  
  
  
  
    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
  
    
      
        | Type | 
        Description | 
      
      
        | boolean | 
        Whether the activationUpdateTime field is set. 
 | 
      
    
  
  
  
  
    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
  
    
      
        | Type | 
        Description | 
      
      
        | boolean | 
        Whether the revisionCreateTime field is set. 
 | 
      
    
  
  
  
  
    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
  
    
      
        | Type | 
        Description | 
      
      
        | boolean | 
        Whether the updateTime field is set. 
 | 
      
    
  
  
  
  
  Returns
  
  Overrides
  
  
  
  
    protected GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
   
  Returns
  
  Overrides
  
  
  
  
    public final boolean isInitialized()
   
  Returns
  
  Overrides
  
  
  
  
    public PhraseMatcher.Builder newBuilderForType()
   
  Returns
  
  
  
  
    protected PhraseMatcher.Builder newBuilderForType(GeneratedMessageV3.BuilderParent parent)
   
  Parameter
  
  Returns
  
  Overrides
  
  
  
  
    protected Object newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)
   
  Parameter
  
  Returns
  
  Overrides
  
  
  
  
    public PhraseMatcher.Builder toBuilder()
   
  Returns
  
  
  
  
    public void writeTo(CodedOutputStream output)
   
  Parameter
  
  Overrides
  
  Exceptions