# Interface PhraseMatcherOrBuilder (2.93.0)

2.93.0 (latest) 2.91.0 2.88.0 2.87.0 2.85.0 2.83.0 2.82.0 2.81.0 2.80.0 2.78.0 2.76.0 2.75.0 2.74.0 2.73.0 2.72.0 2.70.0 2.68.0 2.67.0 2.64.0 2.63.0 2.62.0 2.60.0 2.59.0 2.58.0 2.57.0 2.56.0 2.55.0 2.54.0 2.53.0 2.52.0 2.51.0 2.49.0 2.48.0 2.47.0 2.46.0 2.45.0 2.44.0 2.43.0 2.42.0 2.41.0 2.40.0 2.39.0 2.37.0 2.36.0 2.35.0 2.34.0 2.33.0 2.32.0 2.31.0 2.30.0 2.29.0 2.28.0 2.27.0 2.24.0 2.23.0 2.22.0 2.21.0 2.20.0 2.19.0 2.18.0 2.17.0 2.16.0 2.15.0 2.14.0 2.13.0 2.12.0 2.11.0 2.10.0 2.9.0 2.8.0 2.7.0 2.6.0 2.5.0 2.4.0 2.3.10 2.2.7

    public interface PhraseMatcherOrBuilder extends MessageOrBuilder

## Implements

[MessageOrBuilder](https://cloud.google.com/java/docs/reference/protobuf/latest/com.google.protobuf.MessageOrBuilder.html)

## 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** |
| `https://cloud.google.com/java/docs/reference/protobuf/latest/com.google.protobuf.Timestamp.html` | 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** |
| `https://cloud.google.com/java/docs/reference/protobuf/latest/com.google.protobuf.TimestampOrBuilder.html` |   |

### getActive()

    public abstract boolean getActive()

Applies the phrase matcher only when it is active.

`bool active = 7;`

| **Returns** ||
|---|---|
| **Type** | **Description** |
| `https://docs.oracle.com/javase/tutorial/java/nutsandbolts/datatypes.html` | The active. |

### getDisplayName()

    public abstract String getDisplayName()

The human-readable name of the phrase matcher.

`string display_name = 5;`

| **Returns** ||
|---|---|
| **Type** | **Description** |
| `https://docs.oracle.com/javase/8/docs/api/java/lang/String.html` | The displayName. |

### getDisplayNameBytes()

    public abstract ByteString getDisplayNameBytes()

The human-readable name of the phrase matcher.

`string display_name = 5;`

| **Returns** ||
|---|---|
| **Type** | **Description** |
| `https://cloud.google.com/java/docs/reference/protobuf/latest/com.google.protobuf.ByteString.html` | 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** |
| `https://docs.oracle.com/javase/8/docs/api/java/lang/String.html` | 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** |
| `https://cloud.google.com/java/docs/reference/protobuf/latest/com.google.protobuf.ByteString.html` | 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` | `https://docs.oracle.com/javase/tutorial/java/nutsandbolts/datatypes.html` |

| **Returns** ||
|---|---|
| **Type** | **Description** |
| `https://docs.cloud.google.com/java/docs/reference/google-cloud-contact-center-insights/latest/com.google.cloud.contactcenterinsights.v1.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** |
| `https://docs.oracle.com/javase/tutorial/java/nutsandbolts/datatypes.html` |   |

### 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** |
| `https://docs.oracle.com/javase/8/docs/api/java/util/List.html<https://docs.cloud.google.com/java/docs/reference/google-cloud-contact-center-insights/latest/com.google.cloud.contactcenterinsights.v1.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` | `https://docs.oracle.com/javase/tutorial/java/nutsandbolts/datatypes.html` |

| **Returns** ||
|---|---|
| **Type** | **Description** |
| `https://docs.cloud.google.com/java/docs/reference/google-cloud-contact-center-insights/latest/com.google.cloud.contactcenterinsights.v1.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** |
| `https://docs.oracle.com/javase/8/docs/api/java/util/List.html<? 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** |
| `https://cloud.google.com/java/docs/reference/protobuf/latest/com.google.protobuf.Timestamp.html` | 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** |
| `https://cloud.google.com/java/docs/reference/protobuf/latest/com.google.protobuf.TimestampOrBuilder.html` |   |

### 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** |
| `https://docs.oracle.com/javase/8/docs/api/java/lang/String.html` | 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** |
| `https://cloud.google.com/java/docs/reference/protobuf/latest/com.google.protobuf.ByteString.html` | 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** |
| `https://docs.cloud.google.com/java/docs/reference/google-cloud-contact-center-insights/latest/com.google.cloud.contactcenterinsights.v1.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** |
| `https://docs.oracle.com/javase/tutorial/java/nutsandbolts/datatypes.html` | 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** |
| `https://docs.cloud.google.com/java/docs/reference/google-cloud-contact-center-insights/latest/com.google.cloud.contactcenterinsights.v1.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** |
| `https://docs.oracle.com/javase/tutorial/java/nutsandbolts/datatypes.html` | 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** |
| `https://cloud.google.com/java/docs/reference/protobuf/latest/com.google.protobuf.Timestamp.html` | 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** |
| `https://cloud.google.com/java/docs/reference/protobuf/latest/com.google.protobuf.TimestampOrBuilder.html` |   |

### 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** |
| `https://docs.oracle.com/javase/8/docs/api/java/lang/String.html` | 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** |
| `https://cloud.google.com/java/docs/reference/protobuf/latest/com.google.protobuf.ByteString.html` | 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** |
| `https://docs.oracle.com/javase/tutorial/java/nutsandbolts/datatypes.html` | 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** |
| `https://docs.oracle.com/javase/tutorial/java/nutsandbolts/datatypes.html` | 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** |
| `https://docs.oracle.com/javase/tutorial/java/nutsandbolts/datatypes.html` | Whether the updateTime field is set. |