/*
* Copyright 2020 Google LLC
*
* Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License.
* You may obtain a copy of the License at
*
* https://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS,
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
* See the License for the specific language governing permissions and
* limitations under the License.
*/
// Generated by the protocol buffer compiler. DO NOT EDIT!
// source: google/cloud/contactcenterinsights/v1/resources.proto
package com.google.cloud.contactcenterinsights.v1;
public interface PhraseMatcherOrBuilder
extends
// @@protoc_insertion_point(interface_extends:google.cloud.contactcenterinsights.v1.PhraseMatcher)
com.google.protobuf.MessageOrBuilder {
/**
*
*
*
* The resource name of the phrase matcher.
* Format:
* projects/{project}/locations/{location}/phraseMatchers/{phrase_matcher}
*
*
* string name = 1;
*
* @return The name.
*/
java.lang.String getName();
/**
*
*
*
* The resource name of the phrase matcher.
* Format:
* projects/{project}/locations/{location}/phraseMatchers/{phrase_matcher}
*
*
* string name = 1;
*
* @return The bytes for name.
*/
com.google.protobuf.ByteString getNameBytes();
/**
*
*
*
* 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];
*
*
* @return The revisionId.
*/
java.lang.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];
*
*
* @return The bytes for revisionId.
*/
com.google.protobuf.ByteString getRevisionIdBytes();
/**
*
*
*
* The customized version tag to use for the phrase matcher. If not specified,
* it will default to `revision_id`.
*
*
* string version_tag = 3;
*
* @return The versionTag.
*/
java.lang.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;
*
* @return The bytes for versionTag.
*/
com.google.protobuf.ByteString getVersionTagBytes();
/**
*
*
*
* 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];
*
*
* @return Whether the revisionCreateTime field is set.
*/
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];
*
*
* @return The revisionCreateTime.
*/
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];
*
*/
com.google.protobuf.TimestampOrBuilder getRevisionCreateTimeOrBuilder();
/**
*
*
*
* The human-readable name of the phrase matcher.
*
*
* string display_name = 5;
*
* @return The displayName.
*/
java.lang.String getDisplayName();
/**
*
*
*
* The human-readable name of the phrase matcher.
*
*
* string display_name = 5;
*
* @return The bytes for displayName.
*/
com.google.protobuf.ByteString getDisplayNameBytes();
/**
*
*
*
* Required. The type of this phrase matcher.
*
*
*
* .google.cloud.contactcenterinsights.v1.PhraseMatcher.PhraseMatcherType type = 6 [(.google.api.field_behavior) = REQUIRED];
*
*
* @return The enum numeric value on the wire for type.
*/
int getTypeValue();
/**
*
*
*
* Required. The type of this phrase matcher.
*
*
*
* .google.cloud.contactcenterinsights.v1.PhraseMatcher.PhraseMatcherType type = 6 [(.google.api.field_behavior) = REQUIRED];
*
*
* @return The type.
*/
com.google.cloud.contactcenterinsights.v1.PhraseMatcher.PhraseMatcherType getType();
/**
*
*
*
* Applies the phrase matcher only when it is active.
*
*
* bool active = 7;
*
* @return The active.
*/
boolean getActive();
/**
*
*
*
* A list of phase match rule groups that are included in this matcher.
*
*
*
* repeated .google.cloud.contactcenterinsights.v1.PhraseMatchRuleGroup phrase_match_rule_groups = 8;
*
*/
java.util.List
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;
*
*/
com.google.cloud.contactcenterinsights.v1.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;
*
*/
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;
*
*/
java.util.List
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;
*
*/
com.google.cloud.contactcenterinsights.v1.PhraseMatchRuleGroupOrBuilder
getPhraseMatchRuleGroupsOrBuilder(int index);
/**
*
*
*
* 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];
*
*
* @return Whether the activationUpdateTime field is set.
*/
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];
*
*
* @return The activationUpdateTime.
*/
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];
*
*/
com.google.protobuf.TimestampOrBuilder getActivationUpdateTimeOrBuilder();
/**
*
*
*
* 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;
*
*
* @return The enum numeric value on the wire for roleMatch.
*/
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;
*
*
* @return The roleMatch.
*/
com.google.cloud.contactcenterinsights.v1.ConversationParticipant.Role getRoleMatch();
/**
*
*
*
* 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];
*
*
* @return Whether the updateTime field is set.
*/
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];
*
*
* @return The updateTime.
*/
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];
*
*/
com.google.protobuf.TimestampOrBuilder getUpdateTimeOrBuilder();
}