Class Participant (4.4.0)

public final class Participant extends GeneratedMessageV3 implements ParticipantOrBuilder

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

Protobuf type google.cloud.dialogflow.v2beta1.Participant

Fields

DOCUMENTS_METADATA_FILTERS_FIELD_NUMBER

public static final int DOCUMENTS_METADATA_FILTERS_FIELD_NUMBER
Field Value
TypeDescription
int

NAME_FIELD_NUMBER

public static final int NAME_FIELD_NUMBER
Field Value
TypeDescription
int

OBFUSCATED_EXTERNAL_USER_ID_FIELD_NUMBER

public static final int OBFUSCATED_EXTERNAL_USER_ID_FIELD_NUMBER
Field Value
TypeDescription
int

ROLE_FIELD_NUMBER

public static final int ROLE_FIELD_NUMBER
Field Value
TypeDescription
int

Methods

containsDocumentsMetadataFilters(String key)

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. 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 <code><code> documents_metadata_filters { key: "market" value: "US,CA" } documents_metadata_filters { key: "user" value: "agent" } </code></code>

map<string, string> documents_metadata_filters = 8 [(.google.api.field_behavior) = OPTIONAL];

Parameter
NameDescription
keyString
Returns
TypeDescription
boolean

equals(Object obj)

public boolean equals(Object obj)
Parameter
NameDescription
objObject
Returns
TypeDescription
boolean
Overrides

getDefaultInstance()

public static Participant getDefaultInstance()
Returns
TypeDescription
Participant

getDefaultInstanceForType()

public Participant getDefaultInstanceForType()
Returns
TypeDescription
Participant

getDescriptor()

public static final Descriptors.Descriptor getDescriptor()
Returns
TypeDescription
Descriptor

getDocumentsMetadataFilters()

public Map<String,String> getDocumentsMetadataFilters()
Returns
TypeDescription
Map<String,String>

getDocumentsMetadataFiltersCount()

public 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. 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 <code><code> documents_metadata_filters { key: "market" value: "US,CA" } documents_metadata_filters { key: "user" value: "agent" } </code></code>

map<string, string> documents_metadata_filters = 8 [(.google.api.field_behavior) = OPTIONAL];

Returns
TypeDescription
int

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. 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 <code><code> documents_metadata_filters { key: "market" value: "US,CA" } documents_metadata_filters { key: "user" value: "agent" } </code></code>

map<string, string> documents_metadata_filters = 8 [(.google.api.field_behavior) = OPTIONAL];

Returns
TypeDescription
Map<String,String>

getDocumentsMetadataFiltersOrDefault(String key, String defaultValue)

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. 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 <code><code> documents_metadata_filters { key: "market" value: "US,CA" } documents_metadata_filters { key: "user" value: "agent" } </code></code>

map<string, string> documents_metadata_filters = 8 [(.google.api.field_behavior) = OPTIONAL];

Parameters
NameDescription
keyString
defaultValueString
Returns
TypeDescription
String

getDocumentsMetadataFiltersOrThrow(String key)

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. 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 <code><code> documents_metadata_filters { key: "market" value: "US,CA" } documents_metadata_filters { key: "user" value: "agent" } </code></code>

map<string, string> documents_metadata_filters = 8 [(.google.api.field_behavior) = OPTIONAL];

Parameter
NameDescription
keyString
Returns
TypeDescription
String

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

Returns
TypeDescription
String

The name.

getNameBytes()

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

Returns
TypeDescription
ByteString

The bytes for name.

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 or UpdateParticipantRequest, Dialogflow adds the obfuscated user id with the participant.
  2. If you set this field in AnalyzeContent or StreamingAnalyzeContent, Dialogflow will update 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:
  3. Please never pass raw user ids to Dialogflow. Always obfuscate your user id first.
  4. Dialogflow only accepts a UTF-8 encoded string, e.g., a hex digest of a hash function like SHA-512.
  5. The length of the user id must be <= 256 characters.

string obfuscated_external_user_id = 7 [(.google.api.field_behavior) = OPTIONAL];

Returns
TypeDescription
String

The obfuscatedExternalUserId.

getObfuscatedExternalUserIdBytes()

public 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 or UpdateParticipantRequest, Dialogflow adds the obfuscated user id with the participant.
  2. If you set this field in AnalyzeContent or StreamingAnalyzeContent, Dialogflow will update 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:
  3. Please never pass raw user ids to Dialogflow. Always obfuscate your user id first.
  4. Dialogflow only accepts a UTF-8 encoded string, e.g., a hex digest of a hash function like SHA-512.
  5. The length of the user id must be <= 256 characters.

string obfuscated_external_user_id = 7 [(.google.api.field_behavior) = OPTIONAL];

Returns
TypeDescription
ByteString

The bytes for obfuscatedExternalUserId.

getParserForType()

public Parser<Participant> getParserForType()
Returns
TypeDescription
Parser<Participant>
Overrides

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

Returns
TypeDescription
Participant.Role

The role.

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

Returns
TypeDescription
int

The enum numeric value on the wire for role.

getSerializedSize()

public int getSerializedSize()
Returns
TypeDescription
int
Overrides

getUnknownFields()

public final UnknownFieldSet getUnknownFields()
Returns
TypeDescription
UnknownFieldSet
Overrides

hashCode()

public int hashCode()
Returns
TypeDescription
int
Overrides

internalGetFieldAccessorTable()

protected GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
Returns
TypeDescription
FieldAccessorTable
Overrides

internalGetMapField(int number)

protected MapField internalGetMapField(int number)
Parameter
NameDescription
numberint
Returns
TypeDescription
MapField
Overrides

isInitialized()

public final boolean isInitialized()
Returns
TypeDescription
boolean
Overrides

newBuilder()

public static Participant.Builder newBuilder()
Returns
TypeDescription
Participant.Builder

newBuilder(Participant prototype)

public static Participant.Builder newBuilder(Participant prototype)
Parameter
NameDescription
prototypeParticipant
Returns
TypeDescription
Participant.Builder

newBuilderForType()

public Participant.Builder newBuilderForType()
Returns
TypeDescription
Participant.Builder

newBuilderForType(GeneratedMessageV3.BuilderParent parent)

protected Participant.Builder newBuilderForType(GeneratedMessageV3.BuilderParent parent)
Parameter
NameDescription
parentBuilderParent
Returns
TypeDescription
Participant.Builder
Overrides

newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)

protected Object newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)
Parameter
NameDescription
unusedUnusedPrivateParameter
Returns
TypeDescription
Object
Overrides

parseDelimitedFrom(InputStream input)

public static Participant parseDelimitedFrom(InputStream input)
Parameter
NameDescription
inputInputStream
Returns
TypeDescription
Participant
Exceptions
TypeDescription
IOException

parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

public static Participant parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
NameDescription
inputInputStream
extensionRegistryExtensionRegistryLite
Returns
TypeDescription
Participant
Exceptions
TypeDescription
IOException

parseFrom(byte[] data)

public static Participant parseFrom(byte[] data)
Parameter
NameDescription
databyte[]
Returns
TypeDescription
Participant
Exceptions
TypeDescription
InvalidProtocolBufferException

parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)

public static Participant parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)
Parameters
NameDescription
databyte[]
extensionRegistryExtensionRegistryLite
Returns
TypeDescription
Participant
Exceptions
TypeDescription
InvalidProtocolBufferException

parseFrom(ByteString data)

public static Participant parseFrom(ByteString data)
Parameter
NameDescription
dataByteString
Returns
TypeDescription
Participant
Exceptions
TypeDescription
InvalidProtocolBufferException

parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)

public static Participant parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)
Parameters
NameDescription
dataByteString
extensionRegistryExtensionRegistryLite
Returns
TypeDescription
Participant
Exceptions
TypeDescription
InvalidProtocolBufferException

parseFrom(CodedInputStream input)

public static Participant parseFrom(CodedInputStream input)
Parameter
NameDescription
inputCodedInputStream
Returns
TypeDescription
Participant
Exceptions
TypeDescription
IOException

parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

public static Participant parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
NameDescription
inputCodedInputStream
extensionRegistryExtensionRegistryLite
Returns
TypeDescription
Participant
Exceptions
TypeDescription
IOException

parseFrom(InputStream input)

public static Participant parseFrom(InputStream input)
Parameter
NameDescription
inputInputStream
Returns
TypeDescription
Participant
Exceptions
TypeDescription
IOException

parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

public static Participant parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
NameDescription
inputInputStream
extensionRegistryExtensionRegistryLite
Returns
TypeDescription
Participant
Exceptions
TypeDescription
IOException

parseFrom(ByteBuffer data)

public static Participant parseFrom(ByteBuffer data)
Parameter
NameDescription
dataByteBuffer
Returns
TypeDescription
Participant
Exceptions
TypeDescription
InvalidProtocolBufferException

parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)

public static Participant parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)
Parameters
NameDescription
dataByteBuffer
extensionRegistryExtensionRegistryLite
Returns
TypeDescription
Participant
Exceptions
TypeDescription
InvalidProtocolBufferException

parser()

public static Parser<Participant> parser()
Returns
TypeDescription
Parser<Participant>

toBuilder()

public Participant.Builder toBuilder()
Returns
TypeDescription
Participant.Builder

writeTo(CodedOutputStream output)

public void writeTo(CodedOutputStream output)
Parameter
NameDescription
outputCodedOutputStream
Overrides Exceptions
TypeDescription
IOException