/*
* 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/dialogflow/v2beta1/participant.proto
package com.google.cloud.dialogflow.v2beta1;
public interface ParticipantOrBuilder
extends
// @@protoc_insertion_point(interface_extends:google.cloud.dialogflow.v2beta1.Participant)
com.google.protobuf.MessageOrBuilder {
/**
*
*
*
* Optional. The unique identifier of this participant.
* Format: `projects/<Project ID>/locations/<Location
* ID>/conversations/<Conversation ID>/participants/<Participant ID>`.
*
*
* string name = 1 [(.google.api.field_behavior) = OPTIONAL];
*
* @return The name.
*/
java.lang.String getName();
/**
*
*
*
* Optional. The unique identifier of this participant.
* Format: `projects/<Project ID>/locations/<Location
* ID>/conversations/<Conversation ID>/participants/<Participant ID>`.
*
*
* string name = 1 [(.google.api.field_behavior) = OPTIONAL];
*
* @return The bytes for name.
*/
com.google.protobuf.ByteString getNameBytes();
/**
*
*
*
* Immutable. The role this participant plays in the conversation. This field
* must be set during participant creation and is then immutable.
*
*
*
* .google.cloud.dialogflow.v2beta1.Participant.Role role = 2 [(.google.api.field_behavior) = IMMUTABLE];
*
*
* @return The enum numeric value on the wire for role.
*/
int getRoleValue();
/**
*
*
*
* Immutable. The role this participant plays in the conversation. This field
* must be set during participant creation and is then immutable.
*
*
*
* .google.cloud.dialogflow.v2beta1.Participant.Role role = 2 [(.google.api.field_behavior) = IMMUTABLE];
*
*
* @return The role.
*/
com.google.cloud.dialogflow.v2beta1.Participant.Role getRole();
/**
*
*
*
* Optional. Obfuscated user id that should be associated with the created
* participant.
* You can specify a user id as follows:
* 1. If you set this field in
* [CreateParticipantRequest][google.cloud.dialogflow.v2beta1.CreateParticipantRequest.participant]
* or
* [UpdateParticipantRequest][google.cloud.dialogflow.v2beta1.UpdateParticipantRequest.participant],
* Dialogflow adds the obfuscated user id with the participant.
* 2. If you set this field in
* [AnalyzeContent][google.cloud.dialogflow.v2beta1.AnalyzeContentRequest.obfuscated_external_user_id]
* or
* [StreamingAnalyzeContent][google.cloud.dialogflow.v2beta1.StreamingAnalyzeContentRequest.obfuscated_external_user_id],
* Dialogflow will update
* [Participant.obfuscated_external_user_id][google.cloud.dialogflow.v2beta1.Participant.obfuscated_external_user_id].
* Dialogflow uses this user id for following purposes:
* 1) Billing and measurement. If user with the same
* obfuscated_external_user_id is created in a later conversation, dialogflow
* will know it's the same user. 2) Agent assist suggestion personalization.
* For example, Dialogflow can use it to provide personalized smart reply
* suggestions for this user.
* Note:
* * Please never pass raw user ids to Dialogflow. Always obfuscate your user
* id first.
* * Dialogflow only accepts a UTF-8 encoded string, e.g., a hex digest of a
* hash function like SHA-512.
* * The length of the user id must be <= 256 characters.
*
*
* string obfuscated_external_user_id = 7 [(.google.api.field_behavior) = OPTIONAL];
*
* @return The obfuscatedExternalUserId.
*/
java.lang.String getObfuscatedExternalUserId();
/**
*
*
*
* Optional. Obfuscated user id that should be associated with the created
* participant.
* You can specify a user id as follows:
* 1. If you set this field in
* [CreateParticipantRequest][google.cloud.dialogflow.v2beta1.CreateParticipantRequest.participant]
* or
* [UpdateParticipantRequest][google.cloud.dialogflow.v2beta1.UpdateParticipantRequest.participant],
* Dialogflow adds the obfuscated user id with the participant.
* 2. If you set this field in
* [AnalyzeContent][google.cloud.dialogflow.v2beta1.AnalyzeContentRequest.obfuscated_external_user_id]
* or
* [StreamingAnalyzeContent][google.cloud.dialogflow.v2beta1.StreamingAnalyzeContentRequest.obfuscated_external_user_id],
* Dialogflow will update
* [Participant.obfuscated_external_user_id][google.cloud.dialogflow.v2beta1.Participant.obfuscated_external_user_id].
* Dialogflow uses this user id for following purposes:
* 1) Billing and measurement. If user with the same
* obfuscated_external_user_id is created in a later conversation, dialogflow
* will know it's the same user. 2) Agent assist suggestion personalization.
* For example, Dialogflow can use it to provide personalized smart reply
* suggestions for this user.
* Note:
* * Please never pass raw user ids to Dialogflow. Always obfuscate your user
* id first.
* * Dialogflow only accepts a UTF-8 encoded string, e.g., a hex digest of a
* hash function like SHA-512.
* * The length of the user id must be <= 256 characters.
*
*
* string obfuscated_external_user_id = 7 [(.google.api.field_behavior) = OPTIONAL];
*
* @return The bytes for obfuscatedExternalUserId.
*/
com.google.protobuf.ByteString getObfuscatedExternalUserIdBytes();
/**
*
*
*
* Optional. Key-value filters on the metadata of documents returned by
* article suggestion. If specified, article suggestion only returns suggested
* documents that match all filters in their
* [Document.metadata][google.cloud.dialogflow.v2beta1.Document.metadata].
* Multiple values for a metadata key should be concatenated by comma. For
* example, filters to match all documents that have 'US' or 'CA' in their
* market metadata values and 'agent' in their user metadata values will be
* ```
* documents_metadata_filters {
* key: "market"
* value: "US,CA"
* }
* documents_metadata_filters {
* key: "user"
* value: "agent"
* }
* ```
*
*
*
* map<string, string> documents_metadata_filters = 8 [(.google.api.field_behavior) = OPTIONAL];
*
*/
int getDocumentsMetadataFiltersCount();
/**
*
*
*
* Optional. Key-value filters on the metadata of documents returned by
* article suggestion. If specified, article suggestion only returns suggested
* documents that match all filters in their
* [Document.metadata][google.cloud.dialogflow.v2beta1.Document.metadata].
* Multiple values for a metadata key should be concatenated by comma. For
* example, filters to match all documents that have 'US' or 'CA' in their
* market metadata values and 'agent' in their user metadata values will be
* ```
* documents_metadata_filters {
* key: "market"
* value: "US,CA"
* }
* documents_metadata_filters {
* key: "user"
* value: "agent"
* }
* ```
*
*
*
* map<string, string> documents_metadata_filters = 8 [(.google.api.field_behavior) = OPTIONAL];
*
*/
boolean containsDocumentsMetadataFilters(java.lang.String key);
/** Use {@link #getDocumentsMetadataFiltersMap()} instead. */
@java.lang.Deprecated
java.util.Map getDocumentsMetadataFilters();
/**
*
*
*
* Optional. Key-value filters on the metadata of documents returned by
* article suggestion. If specified, article suggestion only returns suggested
* documents that match all filters in their
* [Document.metadata][google.cloud.dialogflow.v2beta1.Document.metadata].
* Multiple values for a metadata key should be concatenated by comma. For
* example, filters to match all documents that have 'US' or 'CA' in their
* market metadata values and 'agent' in their user metadata values will be
* ```
* documents_metadata_filters {
* key: "market"
* value: "US,CA"
* }
* documents_metadata_filters {
* key: "user"
* value: "agent"
* }
* ```
*
*
*
* map<string, string> documents_metadata_filters = 8 [(.google.api.field_behavior) = OPTIONAL];
*
*/
java.util.Map getDocumentsMetadataFiltersMap();
/**
*
*
*
* Optional. Key-value filters on the metadata of documents returned by
* article suggestion. If specified, article suggestion only returns suggested
* documents that match all filters in their
* [Document.metadata][google.cloud.dialogflow.v2beta1.Document.metadata].
* Multiple values for a metadata key should be concatenated by comma. For
* example, filters to match all documents that have 'US' or 'CA' in their
* market metadata values and 'agent' in their user metadata values will be
* ```
* documents_metadata_filters {
* key: "market"
* value: "US,CA"
* }
* documents_metadata_filters {
* key: "user"
* value: "agent"
* }
* ```
*
*
*
* map<string, string> documents_metadata_filters = 8 [(.google.api.field_behavior) = OPTIONAL];
*
*/
/* nullable */
java.lang.String getDocumentsMetadataFiltersOrDefault(
java.lang.String key,
/* nullable */
java.lang.String defaultValue);
/**
*
*
*
* Optional. Key-value filters on the metadata of documents returned by
* article suggestion. If specified, article suggestion only returns suggested
* documents that match all filters in their
* [Document.metadata][google.cloud.dialogflow.v2beta1.Document.metadata].
* Multiple values for a metadata key should be concatenated by comma. For
* example, filters to match all documents that have 'US' or 'CA' in their
* market metadata values and 'agent' in their user metadata values will be
* ```
* documents_metadata_filters {
* key: "market"
* value: "US,CA"
* }
* documents_metadata_filters {
* key: "user"
* value: "agent"
* }
* ```
*
*
*
* map<string, string> documents_metadata_filters = 8 [(.google.api.field_behavior) = OPTIONAL];
*
*/
java.lang.String getDocumentsMetadataFiltersOrThrow(java.lang.String key);
}