Interface ParticipantOrBuilder (4.19.0)

Version 4.19.0

• 4.59.0 (latest)
• 4.58.0
• 4.57.0
• 4.55.0
• 4.54.0
• 4.53.0
• 4.52.0
• 4.51.0
• 4.50.0
• 4.49.0
• 4.48.0
• 4.47.0
• 4.46.0
• 4.45.0
• 4.43.0
• 4.42.0
• 4.41.0
• 4.40.0
• 4.39.0
• 4.38.0
• 4.37.0
• 4.36.0
• 4.35.0
• 4.34.0
• 4.33.0
• 4.30.0
• 4.29.0
• 4.28.0
• 4.27.0
• 4.26.0
• 4.25.0
• 4.24.0
• 4.23.0
• 4.22.0
• 4.21.0
• 4.20.0
• 4.19.0
• 4.18.0
• 4.17.0
• 4.15.0
• 4.14.0
• 4.13.0
• 4.12.0
• 4.11.0
• 4.10.0
• 4.9.1
• 4.8.6
• 4.7.5
• 4.6.0
• 4.5.11
• 4.4.0
• 4.3.1

public interface ParticipantOrBuilder extends MessageOrBuilder

Implements

MessageOrBuilder

Methods

containsDocumentsMetadataFilters(String key)

public abstract 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

getDocumentsMetadataFilters()

public abstract Map<String,String> getDocumentsMetadataFilters()

Use #getDocumentsMetadataFiltersMap() instead.

Returns
Type	Description
Map<String,String>

getDocumentsMetadataFiltersCount()

public abstract 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 abstract 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 abstract 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 abstract 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 abstract 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 abstract 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 abstract 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 abstract 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 abstract 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 abstract 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 abstract 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 abstract 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.