Class Participant.Builder (4.39.0) 

public static final class Participant.Builder extends GeneratedMessageV3.Builder<Participant.Builder> implements ParticipantOrBuilder

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

Protobuf type google.cloud.dialogflow.v2.Participant

Inheritance

Object > AbstractMessageLite.Builder<MessageType,BuilderType> > AbstractMessage.Builder<BuilderType> > GeneratedMessageV3.Builder > Participant.Builder

Static Methods

getDescriptor()

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

Methods

addRepeatedField(Descriptors.FieldDescriptor field, Object value)

public Participant.Builder addRepeatedField(Descriptors.FieldDescriptor field, Object value)
Parameters
Name Description
field FieldDescriptor
value Object
Returns
Type Description
Participant.Builder
Overrides

build()

public Participant build()
Returns
Type Description
Participant

buildPartial()

public Participant buildPartial()
Returns
Type Description
Participant

clear()

public Participant.Builder clear()
Returns
Type Description
Participant.Builder
Overrides

clearDocumentsMetadataFilters()

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

clearField(Descriptors.FieldDescriptor field)

public Participant.Builder clearField(Descriptors.FieldDescriptor field)
Parameter
Name Description
field FieldDescriptor
Returns
Type Description
Participant.Builder
Overrides

clearName()

public Participant.Builder clearName()

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
Participant.Builder

This builder for chaining.

clearObfuscatedExternalUserId()

public Participant.Builder clearObfuscatedExternalUserId()

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
Participant.Builder

This builder for chaining.

clearOneof(Descriptors.OneofDescriptor oneof)

public Participant.Builder clearOneof(Descriptors.OneofDescriptor oneof)
Parameter
Name Description
oneof OneofDescriptor
Returns
Type Description
Participant.Builder
Overrides

clearRole()

public Participant.Builder clearRole()

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.Builder

This builder for chaining.

clearSipRecordingMediaLabel()

public Participant.Builder clearSipRecordingMediaLabel()

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
Participant.Builder

This builder for chaining.

clone()

public Participant.Builder clone()
Returns
Type Description
Participant.Builder
Overrides

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

getDefaultInstanceForType()

public Participant getDefaultInstanceForType()
Returns
Type Description
Participant

getDescriptorForType()

public Descriptors.Descriptor getDescriptorForType()
Returns
Type Description
Descriptor
Overrides

getDocumentsMetadataFilters() (deprecated)

public Map<String,String> getDocumentsMetadataFilters()

Use #getDocumentsMetadataFiltersMap() instead.

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

getMutableDocumentsMetadataFilters() (deprecated)

public Map<String,String> getMutableDocumentsMetadataFilters()

Use alternate mutation accessors instead.

Returns
Type Description
Map<String,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.

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.

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.

internalGetFieldAccessorTable()

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

internalGetMapField(int number)

protected MapField internalGetMapField(int number)
Parameter
Name Description
number int
Returns
Type Description
MapField
Overrides

internalGetMutableMapField(int number)

protected MapField internalGetMutableMapField(int number)
Parameter
Name Description
number int
Returns
Type Description
MapField
Overrides

isInitialized()

public final boolean isInitialized()
Returns
Type Description
boolean
Overrides

mergeFrom(Participant other)

public Participant.Builder mergeFrom(Participant other)
Parameter
Name Description
other Participant
Returns
Type Description
Participant.Builder

mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

public Participant.Builder mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
input CodedInputStream
extensionRegistry ExtensionRegistryLite
Returns
Type Description
Participant.Builder
Overrides
Exceptions
Type Description
IOException

mergeFrom(Message other)

public Participant.Builder mergeFrom(Message other)
Parameter
Name Description
other Message
Returns
Type Description
Participant.Builder
Overrides

mergeUnknownFields(UnknownFieldSet unknownFields)

public final Participant.Builder mergeUnknownFields(UnknownFieldSet unknownFields)
Parameter
Name Description
unknownFields UnknownFieldSet
Returns
Type Description
Participant.Builder
Overrides

putAllDocumentsMetadataFilters(Map<String,String> values)

public Participant.Builder putAllDocumentsMetadataFilters(Map<String,String> values)

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
values Map<String,String>
Returns
Type Description
Participant.Builder

putDocumentsMetadataFilters(String key, String value)

public Participant.Builder putDocumentsMetadataFilters(String key, String value)

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
value String
Returns
Type Description
Participant.Builder

removeDocumentsMetadataFilters(String key)

public Participant.Builder removeDocumentsMetadataFilters(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
Participant.Builder

setField(Descriptors.FieldDescriptor field, Object value)

public Participant.Builder setField(Descriptors.FieldDescriptor field, Object value)
Parameters
Name Description
field FieldDescriptor
value Object
Returns
Type Description
Participant.Builder
Overrides

setName(String value)

public Participant.Builder setName(String value)

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

Parameter
Name Description
value String

The name to set.
Returns
Type Description
Participant.Builder

This builder for chaining.

setNameBytes(ByteString value)

public Participant.Builder setNameBytes(ByteString value)

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

Parameter
Name Description
value ByteString

The bytes for name to set.
Returns
Type Description
Participant.Builder

This builder for chaining.

setObfuscatedExternalUserId(String value)

public Participant.Builder setObfuscatedExternalUserId(String value)

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

Parameter
Name Description
value String

The obfuscatedExternalUserId to set.
Returns
Type Description
Participant.Builder

This builder for chaining.

setObfuscatedExternalUserIdBytes(ByteString value)

public Participant.Builder setObfuscatedExternalUserIdBytes(ByteString value)

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

Parameter
Name Description
value ByteString

The bytes for obfuscatedExternalUserId to set.
Returns
Type Description
Participant.Builder

This builder for chaining.

setRepeatedField(Descriptors.FieldDescriptor field, int index, Object value)

public Participant.Builder setRepeatedField(Descriptors.FieldDescriptor field, int index, Object value)
Parameters
Name Description
field FieldDescriptor
index int
value Object
Returns
Type Description
Participant.Builder
Overrides

setRole(Participant.Role value)

public Participant.Builder setRole(Participant.Role value)

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

Parameter
Name Description
value Participant.Role

The role to set.
Returns
Type Description
Participant.Builder

This builder for chaining.

setRoleValue(int value)

public Participant.Builder setRoleValue(int value)

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

Parameter
Name Description
value int

The enum numeric value on the wire for role to set.
Returns
Type Description
Participant.Builder

This builder for chaining.

setSipRecordingMediaLabel(String value)

public Participant.Builder setSipRecordingMediaLabel(String value)

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

Parameter
Name Description
value String

The sipRecordingMediaLabel to set.
Returns
Type Description
Participant.Builder

This builder for chaining.

setSipRecordingMediaLabelBytes(ByteString value)

public Participant.Builder setSipRecordingMediaLabelBytes(ByteString value)

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

Parameter
Name Description
value ByteString

The bytes for sipRecordingMediaLabel to set.
Returns
Type Description
Participant.Builder

This builder for chaining.

setUnknownFields(UnknownFieldSet unknownFields)

public final Participant.Builder setUnknownFields(UnknownFieldSet unknownFields)
Parameter
Name Description
unknownFields UnknownFieldSet
Returns
Type Description
Participant.Builder
Overrides