public static final class Participant.Builder extends com.google.protobuf.GeneratedMessageV3.Builder<Participant.Builder> implements ParticipantOrBuilder
Represents a conversation participant (human agent, virtual agent, end-user).Protobuf type
google.cloud.dialogflow.v2beta1.ParticipantgetAllFields, getField, getFieldBuilder, getOneofFieldDescriptor, getParentForChildren, getRepeatedField, getRepeatedFieldBuilder, getRepeatedFieldCount, getUnknownFields, getUnknownFieldSetBuilder, hasField, hasOneof, isClean, markClean, mergeUnknownLengthDelimitedField, mergeUnknownVarintField, newBuilderForField, onBuilt, onChanged, parseUnknownField, setUnknownFieldSetBuilder, setUnknownFieldsProto3findInitializationErrors, getInitializationErrorString, internalMergeFrom, mergeFrom, mergeFrom, mergeFrom, mergeFrom, mergeFrom, mergeFrom, mergeFrom, mergeFrom, mergeFrom, newUninitializedMessageException, toStringaddAll, addAll, mergeDelimitedFrom, mergeDelimitedFrom, mergeFrom, newUninitializedMessageExceptionequals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, waitfindInitializationErrors, getAllFields, getField, getInitializationErrorString, getOneofFieldDescriptor, getRepeatedField, getRepeatedFieldCount, getUnknownFields, hasField, hasOneofpublic static final com.google.protobuf.Descriptors.Descriptor getDescriptor()
protected com.google.protobuf.MapField internalGetMapField(int number)
internalGetMapField in class com.google.protobuf.GeneratedMessageV3.Builder<Participant.Builder>protected com.google.protobuf.MapField internalGetMutableMapField(int number)
internalGetMutableMapField in class com.google.protobuf.GeneratedMessageV3.Builder<Participant.Builder>protected com.google.protobuf.GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
internalGetFieldAccessorTable in class com.google.protobuf.GeneratedMessageV3.Builder<Participant.Builder>public Participant.Builder clear()
clear in interface com.google.protobuf.Message.Builderclear in interface com.google.protobuf.MessageLite.Builderclear in class com.google.protobuf.GeneratedMessageV3.Builder<Participant.Builder>public com.google.protobuf.Descriptors.Descriptor getDescriptorForType()
getDescriptorForType in interface com.google.protobuf.Message.BuildergetDescriptorForType in interface com.google.protobuf.MessageOrBuildergetDescriptorForType in class com.google.protobuf.GeneratedMessageV3.Builder<Participant.Builder>public Participant getDefaultInstanceForType()
getDefaultInstanceForType in interface com.google.protobuf.MessageLiteOrBuildergetDefaultInstanceForType in interface com.google.protobuf.MessageOrBuilderpublic Participant build()
build in interface com.google.protobuf.Message.Builderbuild in interface com.google.protobuf.MessageLite.Builderpublic Participant buildPartial()
buildPartial in interface com.google.protobuf.Message.BuilderbuildPartial in interface com.google.protobuf.MessageLite.Builderpublic Participant.Builder clone()
clone in interface com.google.protobuf.Message.Builderclone in interface com.google.protobuf.MessageLite.Builderclone in class com.google.protobuf.GeneratedMessageV3.Builder<Participant.Builder>public Participant.Builder setField(com.google.protobuf.Descriptors.FieldDescriptor field, Object value)
setField in interface com.google.protobuf.Message.BuildersetField in class com.google.protobuf.GeneratedMessageV3.Builder<Participant.Builder>public Participant.Builder clearField(com.google.protobuf.Descriptors.FieldDescriptor field)
clearField in interface com.google.protobuf.Message.BuilderclearField in class com.google.protobuf.GeneratedMessageV3.Builder<Participant.Builder>public Participant.Builder clearOneof(com.google.protobuf.Descriptors.OneofDescriptor oneof)
clearOneof in interface com.google.protobuf.Message.BuilderclearOneof in class com.google.protobuf.GeneratedMessageV3.Builder<Participant.Builder>public Participant.Builder setRepeatedField(com.google.protobuf.Descriptors.FieldDescriptor field, int index, Object value)
setRepeatedField in interface com.google.protobuf.Message.BuildersetRepeatedField in class com.google.protobuf.GeneratedMessageV3.Builder<Participant.Builder>public Participant.Builder addRepeatedField(com.google.protobuf.Descriptors.FieldDescriptor field, Object value)
addRepeatedField in interface com.google.protobuf.Message.BuilderaddRepeatedField in class com.google.protobuf.GeneratedMessageV3.Builder<Participant.Builder>public Participant.Builder mergeFrom(com.google.protobuf.Message other)
mergeFrom in interface com.google.protobuf.Message.BuildermergeFrom in class com.google.protobuf.AbstractMessage.Builder<Participant.Builder>public Participant.Builder mergeFrom(Participant other)
public final boolean isInitialized()
isInitialized in interface com.google.protobuf.MessageLiteOrBuilderisInitialized in class com.google.protobuf.GeneratedMessageV3.Builder<Participant.Builder>public Participant.Builder mergeFrom(com.google.protobuf.CodedInputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws IOException
mergeFrom in interface com.google.protobuf.Message.BuildermergeFrom in interface com.google.protobuf.MessageLite.BuildermergeFrom in class com.google.protobuf.AbstractMessage.Builder<Participant.Builder>IOExceptionpublic 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];getName in interface ParticipantOrBuilderpublic com.google.protobuf.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];getNameBytes in interface ParticipantOrBuilderpublic 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];value - The name to set.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];public Participant.Builder setNameBytes(com.google.protobuf.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];value - The bytes for name to set.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];
getRoleValue in interface ParticipantOrBuilderpublic 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.v2beta1.Participant.Role role = 2 [(.google.api.field_behavior) = IMMUTABLE];
value - The enum numeric value on the wire for role to set.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];
getRole in interface ParticipantOrBuilderpublic 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.v2beta1.Participant.Role role = 2 [(.google.api.field_behavior) = IMMUTABLE];
value - The role to set.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.v2beta1.Participant.Role role = 2 [(.google.api.field_behavior) = IMMUTABLE];
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][google.cloud.dialogflow.v2beta1.CreateParticipantRequest.participant]
or
[UpdateParticipantRequest][google.cloud.dialogflow.v2beta1.UpdateParticipantRequest.participant],
Dialogflow adds the obfuscated user id with the participant.
2. If you set this field in
[AnalyzeContent][google.cloud.dialogflow.v2beta1.AnalyzeContentRequest.obfuscated_external_user_id]
or
[StreamingAnalyzeContent][google.cloud.dialogflow.v2beta1.StreamingAnalyzeContentRequest.obfuscated_external_user_id],
Dialogflow will update
[Participant.obfuscated_external_user_id][google.cloud.dialogflow.v2beta1.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:
* 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];
getObfuscatedExternalUserId in interface ParticipantOrBuilderpublic com.google.protobuf.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][google.cloud.dialogflow.v2beta1.CreateParticipantRequest.participant]
or
[UpdateParticipantRequest][google.cloud.dialogflow.v2beta1.UpdateParticipantRequest.participant],
Dialogflow adds the obfuscated user id with the participant.
2. If you set this field in
[AnalyzeContent][google.cloud.dialogflow.v2beta1.AnalyzeContentRequest.obfuscated_external_user_id]
or
[StreamingAnalyzeContent][google.cloud.dialogflow.v2beta1.StreamingAnalyzeContentRequest.obfuscated_external_user_id],
Dialogflow will update
[Participant.obfuscated_external_user_id][google.cloud.dialogflow.v2beta1.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:
* 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];
getObfuscatedExternalUserIdBytes in interface ParticipantOrBuilderpublic 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][google.cloud.dialogflow.v2beta1.CreateParticipantRequest.participant]
or
[UpdateParticipantRequest][google.cloud.dialogflow.v2beta1.UpdateParticipantRequest.participant],
Dialogflow adds the obfuscated user id with the participant.
2. If you set this field in
[AnalyzeContent][google.cloud.dialogflow.v2beta1.AnalyzeContentRequest.obfuscated_external_user_id]
or
[StreamingAnalyzeContent][google.cloud.dialogflow.v2beta1.StreamingAnalyzeContentRequest.obfuscated_external_user_id],
Dialogflow will update
[Participant.obfuscated_external_user_id][google.cloud.dialogflow.v2beta1.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:
* 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];
value - The obfuscatedExternalUserId to set.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][google.cloud.dialogflow.v2beta1.CreateParticipantRequest.participant]
or
[UpdateParticipantRequest][google.cloud.dialogflow.v2beta1.UpdateParticipantRequest.participant],
Dialogflow adds the obfuscated user id with the participant.
2. If you set this field in
[AnalyzeContent][google.cloud.dialogflow.v2beta1.AnalyzeContentRequest.obfuscated_external_user_id]
or
[StreamingAnalyzeContent][google.cloud.dialogflow.v2beta1.StreamingAnalyzeContentRequest.obfuscated_external_user_id],
Dialogflow will update
[Participant.obfuscated_external_user_id][google.cloud.dialogflow.v2beta1.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:
* 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];
public Participant.Builder setObfuscatedExternalUserIdBytes(com.google.protobuf.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][google.cloud.dialogflow.v2beta1.CreateParticipantRequest.participant]
or
[UpdateParticipantRequest][google.cloud.dialogflow.v2beta1.UpdateParticipantRequest.participant],
Dialogflow adds the obfuscated user id with the participant.
2. If you set this field in
[AnalyzeContent][google.cloud.dialogflow.v2beta1.AnalyzeContentRequest.obfuscated_external_user_id]
or
[StreamingAnalyzeContent][google.cloud.dialogflow.v2beta1.StreamingAnalyzeContentRequest.obfuscated_external_user_id],
Dialogflow will update
[Participant.obfuscated_external_user_id][google.cloud.dialogflow.v2beta1.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:
* 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];
value - The bytes for obfuscatedExternalUserId to set.public int getDocumentsMetadataFiltersCount()
ParticipantOrBuilder
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][google.cloud.dialogflow.v2beta1.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
```
documents_metadata_filters {
key: "market"
value: "US,CA"
}
documents_metadata_filters {
key: "user"
value: "agent"
}
```
map<string, string> documents_metadata_filters = 8 [(.google.api.field_behavior) = OPTIONAL];
getDocumentsMetadataFiltersCount in interface ParticipantOrBuilderpublic 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][google.cloud.dialogflow.v2beta1.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
```
documents_metadata_filters {
key: "market"
value: "US,CA"
}
documents_metadata_filters {
key: "user"
value: "agent"
}
```
map<string, string> documents_metadata_filters = 8 [(.google.api.field_behavior) = OPTIONAL];
containsDocumentsMetadataFilters in interface ParticipantOrBuilder@Deprecated public Map<String,String> getDocumentsMetadataFilters()
getDocumentsMetadataFiltersMap() instead.getDocumentsMetadataFilters in interface ParticipantOrBuilderpublic 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][google.cloud.dialogflow.v2beta1.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
```
documents_metadata_filters {
key: "market"
value: "US,CA"
}
documents_metadata_filters {
key: "user"
value: "agent"
}
```
map<string, string> documents_metadata_filters = 8 [(.google.api.field_behavior) = OPTIONAL];
getDocumentsMetadataFiltersMap in interface ParticipantOrBuilderpublic 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][google.cloud.dialogflow.v2beta1.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
```
documents_metadata_filters {
key: "market"
value: "US,CA"
}
documents_metadata_filters {
key: "user"
value: "agent"
}
```
map<string, string> documents_metadata_filters = 8 [(.google.api.field_behavior) = OPTIONAL];
getDocumentsMetadataFiltersOrDefault in interface ParticipantOrBuilderpublic 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][google.cloud.dialogflow.v2beta1.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
```
documents_metadata_filters {
key: "market"
value: "US,CA"
}
documents_metadata_filters {
key: "user"
value: "agent"
}
```
map<string, string> documents_metadata_filters = 8 [(.google.api.field_behavior) = OPTIONAL];
getDocumentsMetadataFiltersOrThrow in interface ParticipantOrBuilderpublic Participant.Builder clearDocumentsMetadataFilters()
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][google.cloud.dialogflow.v2beta1.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
```
documents_metadata_filters {
key: "market"
value: "US,CA"
}
documents_metadata_filters {
key: "user"
value: "agent"
}
```
map<string, string> documents_metadata_filters = 8 [(.google.api.field_behavior) = OPTIONAL];
@Deprecated public Map<String,String> getMutableDocumentsMetadataFilters()
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][google.cloud.dialogflow.v2beta1.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
```
documents_metadata_filters {
key: "market"
value: "US,CA"
}
documents_metadata_filters {
key: "user"
value: "agent"
}
```
map<string, string> documents_metadata_filters = 8 [(.google.api.field_behavior) = OPTIONAL];
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][google.cloud.dialogflow.v2beta1.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
```
documents_metadata_filters {
key: "market"
value: "US,CA"
}
documents_metadata_filters {
key: "user"
value: "agent"
}
```
map<string, string> documents_metadata_filters = 8 [(.google.api.field_behavior) = OPTIONAL];
public final Participant.Builder setUnknownFields(com.google.protobuf.UnknownFieldSet unknownFields)
setUnknownFields in interface com.google.protobuf.Message.BuildersetUnknownFields in class com.google.protobuf.GeneratedMessageV3.Builder<Participant.Builder>public final Participant.Builder mergeUnknownFields(com.google.protobuf.UnknownFieldSet unknownFields)
mergeUnknownFields in interface com.google.protobuf.Message.BuildermergeUnknownFields in class com.google.protobuf.GeneratedMessageV3.Builder<Participant.Builder>Copyright © 2023 Google LLC. All rights reserved.