Google Cloud Dialogflow V2 Client - Class CreateConversationRequest (1.15.0)

Reference documentation and code samples for the Google Cloud Dialogflow V2 Client class CreateConversationRequest.

The request message for Conversations.CreateConversation.

Generated from protobuf message google.cloud.dialogflow.v2.CreateConversationRequest

Namespace

Google \ Cloud \ Dialogflow \ V2

Methods

__construct

Constructor.

Parameters
Name Description
data array

Optional. Data for populating the Message object.
↳ parent string

Required. Resource identifier of the project creating the conversation. Format: projects/<Project ID>/locations/<Location ID>.
↳ conversation Google\Cloud\Dialogflow\V2\Conversation

Required. The conversation to create.
↳ conversation_id string

Optional. Identifier of the conversation. Generally it's auto generated by Google. Only set it if you cannot wait for the response to return a auto-generated one to you. The conversation ID must be compliant with the regression fomula [a-zA-Z][a-zA-Z0-9_-]* with the characters length in range of [3,64]. If the field is provided, the caller is resposible for 1. the uniqueness of the ID, otherwise the request will be rejected. 2. the consistency for whether to use custom ID or not under a project to better ensure uniqueness.

getParent

Required. Resource identifier of the project creating the conversation.

Format: projects/<Project ID>/locations/<Location ID>.

Returns
Type Description
string

setParent

Required. Resource identifier of the project creating the conversation.

Format: projects/<Project ID>/locations/<Location ID>.

Parameter
Name Description
var string
Returns
Type Description
$this

getConversation

Required. The conversation to create.

Returns
Type Description
Google\Cloud\Dialogflow\V2\Conversation|null

hasConversation

clearConversation

setConversation

Required. The conversation to create.

Parameter
Name Description
var Google\Cloud\Dialogflow\V2\Conversation
Returns
Type Description
$this

getConversationId

Optional. Identifier of the conversation. Generally it's auto generated by Google. Only set it if you cannot wait for the response to return a auto-generated one to you.

The conversation ID must be compliant with the regression fomula [a-zA-Z][a-zA-Z0-9_-]* with the characters length in range of [3,64]. If the field is provided, the caller is resposible for

  1. the uniqueness of the ID, otherwise the request will be rejected.
  2. the consistency for whether to use custom ID or not under a project to better ensure uniqueness.
Returns
Type Description
string

setConversationId

Optional. Identifier of the conversation. Generally it's auto generated by Google. Only set it if you cannot wait for the response to return a auto-generated one to you.

The conversation ID must be compliant with the regression fomula [a-zA-Z][a-zA-Z0-9_-]* with the characters length in range of [3,64]. If the field is provided, the caller is resposible for

  1. the uniqueness of the ID, otherwise the request will be rejected.
  2. the consistency for whether to use custom ID or not under a project to better ensure uniqueness.
Parameter
Name Description
var string
Returns
Type Description
$this

static::build

Parameters
Name Description
parent string

Required. Resource identifier of the project creating the conversation. Format: projects/<Project ID>/locations/<Location ID>. Please see Google\Cloud\Dialogflow\V2\ConversationsClient::projectName() for help formatting this field.
conversation Google\Cloud\Dialogflow\V2\Conversation

Required. The conversation to create.
Returns
Type Description
Google\Cloud\Dialogflow\V2\CreateConversationRequest