com.google.cloud.dialogflow.v2

Interface ParticipantOrBuilder

All Superinterfaces:

MessageLiteOrBuilder, MessageOrBuilder

All Known Implementing Classes:

Participant, Participant.Builder

public interface ParticipantOrBuilder
extends MessageOrBuilder

Method Summary

Modifier and Type	Method and Description
boolean	containsDocumentsMetadataFilters(String key) Optional.
Map<String,String>	getDocumentsMetadataFilters() Deprecated.
int	getDocumentsMetadataFiltersCount() Optional.
Map<String,String>	getDocumentsMetadataFiltersMap() Optional.
String	getDocumentsMetadataFiltersOrDefault(String key, String defaultValue) Optional.
String	getDocumentsMetadataFiltersOrThrow(String key) Optional.
String	getName() Optional.
ByteString	getNameBytes() Optional.
Participant.Role	getRole() Immutable.
int	getRoleValue() Immutable.
String	getSipRecordingMediaLabel() Optional.
ByteString	getSipRecordingMediaLabelBytes() Optional.

Methods inherited from interface com.google.protobuf.MessageOrBuilder

findInitializationErrors, getAllFields, getDefaultInstanceForType, getDescriptorForType, getField, getInitializationErrorString, getOneofFieldDescriptor, getRepeatedField, getRepeatedFieldCount, getUnknownFields, hasField, hasOneof

Methods inherited from interface com.google.protobuf.MessageLiteOrBuilder

isInitialized

Method Detail

getName

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:

The name.

getNameBytes

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:

The bytes for name.

getRoleValue

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:

The enum numeric value on the wire for role.

getRole

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:

The role.

getSipRecordingMediaLabel

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:

The sipRecordingMediaLabel.

getSipRecordingMediaLabelBytes

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:

The bytes for sipRecordingMediaLabel.

getDocumentsMetadataFiltersCount

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][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];

containsDocumentsMetadataFilters

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

getDocumentsMetadataFilters

@Deprecated
Map<String,String> getDocumentsMetadataFilters()

Deprecated.

Use getDocumentsMetadataFiltersMap() instead.

getDocumentsMetadataFiltersMap

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

getDocumentsMetadataFiltersOrDefault

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

getDocumentsMetadataFiltersOrThrow

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