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
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 |
|
public static final int SIP_RECORDING_MEDIA_LABEL_FIELD_NUMBER
| Field Value |
| Type |
Description |
int |
|
Static Methods
getDefaultInstance()
public static Participant getDefaultInstance()
getDescriptor()
public static final Descriptors.Descriptor getDescriptor()
newBuilder()
public static Participant.Builder newBuilder()
newBuilder(Participant prototype)
public static Participant.Builder newBuilder(Participant prototype)
public static Participant parseDelimitedFrom(InputStream input)
public static Participant parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
parseFrom(byte[] data)
public static Participant parseFrom(byte[] data)
| Parameter |
| Name |
Description |
data |
byte[]
|
parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)
public static Participant parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)
parseFrom(ByteString data)
public static Participant parseFrom(ByteString data)
parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)
public static Participant parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)
public static Participant parseFrom(CodedInputStream input)
public static Participant parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
public static Participant parseFrom(InputStream input)
public static Participant parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
parseFrom(ByteBuffer data)
public static Participant parseFrom(ByteBuffer data)
parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)
public static Participant parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)
parser()
public static Parser<Participant> parser()
Methods
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
|
equals(Object obj)
public boolean equals(Object obj)
| Parameter |
| Name |
Description |
obj |
Object
|
Overrides
getDefaultInstanceForType()
public Participant getDefaultInstanceForType()
public Map<String,String> getDocumentsMetadataFilters()
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 |
|
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];
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];
| Returns |
| Type |
Description |
String |
|
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()
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:
- If you set this field in
CreateParticipantRequest
or
UpdateParticipantRequest,
Dialogflow adds the obfuscated user id with the participant.
- 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:
- 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];
| 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:
- If you set this field in
CreateParticipantRequest
or
UpdateParticipantRequest,
Dialogflow adds the obfuscated user id with the participant.
- 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:
- 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];
| Returns |
| Type |
Description |
ByteString |
The bytes for obfuscatedExternalUserId.
|
getParserForType()
public Parser<Participant> getParserForType()
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];
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
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.
|
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.
|
getUnknownFields()
public final UnknownFieldSet getUnknownFields()
Overrides
hashCode()
| Returns |
| Type |
Description |
int |
|
Overrides
internalGetFieldAccessorTable()
protected GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
Overrides
internalGetMapField(int number)
protected MapField internalGetMapField(int number)
| Parameter |
| Name |
Description |
number |
int
|
Overrides
isInitialized()
public final boolean isInitialized()
Overrides
newBuilderForType()
public Participant.Builder newBuilderForType()
newBuilderForType(GeneratedMessageV3.BuilderParent parent)
protected Participant.Builder newBuilderForType(GeneratedMessageV3.BuilderParent parent)
Overrides
newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)
protected Object newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)
| Returns |
| Type |
Description |
Object |
|
Overrides
toBuilder()
public Participant.Builder toBuilder()
writeTo(CodedOutputStream output)
public void writeTo(CodedOutputStream output)
Overrides
