Package com.google.cloud.dialogflow.v2

Class Participant.Builder

  • All Implemented Interfaces:
    ParticipantOrBuilder, com.google.protobuf.Message.Builder, com.google.protobuf.MessageLite.Builder, com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder, Cloneable
    Enclosing class:
    Participant
    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.v2.Participant

    • Method Detail

      • getDescriptor

        public static final com.google.protobuf.Descriptors.Descriptor getDescriptor()

      • internalGetMapField

        protected com.google.protobuf.MapField internalGetMapField​(int number)
        Overrides:
        internalGetMapField in class com.google.protobuf.GeneratedMessageV3.Builder<Participant.Builder>

      • internalGetMutableMapField

        protected com.google.protobuf.MapField internalGetMutableMapField​(int number)
        Overrides:
        internalGetMutableMapField in class com.google.protobuf.GeneratedMessageV3.Builder<Participant.Builder>

      • internalGetFieldAccessorTable

        protected com.google.protobuf.GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
        Specified by:
        internalGetFieldAccessorTable in class com.google.protobuf.GeneratedMessageV3.Builder<Participant.Builder>

      • clear

        public Participant.Builder clear()
        Specified by:
        clear in interface com.google.protobuf.Message.Builder
        Specified by:
        clear in interface com.google.protobuf.MessageLite.Builder
        Overrides:
        clear in class com.google.protobuf.GeneratedMessageV3.Builder<Participant.Builder>

      • getDescriptorForType

        public com.google.protobuf.Descriptors.Descriptor getDescriptorForType()
        Specified by:
        getDescriptorForType in interface com.google.protobuf.Message.Builder
        Specified by:
        getDescriptorForType in interface com.google.protobuf.MessageOrBuilder
        Overrides:
        getDescriptorForType in class com.google.protobuf.GeneratedMessageV3.Builder<Participant.Builder>

      • getDefaultInstanceForType

        public Participant getDefaultInstanceForType()
        Specified by:
        getDefaultInstanceForType in interface com.google.protobuf.MessageLiteOrBuilder
        Specified by:
        getDefaultInstanceForType in interface com.google.protobuf.MessageOrBuilder

      • build

        public Participant build()
        Specified by:
        build in interface com.google.protobuf.Message.Builder
        Specified by:
        build in interface com.google.protobuf.MessageLite.Builder

      • buildPartial

        public Participant buildPartial()
        Specified by:
        buildPartial in interface com.google.protobuf.Message.Builder
        Specified by:
        buildPartial in interface com.google.protobuf.MessageLite.Builder

      • clone

        public Participant.Builder clone()
        Specified by:
        clone in interface com.google.protobuf.Message.Builder
        Specified by:
        clone in interface com.google.protobuf.MessageLite.Builder
        Overrides:
        clone in class com.google.protobuf.GeneratedMessageV3.Builder<Participant.Builder>

      • setField

        public Participant.Builder setField​(com.google.protobuf.Descriptors.FieldDescriptor field,
                                    Object value)
        Specified by:
        setField in interface com.google.protobuf.Message.Builder
        Overrides:
        setField in class com.google.protobuf.GeneratedMessageV3.Builder<Participant.Builder>

      • clearField

        public Participant.Builder clearField​(com.google.protobuf.Descriptors.FieldDescriptor field)
        Specified by:
        clearField in interface com.google.protobuf.Message.Builder
        Overrides:
        clearField in class com.google.protobuf.GeneratedMessageV3.Builder<Participant.Builder>

      • clearOneof

        public Participant.Builder clearOneof​(com.google.protobuf.Descriptors.OneofDescriptor oneof)
        Specified by:
        clearOneof in interface com.google.protobuf.Message.Builder
        Overrides:
        clearOneof in class com.google.protobuf.GeneratedMessageV3.Builder<Participant.Builder>

      • setRepeatedField

        public Participant.Builder setRepeatedField​(com.google.protobuf.Descriptors.FieldDescriptor field,
                                            int index,
                                            Object value)
        Specified by:
        setRepeatedField in interface com.google.protobuf.Message.Builder
        Overrides:
        setRepeatedField in class com.google.protobuf.GeneratedMessageV3.Builder<Participant.Builder>

      • addRepeatedField

        public Participant.Builder addRepeatedField​(com.google.protobuf.Descriptors.FieldDescriptor field,
                                            Object value)
        Specified by:
        addRepeatedField in interface com.google.protobuf.Message.Builder
        Overrides:
        addRepeatedField in class com.google.protobuf.GeneratedMessageV3.Builder<Participant.Builder>

      • mergeFrom

        public Participant.Builder mergeFrom​(com.google.protobuf.Message other)
        Specified by:
        mergeFrom in interface com.google.protobuf.Message.Builder
        Overrides:
        mergeFrom in class com.google.protobuf.AbstractMessage.Builder<Participant.Builder>

      • isInitialized

        public final boolean isInitialized()
        Specified by:
        isInitialized in interface com.google.protobuf.MessageLiteOrBuilder
        Overrides:
        isInitialized in class com.google.protobuf.GeneratedMessageV3.Builder<Participant.Builder>

      • mergeFrom

        public Participant.Builder mergeFrom​(com.google.protobuf.CodedInputStream input,
                                     com.google.protobuf.ExtensionRegistryLite extensionRegistry)
                              throws IOException
        Specified by:
        mergeFrom in interface com.google.protobuf.Message.Builder
        Specified by:
        mergeFrom in interface com.google.protobuf.MessageLite.Builder
        Overrides:
        mergeFrom in class com.google.protobuf.AbstractMessage.Builder<Participant.Builder>
        Throws:
        IOException

      • 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];
        Specified by:
        getName in interface ParticipantOrBuilder
        Returns:
        The name.

      • getNameBytes

        public 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];
        Specified by:
        getNameBytes in interface ParticipantOrBuilder
        Returns:
        The bytes for name.

      • setName

        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];
        Parameters:
        value - The name to set.
        Returns:
        This builder for chaining.

      • 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:
        This builder for chaining.

      • setNameBytes

        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];
        Parameters:
        value - The bytes for name to set.
        Returns:
        This builder for chaining.

      • 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];
        Specified by:
        getRoleValue in interface ParticipantOrBuilder
        Returns:
        The enum numeric value on the wire for role.

      • setRoleValue

        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];
        Parameters:
        value - The enum numeric value on the wire for role to set.
        Returns:
        This builder for chaining.

      • 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];
        Specified by:
        getRole in interface ParticipantOrBuilder
        Returns:
        The role.

      • setRole

        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];
        Parameters:
        value - The role to set.
        Returns:
        This builder for chaining.

      • 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:
        This builder for chaining.

      • 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];
        Specified by:
        getSipRecordingMediaLabel in interface ParticipantOrBuilder
        Returns:
        The sipRecordingMediaLabel.

      • getSipRecordingMediaLabelBytes

        public com.google.protobuf.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];
        Specified by:
        getSipRecordingMediaLabelBytes in interface ParticipantOrBuilder
        Returns:
        The bytes for sipRecordingMediaLabel.

      • setSipRecordingMediaLabel

        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];
        Parameters:
        value - The sipRecordingMediaLabel to set.
        Returns:
        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:
        This builder for chaining.

      • setSipRecordingMediaLabelBytes

        public Participant.Builder setSipRecordingMediaLabelBytes​(com.google.protobuf.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];
        Parameters:
        value - The bytes for sipRecordingMediaLabel to set.
        Returns:
        This builder for chaining.

      • 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][google.cloud.dialogflow.v2.CreateParticipantRequest.participant]
    or
    [UpdateParticipantRequest][google.cloud.dialogflow.v2.UpdateParticipantRequest.participant],
    Dialogflow adds the obfuscated user id with the participant.

 2. If you set this field in
    [AnalyzeContent][google.cloud.dialogflow.v2.AnalyzeContentRequest.obfuscated_external_user_id]
    or
    [StreamingAnalyzeContent][google.cloud.dialogflow.v2.StreamingAnalyzeContentRequest.obfuscated_external_user_id],
    Dialogflow will update
    [Participant.obfuscated_external_user_id][google.cloud.dialogflow.v2.Participant.obfuscated_external_user_id].

 Dialogflow returns an error if you try to add a user id for a
 non-[END_USER][google.cloud.dialogflow.v2.Participant.Role.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];
        Specified by:
        getObfuscatedExternalUserId in interface ParticipantOrBuilder
        Returns:
        The obfuscatedExternalUserId.

      • getObfuscatedExternalUserIdBytes

        public 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.v2.CreateParticipantRequest.participant]
    or
    [UpdateParticipantRequest][google.cloud.dialogflow.v2.UpdateParticipantRequest.participant],
    Dialogflow adds the obfuscated user id with the participant.

 2. If you set this field in
    [AnalyzeContent][google.cloud.dialogflow.v2.AnalyzeContentRequest.obfuscated_external_user_id]
    or
    [StreamingAnalyzeContent][google.cloud.dialogflow.v2.StreamingAnalyzeContentRequest.obfuscated_external_user_id],
    Dialogflow will update
    [Participant.obfuscated_external_user_id][google.cloud.dialogflow.v2.Participant.obfuscated_external_user_id].

 Dialogflow returns an error if you try to add a user id for a
 non-[END_USER][google.cloud.dialogflow.v2.Participant.Role.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];
        Specified by:
        getObfuscatedExternalUserIdBytes in interface ParticipantOrBuilder
        Returns:
        The bytes for obfuscatedExternalUserId.

      • setObfuscatedExternalUserId

        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][google.cloud.dialogflow.v2.CreateParticipantRequest.participant]
    or
    [UpdateParticipantRequest][google.cloud.dialogflow.v2.UpdateParticipantRequest.participant],
    Dialogflow adds the obfuscated user id with the participant.

 2. If you set this field in
    [AnalyzeContent][google.cloud.dialogflow.v2.AnalyzeContentRequest.obfuscated_external_user_id]
    or
    [StreamingAnalyzeContent][google.cloud.dialogflow.v2.StreamingAnalyzeContentRequest.obfuscated_external_user_id],
    Dialogflow will update
    [Participant.obfuscated_external_user_id][google.cloud.dialogflow.v2.Participant.obfuscated_external_user_id].

 Dialogflow returns an error if you try to add a user id for a
 non-[END_USER][google.cloud.dialogflow.v2.Participant.Role.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];
        Parameters:
        value - The obfuscatedExternalUserId to set.
        Returns:
        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][google.cloud.dialogflow.v2.CreateParticipantRequest.participant]
    or
    [UpdateParticipantRequest][google.cloud.dialogflow.v2.UpdateParticipantRequest.participant],
    Dialogflow adds the obfuscated user id with the participant.

 2. If you set this field in
    [AnalyzeContent][google.cloud.dialogflow.v2.AnalyzeContentRequest.obfuscated_external_user_id]
    or
    [StreamingAnalyzeContent][google.cloud.dialogflow.v2.StreamingAnalyzeContentRequest.obfuscated_external_user_id],
    Dialogflow will update
    [Participant.obfuscated_external_user_id][google.cloud.dialogflow.v2.Participant.obfuscated_external_user_id].

 Dialogflow returns an error if you try to add a user id for a
 non-[END_USER][google.cloud.dialogflow.v2.Participant.Role.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:
        This builder for chaining.

      • setObfuscatedExternalUserIdBytes

        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.v2.CreateParticipantRequest.participant]
    or
    [UpdateParticipantRequest][google.cloud.dialogflow.v2.UpdateParticipantRequest.participant],
    Dialogflow adds the obfuscated user id with the participant.

 2. If you set this field in
    [AnalyzeContent][google.cloud.dialogflow.v2.AnalyzeContentRequest.obfuscated_external_user_id]
    or
    [StreamingAnalyzeContent][google.cloud.dialogflow.v2.StreamingAnalyzeContentRequest.obfuscated_external_user_id],
    Dialogflow will update
    [Participant.obfuscated_external_user_id][google.cloud.dialogflow.v2.Participant.obfuscated_external_user_id].

 Dialogflow returns an error if you try to add a user id for a
 non-[END_USER][google.cloud.dialogflow.v2.Participant.Role.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];
        Parameters:
        value - The bytes for obfuscatedExternalUserId to set.
        Returns:
        This builder for chaining.

      • getDocumentsMetadataFiltersCount

        public int getDocumentsMetadataFiltersCount()
        Description copied from interface: 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.v2.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];
        Specified by:
        getDocumentsMetadataFiltersCount in interface ParticipantOrBuilder

      • containsDocumentsMetadataFilters

        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][google.cloud.dialogflow.v2.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];
        Specified by:
        containsDocumentsMetadataFilters in interface ParticipantOrBuilder

      • 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][google.cloud.dialogflow.v2.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];
        Specified by:
        getDocumentsMetadataFiltersMap in interface ParticipantOrBuilder

      • getDocumentsMetadataFiltersOrDefault

        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][google.cloud.dialogflow.v2.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];
        Specified by:
        getDocumentsMetadataFiltersOrDefault in interface ParticipantOrBuilder

      • getDocumentsMetadataFiltersOrThrow

        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][google.cloud.dialogflow.v2.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];
        Specified by:
        getDocumentsMetadataFiltersOrThrow in interface ParticipantOrBuilder

      • removeDocumentsMetadataFilters

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

      • getMutableDocumentsMetadataFilters

        @Deprecated
public Map<String,​String> getMutableDocumentsMetadataFilters()
        Deprecated.
        Use alternate mutation accessors instead.

      • putDocumentsMetadataFilters

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

      • putAllDocumentsMetadataFilters

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

      • setUnknownFields

        public final Participant.Builder setUnknownFields​(com.google.protobuf.UnknownFieldSet unknownFields)
        Specified by:
        setUnknownFields in interface com.google.protobuf.Message.Builder
        Overrides:
        setUnknownFields in class com.google.protobuf.GeneratedMessageV3.Builder<Participant.Builder>

      • mergeUnknownFields

        public final Participant.Builder mergeUnknownFields​(com.google.protobuf.UnknownFieldSet unknownFields)
        Specified by:
        mergeUnknownFields in interface com.google.protobuf.Message.Builder
        Overrides:
        mergeUnknownFields in class com.google.protobuf.GeneratedMessageV3.Builder<Participant.Builder>