Class Participant (4.54.0)

public final class Participant extends GeneratedMessageV3 implements ParticipantOrBuilder

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

Protobuf type google.cloud.dialogflow.v2.Participant

Static Fields

DOCUMENTS_METADATA_FILTERS_FIELD_NUMBER

public static final int DOCUMENTS_METADATA_FILTERS_FIELD_NUMBER
Field Value
Type Description
int

NAME_FIELD_NUMBER

public static final int NAME_FIELD_NUMBER
Field Value
Type Description
int

OBFUSCATED_EXTERNAL_USER_ID_FIELD_NUMBER

public static final int OBFUSCATED_EXTERNAL_USER_ID_FIELD_NUMBER
Field Value
Type Description
int

ROLE_FIELD_NUMBER

public static final int ROLE_FIELD_NUMBER
Field Value
Type Description
int

SIP_RECORDING_MEDIA_LABEL_FIELD_NUMBER

public static final int SIP_RECORDING_MEDIA_LABEL_FIELD_NUMBER
Field Value
Type Description
int

Static Methods

getDefaultInstance()

public static Participant getDefaultInstance()
Returns
Type Description
Participant

getDescriptor()

public static final Descriptors.Descriptor getDescriptor()
Returns
Type Description
Descriptor

newBuilder()

public static Participant.Builder newBuilder()
Returns
Type Description
Participant.Builder

newBuilder(Participant prototype)

public static Participant.Builder newBuilder(Participant prototype)
Parameter
Name Description
prototype Participant
Returns
Type Description
Participant.Builder

parseDelimitedFrom(InputStream input)

public static Participant parseDelimitedFrom(InputStream input)
Parameter
Name Description
input InputStream
Returns
Type Description
Participant
Exceptions
Type Description
IOException

parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

public static Participant parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
input InputStream
extensionRegistry ExtensionRegistryLite
Returns
Type Description
Participant
Exceptions
Type Description
IOException

parseFrom(byte[] data)

public static Participant parseFrom(byte[] data)
Parameter
Name Description
data byte[]
Returns
Type Description
Participant
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)

public static Participant parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
data byte[]
extensionRegistry ExtensionRegistryLite
Returns
Type Description
Participant
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(ByteString data)

public static Participant parseFrom(ByteString data)
Parameter
Name Description
data ByteString
Returns
Type Description
Participant
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)

public static Participant parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
data ByteString
extensionRegistry ExtensionRegistryLite
Returns
Type Description
Participant
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(CodedInputStream input)

public static Participant parseFrom(CodedInputStream input)
Parameter
Name Description
input CodedInputStream
Returns
Type Description
Participant
Exceptions
Type Description
IOException

parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

public static Participant parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
input CodedInputStream
extensionRegistry ExtensionRegistryLite
Returns
Type Description
Participant
Exceptions
Type Description
IOException

parseFrom(InputStream input)

public static Participant parseFrom(InputStream input)
Parameter
Name Description
input InputStream
Returns
Type Description
Participant
Exceptions
Type Description
IOException

parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

public static Participant parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
input InputStream
extensionRegistry ExtensionRegistryLite
Returns
Type Description
Participant
Exceptions
Type Description
IOException

parseFrom(ByteBuffer data)

public static Participant parseFrom(ByteBuffer data)
Parameter
Name Description
data ByteBuffer
Returns
Type Description
Participant
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)

public static Participant parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
data ByteBuffer
extensionRegistry ExtensionRegistryLite
Returns
Type Description
Participant
Exceptions
Type Description
InvalidProtocolBufferException

parser()

public static Parser<Participant> parser()
Returns
Type Description
Parser<Participant>

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
Name Description
key String
Returns
Type Description
boolean

equals(Object obj)

public boolean equals(Object obj)
Parameter
Name Description
obj Object
Returns
Type Description
boolean
Overrides

getDefaultInstanceForType()

public Participant getDefaultInstanceForType()
Returns
Type Description
Participant

getDocumentsMetadataFilters() (deprecated)

public Map<String,String> getDocumentsMetadataFilters()
Returns
Type Description
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
Type Description
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
Type Description
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
Name Description
key String
defaultValue String
Returns
Type Description
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
Name Description
key String
Returns
Type Description
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
Type Description
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
Type Description
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 returns an error if you try to add a user id for a non-END_USER participant.

    Dialogflow uses this user id for billing and measurement purposes. For example, Dialogflow determines whether a user in one conversation returned in a later conversation.

    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
Type Description
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 returns an error if you try to add a user id for a non-END_USER participant.

    Dialogflow uses this user id for billing and measurement purposes. For example, Dialogflow determines whether a user in one conversation returned in a later conversation.

    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
Type Description
ByteString

The bytes for obfuscatedExternalUserId.

getParserForType()

public Parser<Participant> getParserForType()
Returns
Type Description
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.v2.Participant.Role role = 2 [(.google.api.field_behavior) = IMMUTABLE];

Returns
Type Description
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.v2.Participant.Role role = 2 [(.google.api.field_behavior) = IMMUTABLE];

Returns
Type Description
int

The enum numeric value on the wire for role.

getSerializedSize()

public int getSerializedSize()
Returns
Type Description
int
Overrides

getSipRecordingMediaLabel()

public String getSipRecordingMediaLabel()

Optional. Label applied to streams representing this participant in SIPREC XML metadata and SDP. This is used to assign transcriptions from that media stream to this participant. This field can be updated.

string sip_recording_media_label = 6 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
String

The sipRecordingMediaLabel.

getSipRecordingMediaLabelBytes()

public ByteString getSipRecordingMediaLabelBytes()

Optional. Label applied to streams representing this participant in SIPREC XML metadata and SDP. This is used to assign transcriptions from that media stream to this participant. This field can be updated.

string sip_recording_media_label = 6 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
ByteString

The bytes for sipRecordingMediaLabel.

hashCode()

public int hashCode()
Returns
Type Description
int
Overrides

internalGetFieldAccessorTable()

protected GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
Returns
Type Description
FieldAccessorTable
Overrides

internalGetMapFieldReflection(int number)

protected MapFieldReflectionAccessor internalGetMapFieldReflection(int number)
Parameter
Name Description
number int
Returns
Type Description
com.google.protobuf.MapFieldReflectionAccessor
Overrides
com.google.protobuf.GeneratedMessageV3.internalGetMapFieldReflection(int)

isInitialized()

public final boolean isInitialized()
Returns
Type Description
boolean
Overrides

newBuilderForType()

public Participant.Builder newBuilderForType()
Returns
Type Description
Participant.Builder

newBuilderForType(GeneratedMessageV3.BuilderParent parent)

protected Participant.Builder newBuilderForType(GeneratedMessageV3.BuilderParent parent)
Parameter
Name Description
parent BuilderParent
Returns
Type Description
Participant.Builder
Overrides

newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)

protected Object newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)
Parameter
Name Description
unused UnusedPrivateParameter
Returns
Type Description
Object
Overrides

toBuilder()

public Participant.Builder toBuilder()
Returns
Type Description
Participant.Builder

writeTo(CodedOutputStream output)

public void writeTo(CodedOutputStream output)
Parameter
Name Description
output CodedOutputStream
Overrides
Exceptions
Type Description
IOException