Package com.google.cloud.dialogflow.v2

Class Participant

  • All Implemented Interfaces:
    ParticipantOrBuilder, com.google.protobuf.Message, com.google.protobuf.MessageLite, com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder, Serializable
    public final class Participant
extends com.google.protobuf.GeneratedMessageV3
implements ParticipantOrBuilder
     Represents a conversation participant (human agent, virtual agent, end-user).
    Protobuf type google.cloud.dialogflow.v2.Participant
    See Also:
    Serialized Form

    • Field Detail

      • SIP_RECORDING_MEDIA_LABEL_FIELD_NUMBER

        public static final int SIP_RECORDING_MEDIA_LABEL_FIELD_NUMBER
        See Also:
        Constant Field Values

      • OBFUSCATED_EXTERNAL_USER_ID_FIELD_NUMBER

        public static final int OBFUSCATED_EXTERNAL_USER_ID_FIELD_NUMBER
        See Also:
        Constant Field Values

      • DOCUMENTS_METADATA_FILTERS_FIELD_NUMBER

        public static final int DOCUMENTS_METADATA_FILTERS_FIELD_NUMBER
        See Also:
        Constant Field Values

    • Method Detail

      • newInstance

        protected Object newInstance​(com.google.protobuf.GeneratedMessageV3.UnusedPrivateParameter unused)
        Overrides:
        newInstance in class com.google.protobuf.GeneratedMessageV3

      • 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

      • internalGetFieldAccessorTable

        protected com.google.protobuf.GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
        Specified by:
        internalGetFieldAccessorTable in class com.google.protobuf.GeneratedMessageV3

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

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

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

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

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

      • 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

      • isInitialized

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

      • writeTo

        public void writeTo​(com.google.protobuf.CodedOutputStream output)
             throws IOException
        Specified by:
        writeTo in interface com.google.protobuf.MessageLite
        Overrides:
        writeTo in class com.google.protobuf.GeneratedMessageV3
        Throws:
        IOException

      • getSerializedSize

        public int getSerializedSize()
        Specified by:
        getSerializedSize in interface com.google.protobuf.MessageLite
        Overrides:
        getSerializedSize in class com.google.protobuf.GeneratedMessageV3

      • equals

        public boolean equals​(Object obj)
        Specified by:
        equals in interface com.google.protobuf.Message
        Overrides:
        equals in class com.google.protobuf.AbstractMessage

      • hashCode

        public int hashCode()
        Specified by:
        hashCode in interface com.google.protobuf.Message
        Overrides:
        hashCode in class com.google.protobuf.AbstractMessage

      • parseFrom

        public static Participant parseFrom​(ByteBuffer data)
                             throws com.google.protobuf.InvalidProtocolBufferException
        Throws:
        com.google.protobuf.InvalidProtocolBufferException

      • parseFrom

        public static Participant parseFrom​(ByteBuffer data,
                                    com.google.protobuf.ExtensionRegistryLite extensionRegistry)
                             throws com.google.protobuf.InvalidProtocolBufferException
        Throws:
        com.google.protobuf.InvalidProtocolBufferException

      • parseFrom

        public static Participant parseFrom​(com.google.protobuf.ByteString data)
                             throws com.google.protobuf.InvalidProtocolBufferException
        Throws:
        com.google.protobuf.InvalidProtocolBufferException

      • parseFrom

        public static Participant parseFrom​(com.google.protobuf.ByteString data,
                                    com.google.protobuf.ExtensionRegistryLite extensionRegistry)
                             throws com.google.protobuf.InvalidProtocolBufferException
        Throws:
        com.google.protobuf.InvalidProtocolBufferException

      • parseFrom

        public static Participant parseFrom​(byte[] data)
                             throws com.google.protobuf.InvalidProtocolBufferException
        Throws:
        com.google.protobuf.InvalidProtocolBufferException

      • parseFrom

        public static Participant parseFrom​(byte[] data,
                                    com.google.protobuf.ExtensionRegistryLite extensionRegistry)
                             throws com.google.protobuf.InvalidProtocolBufferException
        Throws:
        com.google.protobuf.InvalidProtocolBufferException

      • parseFrom

        public static Participant parseFrom​(com.google.protobuf.CodedInputStream input,
                                    com.google.protobuf.ExtensionRegistryLite extensionRegistry)
                             throws IOException
        Throws:
        IOException

      • newBuilderForType

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

      • toBuilder

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

      • newBuilderForType

        protected Participant.Builder newBuilderForType​(com.google.protobuf.GeneratedMessageV3.BuilderParent parent)
        Specified by:
        newBuilderForType in class com.google.protobuf.GeneratedMessageV3

      • getDefaultInstance

        public static Participant getDefaultInstance()

      • parser

        public static com.google.protobuf.Parser<Participant> parser()

      • getParserForType

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

      • getDefaultInstanceForType

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