Docs Home Pulumi IaC Pulumi ESC Pulumi Insights Pulumi Cloud Packages Tutorials
  1. Packages
  2. Google Cloud Native
  3. API Docs
  4. dialogflow
  5. dialogflow/v2
  6. getConversation

Google Cloud Native is in preview. Google Cloud Classic is fully supported.

Google Cloud Native v0.32.0 published on Wednesday, Nov 29, 2023 by Pulumi
pulumi/pulumi-google-native

google-native.dialogflow/v2.getConversation

Explore with Pulumi AI

Google Cloud Native is in preview. Google Cloud Classic is fully supported.

Google Cloud Native v0.32.0 published on Wednesday, Nov 29, 2023 by Pulumi
pulumi/pulumi-google-native

Retrieves the specific conversation.

Using getConversation

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 getConversation(args: GetConversationArgs, opts?: InvokeOptions): Promise<GetConversationResult>
function getConversationOutput(args: GetConversationOutputArgs, opts?: InvokeOptions): Output<GetConversationResult>
Copy
def get_conversation(conversation_id: Optional[str] = None,
                     location: Optional[str] = None,
                     project: Optional[str] = None,
                     opts: Optional[InvokeOptions] = None) -> GetConversationResult
def get_conversation_output(conversation_id: Optional[pulumi.Input[str]] = None,
                     location: Optional[pulumi.Input[str]] = None,
                     project: Optional[pulumi.Input[str]] = None,
                     opts: Optional[InvokeOptions] = None) -> Output[GetConversationResult]
Copy
func LookupConversation(ctx *Context, args *LookupConversationArgs, opts ...InvokeOption) (*LookupConversationResult, error)
func LookupConversationOutput(ctx *Context, args *LookupConversationOutputArgs, opts ...InvokeOption) LookupConversationResultOutput
Copy

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

public static class GetConversation 
{
    public static Task<GetConversationResult> InvokeAsync(GetConversationArgs args, InvokeOptions? opts = null)
    public static Output<GetConversationResult> Invoke(GetConversationInvokeArgs args, InvokeOptions? opts = null)
}
Copy
public static CompletableFuture<GetConversationResult> getConversation(GetConversationArgs args, InvokeOptions options)
public static Output<GetConversationResult> getConversation(GetConversationArgs args, InvokeOptions options)
Copy
fn::invoke:
  function: google-native:dialogflow/v2:getConversation
  arguments:
    # arguments dictionary
Copy

The following arguments are supported:

ConversationId This property is required. string
Location This property is required. string
Project string
ConversationId This property is required. string
Location This property is required. string
Project string
conversationId This property is required. String
location This property is required. String
project String
conversationId This property is required. string
location This property is required. string
project string
conversation_id This property is required. str
location This property is required. str
project str
conversationId This property is required. String
location This property is required. String
project String

getConversation Result

The following output properties are available:

ConversationProfile string
The Conversation Profile to be used to configure this Conversation. This field cannot be updated. Format: projects//locations//conversationProfiles/.
ConversationStage string
The stage of a conversation. It indicates whether the virtual agent or a human agent is handling the conversation. If the conversation is created with the conversation profile that has Dialogflow config set, defaults to ConversationStage.VIRTUAL_AGENT_STAGE; Otherwise, defaults to ConversationStage.HUMAN_ASSIST_STAGE. If the conversation is created with the conversation profile that has Dialogflow config set but explicitly sets conversation_stage to ConversationStage.HUMAN_ASSIST_STAGE, it skips ConversationStage.VIRTUAL_AGENT_STAGE stage and directly goes to ConversationStage.HUMAN_ASSIST_STAGE.
EndTime string
The time the conversation was finished.
LifecycleState string
The current state of the Conversation.
Name string
The unique identifier of this conversation. Format: projects//locations//conversations/.
PhoneNumber Pulumi.GoogleNative.Dialogflow.V2.Outputs.GoogleCloudDialogflowV2ConversationPhoneNumberResponse
It will not be empty if the conversation is to be connected over telephony.
StartTime string
The time the conversation was started.
ConversationProfile string
The Conversation Profile to be used to configure this Conversation. This field cannot be updated. Format: projects//locations//conversationProfiles/.
ConversationStage string
The stage of a conversation. It indicates whether the virtual agent or a human agent is handling the conversation. If the conversation is created with the conversation profile that has Dialogflow config set, defaults to ConversationStage.VIRTUAL_AGENT_STAGE; Otherwise, defaults to ConversationStage.HUMAN_ASSIST_STAGE. If the conversation is created with the conversation profile that has Dialogflow config set but explicitly sets conversation_stage to ConversationStage.HUMAN_ASSIST_STAGE, it skips ConversationStage.VIRTUAL_AGENT_STAGE stage and directly goes to ConversationStage.HUMAN_ASSIST_STAGE.
EndTime string
The time the conversation was finished.
LifecycleState string
The current state of the Conversation.
Name string
The unique identifier of this conversation. Format: projects//locations//conversations/.
PhoneNumber GoogleCloudDialogflowV2ConversationPhoneNumberResponse
It will not be empty if the conversation is to be connected over telephony.
StartTime string
The time the conversation was started.
conversationProfile String
The Conversation Profile to be used to configure this Conversation. This field cannot be updated. Format: projects//locations//conversationProfiles/.
conversationStage String
The stage of a conversation. It indicates whether the virtual agent or a human agent is handling the conversation. If the conversation is created with the conversation profile that has Dialogflow config set, defaults to ConversationStage.VIRTUAL_AGENT_STAGE; Otherwise, defaults to ConversationStage.HUMAN_ASSIST_STAGE. If the conversation is created with the conversation profile that has Dialogflow config set but explicitly sets conversation_stage to ConversationStage.HUMAN_ASSIST_STAGE, it skips ConversationStage.VIRTUAL_AGENT_STAGE stage and directly goes to ConversationStage.HUMAN_ASSIST_STAGE.
endTime String
The time the conversation was finished.
lifecycleState String
The current state of the Conversation.
name String
The unique identifier of this conversation. Format: projects//locations//conversations/.
phoneNumber GoogleCloudDialogflowV2ConversationPhoneNumberResponse
It will not be empty if the conversation is to be connected over telephony.
startTime String
The time the conversation was started.
conversationProfile string
The Conversation Profile to be used to configure this Conversation. This field cannot be updated. Format: projects//locations//conversationProfiles/.
conversationStage string
The stage of a conversation. It indicates whether the virtual agent or a human agent is handling the conversation. If the conversation is created with the conversation profile that has Dialogflow config set, defaults to ConversationStage.VIRTUAL_AGENT_STAGE; Otherwise, defaults to ConversationStage.HUMAN_ASSIST_STAGE. If the conversation is created with the conversation profile that has Dialogflow config set but explicitly sets conversation_stage to ConversationStage.HUMAN_ASSIST_STAGE, it skips ConversationStage.VIRTUAL_AGENT_STAGE stage and directly goes to ConversationStage.HUMAN_ASSIST_STAGE.
endTime string
The time the conversation was finished.
lifecycleState string
The current state of the Conversation.
name string
The unique identifier of this conversation. Format: projects//locations//conversations/.
phoneNumber GoogleCloudDialogflowV2ConversationPhoneNumberResponse
It will not be empty if the conversation is to be connected over telephony.
startTime string
The time the conversation was started.
conversation_profile str
The Conversation Profile to be used to configure this Conversation. This field cannot be updated. Format: projects//locations//conversationProfiles/.
conversation_stage str
The stage of a conversation. It indicates whether the virtual agent or a human agent is handling the conversation. If the conversation is created with the conversation profile that has Dialogflow config set, defaults to ConversationStage.VIRTUAL_AGENT_STAGE; Otherwise, defaults to ConversationStage.HUMAN_ASSIST_STAGE. If the conversation is created with the conversation profile that has Dialogflow config set but explicitly sets conversation_stage to ConversationStage.HUMAN_ASSIST_STAGE, it skips ConversationStage.VIRTUAL_AGENT_STAGE stage and directly goes to ConversationStage.HUMAN_ASSIST_STAGE.
end_time str
The time the conversation was finished.
lifecycle_state str
The current state of the Conversation.
name str
The unique identifier of this conversation. Format: projects//locations//conversations/.
phone_number GoogleCloudDialogflowV2ConversationPhoneNumberResponse
It will not be empty if the conversation is to be connected over telephony.
start_time str
The time the conversation was started.
conversationProfile String
The Conversation Profile to be used to configure this Conversation. This field cannot be updated. Format: projects//locations//conversationProfiles/.
conversationStage String
The stage of a conversation. It indicates whether the virtual agent or a human agent is handling the conversation. If the conversation is created with the conversation profile that has Dialogflow config set, defaults to ConversationStage.VIRTUAL_AGENT_STAGE; Otherwise, defaults to ConversationStage.HUMAN_ASSIST_STAGE. If the conversation is created with the conversation profile that has Dialogflow config set but explicitly sets conversation_stage to ConversationStage.HUMAN_ASSIST_STAGE, it skips ConversationStage.VIRTUAL_AGENT_STAGE stage and directly goes to ConversationStage.HUMAN_ASSIST_STAGE.
endTime String
The time the conversation was finished.
lifecycleState String
The current state of the Conversation.
name String
The unique identifier of this conversation. Format: projects//locations//conversations/.
phoneNumber Property Map
It will not be empty if the conversation is to be connected over telephony.
startTime String
The time the conversation was started.

Supporting Types

GoogleCloudDialogflowV2ConversationPhoneNumberResponse

PhoneNumber This property is required. string
The phone number to connect to this conversation.
PhoneNumber This property is required. string
The phone number to connect to this conversation.
phoneNumber This property is required. String
The phone number to connect to this conversation.
phoneNumber This property is required. string
The phone number to connect to this conversation.
phone_number This property is required. str
The phone number to connect to this conversation.
phoneNumber This property is required. String
The phone number to connect to this conversation.

Package Details

Repository
Google Cloud Native pulumi/pulumi-google-native
License
Apache-2.0

Google Cloud Native is in preview. Google Cloud Classic is fully supported.

Google Cloud Native v0.32.0 published on Wednesday, Nov 29, 2023 by Pulumi
pulumi/pulumi-google-native