com.google.cloud.dialogflow.v2beta1

Class Participant

java.lang.Object

com.google.protobuf.AbstractMessageLite

com.google.protobuf.AbstractMessage

com.google.protobuf.GeneratedMessageV3

com.google.cloud.dialogflow.v2beta1.Participant

All Implemented Interfaces:

ParticipantOrBuilder, com.google.protobuf.Message, com.google.protobuf.MessageLite, com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder, Serializable

public final class Participant
extends com.google.protobuf.GeneratedMessageV3
implements ParticipantOrBuilder

 Represents a conversation participant (human agent, virtual agent, end-user).
 

Protobuf type google.cloud.dialogflow.v2beta1.Participant

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	Participant.Builder Represents a conversation participant (human agent, virtual agent, end-user).
static class	Participant.Role Enumeration of the roles a participant can play in a conversation.

Nested classes/interfaces inherited from class com.google.protobuf.GeneratedMessageV3

com.google.protobuf.GeneratedMessageV3.BuilderParent, com.google.protobuf.GeneratedMessageV3.ExtendableBuilder<MessageT extends com.google.protobuf.GeneratedMessageV3.ExtendableMessage<MessageT>,BuilderT extends com.google.protobuf.GeneratedMessageV3.ExtendableBuilder<MessageT,BuilderT>>, com.google.protobuf.GeneratedMessageV3.ExtendableMessage<MessageT extends com.google.protobuf.GeneratedMessageV3.ExtendableMessage<MessageT>>, com.google.protobuf.GeneratedMessageV3.ExtendableMessageOrBuilder<MessageT extends com.google.protobuf.GeneratedMessageV3.ExtendableMessage<MessageT>>, com.google.protobuf.GeneratedMessageV3.FieldAccessorTable, com.google.protobuf.GeneratedMessageV3.UnusedPrivateParameter

Nested classes/interfaces inherited from class com.google.protobuf.AbstractMessageLite

com.google.protobuf.AbstractMessageLite.InternalOneOfEnum

Field Summary

Fields

Modifier and Type	Field and Description
static int	DOCUMENTS_METADATA_FILTERS_FIELD_NUMBER
static int	NAME_FIELD_NUMBER
static int	OBFUSCATED_EXTERNAL_USER_ID_FIELD_NUMBER
static int	ROLE_FIELD_NUMBER

Fields inherited from class com.google.protobuf.GeneratedMessageV3

alwaysUseFieldBuilders, unknownFields

Fields inherited from class com.google.protobuf.AbstractMessage

memoizedSize

Fields inherited from class com.google.protobuf.AbstractMessageLite

memoizedHashCode

Method Summary

Modifier and Type	Method and Description
boolean	containsDocumentsMetadataFilters(String key) Optional.
boolean	equals(Object obj)
static Participant	getDefaultInstance()
Participant	getDefaultInstanceForType()
static com.google.protobuf.Descriptors.Descriptor	getDescriptor()
Map<String,String>	getDocumentsMetadataFilters() Deprecated.
int	getDocumentsMetadataFiltersCount() Optional.
Map<String,String>	getDocumentsMetadataFiltersMap() Optional.
String	getDocumentsMetadataFiltersOrDefault(String key, String defaultValue) Optional.
String	getDocumentsMetadataFiltersOrThrow(String key) Optional.
String	getName() Optional.
com.google.protobuf.ByteString	getNameBytes() Optional.
String	getObfuscatedExternalUserId() Optional.
com.google.protobuf.ByteString	getObfuscatedExternalUserIdBytes() Optional.
com.google.protobuf.Parser<Participant>	getParserForType()
Participant.Role	getRole() Immutable.
int	getRoleValue() Immutable.
int	getSerializedSize()
com.google.protobuf.UnknownFieldSet	getUnknownFields()
int	hashCode()
protected com.google.protobuf.GeneratedMessageV3.FieldAccessorTable	internalGetFieldAccessorTable()
protected com.google.protobuf.MapField	internalGetMapField(int number)
boolean	isInitialized()
static Participant.Builder	newBuilder()
static Participant.Builder	newBuilder(Participant prototype)
Participant.Builder	newBuilderForType()
protected Participant.Builder	newBuilderForType(com.google.protobuf.GeneratedMessageV3.BuilderParent parent)
protected Object	newInstance(com.google.protobuf.GeneratedMessageV3.UnusedPrivateParameter unused)
static Participant	parseDelimitedFrom(InputStream input)
static Participant	parseDelimitedFrom(InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
static Participant	parseFrom(byte[] data)
static Participant	parseFrom(byte[] data, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
static Participant	parseFrom(ByteBuffer data)
static Participant	parseFrom(ByteBuffer data, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
static Participant	parseFrom(com.google.protobuf.ByteString data)
static Participant	parseFrom(com.google.protobuf.ByteString data, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
static Participant	parseFrom(com.google.protobuf.CodedInputStream input)
static Participant	parseFrom(com.google.protobuf.CodedInputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
static Participant	parseFrom(InputStream input)
static Participant	parseFrom(InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
static com.google.protobuf.Parser<Participant>	parser()
Participant.Builder	toBuilder()
void	writeTo(com.google.protobuf.CodedOutputStream output)

Methods inherited from class com.google.protobuf.GeneratedMessageV3

canUseUnsafe, computeStringSize, computeStringSizeNoTag, emptyBooleanList, emptyDoubleList, emptyFloatList, emptyIntList, emptyLongList, getAllFields, getDescriptorForType, getField, getOneofFieldDescriptor, getRepeatedField, getRepeatedFieldCount, hasField, hasOneof, isStringEmpty, makeExtensionsImmutable, makeMutableCopy, mergeFromAndMakeImmutableInternal, mutableCopy, mutableCopy, mutableCopy, mutableCopy, mutableCopy, newBooleanList, newBuilderForType, newDoubleList, newFloatList, newIntList, newLongList, parseDelimitedWithIOException, parseDelimitedWithIOException, parseUnknownField, parseUnknownFieldProto3, parseWithIOException, parseWithIOException, parseWithIOException, parseWithIOException, serializeBooleanMapTo, serializeIntegerMapTo, serializeLongMapTo, serializeStringMapTo, writeReplace, writeString, writeStringNoTag

Methods inherited from class com.google.protobuf.AbstractMessage

findInitializationErrors, getInitializationErrorString, hashBoolean, hashEnum, hashEnumList, hashFields, hashLong, toString

Methods inherited from class com.google.protobuf.AbstractMessageLite

addAll, addAll, checkByteStringIsUtf8, toByteArray, toByteString, writeDelimitedTo, writeTo

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface com.google.protobuf.MessageOrBuilder

findInitializationErrors, getAllFields, getDescriptorForType, getField, getInitializationErrorString, getOneofFieldDescriptor, getRepeatedField, getRepeatedFieldCount, hasField, hasOneof

Methods inherited from interface com.google.protobuf.MessageLite

toByteArray, toByteString, writeDelimitedTo, writeTo

Field Detail

NAME_FIELD_NUMBER

public static final int NAME_FIELD_NUMBER

See Also:

Constant Field Values

ROLE_FIELD_NUMBER

public static final int ROLE_FIELD_NUMBER

See Also:

Constant Field Values

OBFUSCATED_EXTERNAL_USER_ID_FIELD_NUMBER

public static final int OBFUSCATED_EXTERNAL_USER_ID_FIELD_NUMBER

See Also:

Constant Field Values

DOCUMENTS_METADATA_FILTERS_FIELD_NUMBER

public static final int DOCUMENTS_METADATA_FILTERS_FIELD_NUMBER

See Also:

Constant Field Values

Method Detail

newInstance

protected Object newInstance(com.google.protobuf.GeneratedMessageV3.UnusedPrivateParameter unused)

Overrides:

newInstance in class com.google.protobuf.GeneratedMessageV3

getUnknownFields

public final com.google.protobuf.UnknownFieldSet getUnknownFields()

Specified by:

getUnknownFields in interface com.google.protobuf.MessageOrBuilder

Overrides:

getUnknownFields in class com.google.protobuf.GeneratedMessageV3

getDescriptor

public static final com.google.protobuf.Descriptors.Descriptor getDescriptor()

internalGetMapField

protected com.google.protobuf.MapField internalGetMapField(int number)

Overrides:

internalGetMapField in class com.google.protobuf.GeneratedMessageV3

internalGetFieldAccessorTable

protected com.google.protobuf.GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()

Specified by:

internalGetFieldAccessorTable in class com.google.protobuf.GeneratedMessageV3

getName

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

Specified by:

getName in interface ParticipantOrBuilder

Returns:

The name.

getNameBytes

public com.google.protobuf.ByteString getNameBytes()

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

Specified by:

getNameBytes in interface ParticipantOrBuilder

Returns:

The bytes for name.

getRoleValue

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

Specified by:

getRoleValue in interface ParticipantOrBuilder

Returns:

The enum numeric value on the wire for role.

getRole

public Participant.Role getRole()

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

Specified by:

getRole in interface ParticipantOrBuilder

Returns:

The role.

getObfuscatedExternalUserId

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

Specified by:

getObfuscatedExternalUserId in interface ParticipantOrBuilder

Returns:

The obfuscatedExternalUserId.

getObfuscatedExternalUserIdBytes

public com.google.protobuf.ByteString getObfuscatedExternalUserIdBytes()

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

Specified by:

getObfuscatedExternalUserIdBytes in interface ParticipantOrBuilder

Returns:

The bytes for obfuscatedExternalUserId.

getDocumentsMetadataFiltersCount

public int getDocumentsMetadataFiltersCount()

Description copied from interface: ParticipantOrBuilder

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

Specified by:

getDocumentsMetadataFiltersCount in interface ParticipantOrBuilder

containsDocumentsMetadataFilters

public boolean containsDocumentsMetadataFilters(String key)

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

Specified by:

containsDocumentsMetadataFilters in interface ParticipantOrBuilder

getDocumentsMetadataFilters

@Deprecated
public Map<String,String> getDocumentsMetadataFilters()

Deprecated.

Use getDocumentsMetadataFiltersMap() instead.

Specified by:

getDocumentsMetadataFilters in interface ParticipantOrBuilder

getDocumentsMetadataFiltersMap

public Map<String,String> 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];

Specified by:

getDocumentsMetadataFiltersMap in interface ParticipantOrBuilder

getDocumentsMetadataFiltersOrDefault

public String getDocumentsMetadataFiltersOrDefault(String key,
                                                   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];

Specified by:

getDocumentsMetadataFiltersOrDefault in interface ParticipantOrBuilder

getDocumentsMetadataFiltersOrThrow

public String getDocumentsMetadataFiltersOrThrow(String key)

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

Specified by:

getDocumentsMetadataFiltersOrThrow in interface ParticipantOrBuilder

isInitialized

public final boolean isInitialized()

Specified by:

isInitialized in interface com.google.protobuf.MessageLiteOrBuilder

Overrides:

isInitialized in class com.google.protobuf.GeneratedMessageV3

writeTo

public void writeTo(com.google.protobuf.CodedOutputStream output)
             throws IOException

Specified by:

writeTo in interface com.google.protobuf.MessageLite

Overrides:

writeTo in class com.google.protobuf.GeneratedMessageV3

Throws:

IOException

getSerializedSize

public int getSerializedSize()

Specified by:

getSerializedSize in interface com.google.protobuf.MessageLite

Overrides:

getSerializedSize in class com.google.protobuf.GeneratedMessageV3

equals

public boolean equals(Object obj)

Specified by:

equals in interface com.google.protobuf.Message

Overrides:

equals in class com.google.protobuf.AbstractMessage

hashCode

public int hashCode()

Specified by:

hashCode in interface com.google.protobuf.Message

Overrides:

hashCode in class com.google.protobuf.AbstractMessage

parseFrom

public static Participant parseFrom(ByteBuffer data)
                             throws com.google.protobuf.InvalidProtocolBufferException

Throws:

com.google.protobuf.InvalidProtocolBufferException

parseFrom

public static Participant parseFrom(ByteBuffer data,
                                    com.google.protobuf.ExtensionRegistryLite extensionRegistry)
                             throws com.google.protobuf.InvalidProtocolBufferException

Throws:

com.google.protobuf.InvalidProtocolBufferException

parseFrom

public static Participant parseFrom(com.google.protobuf.ByteString data)
                             throws com.google.protobuf.InvalidProtocolBufferException

Throws:

com.google.protobuf.InvalidProtocolBufferException

parseFrom

public static Participant parseFrom(com.google.protobuf.ByteString data,
                                    com.google.protobuf.ExtensionRegistryLite extensionRegistry)
                             throws com.google.protobuf.InvalidProtocolBufferException

Throws:

com.google.protobuf.InvalidProtocolBufferException

parseFrom

public static Participant parseFrom(byte[] data)
                             throws com.google.protobuf.InvalidProtocolBufferException

Throws:

com.google.protobuf.InvalidProtocolBufferException

parseFrom

public static Participant parseFrom(byte[] data,
                                    com.google.protobuf.ExtensionRegistryLite extensionRegistry)
                             throws com.google.protobuf.InvalidProtocolBufferException

Throws:

com.google.protobuf.InvalidProtocolBufferException

parseFrom

public static Participant parseFrom(InputStream input)
                             throws IOException

Throws:

IOException

parseFrom

public static Participant parseFrom(InputStream input,
                                    com.google.protobuf.ExtensionRegistryLite extensionRegistry)
                             throws IOException

Throws:

IOException

parseDelimitedFrom

public static Participant parseDelimitedFrom(InputStream input)
                                      throws IOException

Throws:

IOException

parseDelimitedFrom

public static Participant parseDelimitedFrom(InputStream input,
                                             com.google.protobuf.ExtensionRegistryLite extensionRegistry)
                                      throws IOException

Throws:

IOException

parseFrom

public static Participant parseFrom(com.google.protobuf.CodedInputStream input)
                             throws IOException

Throws:

IOException

parseFrom

public static Participant parseFrom(com.google.protobuf.CodedInputStream input,
                                    com.google.protobuf.ExtensionRegistryLite extensionRegistry)
                             throws IOException

Throws:

IOException

newBuilderForType

public Participant.Builder newBuilderForType()

Specified by:

newBuilderForType in interface com.google.protobuf.Message

Specified by:

newBuilderForType in interface com.google.protobuf.MessageLite

newBuilder

public static Participant.Builder newBuilder()

newBuilder

public static Participant.Builder newBuilder(Participant prototype)

toBuilder

public Participant.Builder toBuilder()

Specified by:

toBuilder in interface com.google.protobuf.Message

Specified by:

toBuilder in interface com.google.protobuf.MessageLite

newBuilderForType

protected Participant.Builder newBuilderForType(com.google.protobuf.GeneratedMessageV3.BuilderParent parent)

Specified by:

newBuilderForType in class com.google.protobuf.GeneratedMessageV3

getDefaultInstance

public static Participant getDefaultInstance()

parser

public static com.google.protobuf.Parser<Participant> parser()

getParserForType

public com.google.protobuf.Parser<Participant> getParserForType()

Specified by:

getParserForType in interface com.google.protobuf.Message

Specified by:

getParserForType in interface com.google.protobuf.MessageLite

Overrides:

getParserForType in class com.google.protobuf.GeneratedMessageV3

getDefaultInstanceForType

public Participant getDefaultInstanceForType()

Specified by:

getDefaultInstanceForType in interface com.google.protobuf.MessageLiteOrBuilder

Specified by:

getDefaultInstanceForType in interface com.google.protobuf.MessageOrBuilder