Google Native

v0.27.0 published on Friday, Oct 21, 2022 by Pulumi

getParticipant

Retrieves a conversation participant.

Using getParticipant

Two invocation forms are available. The direct form accepts plain arguments and either blocks until the result value is available, or returns a Promise-wrapped result. The output form accepts Input-wrapped arguments and returns an Output-wrapped result.

function getParticipant(args: GetParticipantArgs, opts?: InvokeOptions): Promise<GetParticipantResult>
function getParticipantOutput(args: GetParticipantOutputArgs, opts?: InvokeOptions): Output<GetParticipantResult>

def get_participant(conversation_id: Optional[str] = None,
                    location: Optional[str] = None,
                    participant_id: Optional[str] = None,
                    project: Optional[str] = None,
                    opts: Optional[InvokeOptions] = None) -> GetParticipantResult
def get_participant_output(conversation_id: Optional[pulumi.Input[str]] = None,
                    location: Optional[pulumi.Input[str]] = None,
                    participant_id: Optional[pulumi.Input[str]] = None,
                    project: Optional[pulumi.Input[str]] = None,
                    opts: Optional[InvokeOptions] = None) -> Output[GetParticipantResult]

func LookupParticipant(ctx *Context, args *LookupParticipantArgs, opts ...InvokeOption) (*LookupParticipantResult, error)
func LookupParticipantOutput(ctx *Context, args *LookupParticipantOutputArgs, opts ...InvokeOption) LookupParticipantResultOutput

> Note: This function is named LookupParticipant in the Go SDK.

public static class GetParticipant 
{
    public static Task<GetParticipantResult> InvokeAsync(GetParticipantArgs args, InvokeOptions? opts = null)
    public static Output<GetParticipantResult> Invoke(GetParticipantInvokeArgs args, InvokeOptions? opts = null)
}

public static CompletableFuture<GetParticipantResult> getParticipant(GetParticipantArgs args, InvokeOptions options)
// Output-based functions aren't available in Java yet

fn::invoke:
  function: google-native:dialogflow/v2:getParticipant
  arguments:
    # arguments dictionary

The following arguments are supported:

ConversationId string
Location string
ParticipantId string
Project string

ConversationId string
Location string
ParticipantId string
Project string

conversationId String
location String
participantId String
project String

conversationId string
location string
participantId string
project string

conversation_id str
location str
participant_id str
project str

conversationId String
location String
participantId String
project String

getParticipant Result

The following output properties are available:

DocumentsMetadataFilters Dictionary<string, string>: 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 documents_metadata_filters { key: "market" value: "US,CA" } documents_metadata_filters { key: "user" value: "agent" }
Name string: Optional. The unique identifier of this participant. Format: projects//locations//conversations//participants/.
Role string: Immutable. The role this participant plays in the conversation. This field must be set during participant creation and is then immutable.
SipRecordingMediaLabel string: 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.

DocumentsMetadataFilters map[string]string: 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 documents_metadata_filters { key: "market" value: "US,CA" } documents_metadata_filters { key: "user" value: "agent" }
Name string: Optional. The unique identifier of this participant. Format: projects//locations//conversations//participants/.
Role string: Immutable. The role this participant plays in the conversation. This field must be set during participant creation and is then immutable.
SipRecordingMediaLabel string: 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.

documentsMetadataFilters Map<String,String>: 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 documents_metadata_filters { key: "market" value: "US,CA" } documents_metadata_filters { key: "user" value: "agent" }
name String: Optional. The unique identifier of this participant. Format: projects//locations//conversations//participants/.
role String: Immutable. The role this participant plays in the conversation. This field must be set during participant creation and is then immutable.
sipRecordingMediaLabel String: 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.

documentsMetadataFilters {[key: string]: string}: 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 documents_metadata_filters { key: "market" value: "US,CA" } documents_metadata_filters { key: "user" value: "agent" }
name string: Optional. The unique identifier of this participant. Format: projects//locations//conversations//participants/.
role string: Immutable. The role this participant plays in the conversation. This field must be set during participant creation and is then immutable.
sipRecordingMediaLabel string: 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.

documents_metadata_filters Mapping[str, str]: 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 documents_metadata_filters { key: "market" value: "US,CA" } documents_metadata_filters { key: "user" value: "agent" }
name str: Optional. The unique identifier of this participant. Format: projects//locations//conversations//participants/.
role str: Immutable. The role this participant plays in the conversation. This field must be set during participant creation and is then immutable.
sip_recording_media_label str: 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.

documentsMetadataFilters Map<String>: 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 documents_metadata_filters { key: "market" value: "US,CA" } documents_metadata_filters { key: "user" value: "agent" }
name String: Optional. The unique identifier of this participant. Format: projects//locations//conversations//participants/.
role String: Immutable. The role this participant plays in the conversation. This field must be set during participant creation and is then immutable.
sipRecordingMediaLabel String: 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.

Package Details

Repository: https://github.com/pulumi/pulumi-google-native
License: Apache-2.0

Google Native

getParticipant

Using getParticipant

getParticipant Result

Package Details

Contents