Reference documentation and code samples for the Google Cloud Dialogflow Cx V3 Client class PlaybookInvocation.
Stores metadata of the invocation of a child playbook.
Generated from protobuf message google.cloud.dialogflow.cx.v3.PlaybookInvocation
Namespace
Google \ Cloud \ Dialogflow \ Cx \ V3Methods
__construct
Constructor.
| Parameters | |
|---|---|
| Name | Description |
data |
array
Optional. Data for populating the Message object. |
↳ playbook |
string
Required. The unique identifier of the playbook. Format: |
↳ display_name |
string
Output only. The display name of the playbook. |
↳ playbook_input |
PlaybookInput
Optional. Input of the child playbook invocation. |
↳ playbook_output |
PlaybookOutput
Optional. Output of the child playbook invocation. |
↳ playbook_state |
int
Required. Playbook invocation's output state. |
getPlaybook
Required. The unique identifier of the playbook.
Format:
projects/<ProjectID>/locations/<LocationID>/agents/<AgentID>/playbooks/<PlaybookID>.
| Returns | |
|---|---|
| Type | Description |
string |
|
setPlaybook
Required. The unique identifier of the playbook.
Format:
projects/<ProjectID>/locations/<LocationID>/agents/<AgentID>/playbooks/<PlaybookID>.
| Parameter | |
|---|---|
| Name | Description |
var |
string
|
| Returns | |
|---|---|
| Type | Description |
$this |
|
getDisplayName
Output only. The display name of the playbook.
| Returns | |
|---|---|
| Type | Description |
string |
|
setDisplayName
Output only. The display name of the playbook.
| Parameter | |
|---|---|
| Name | Description |
var |
string
|
| Returns | |
|---|---|
| Type | Description |
$this |
|
getPlaybookInput
Optional. Input of the child playbook invocation.
| Returns | |
|---|---|
| Type | Description |
PlaybookInput|null |
|
hasPlaybookInput
clearPlaybookInput
setPlaybookInput
Optional. Input of the child playbook invocation.
| Parameter | |
|---|---|
| Name | Description |
var |
PlaybookInput
|
| Returns | |
|---|---|
| Type | Description |
$this |
|
getPlaybookOutput
Optional. Output of the child playbook invocation.
| Returns | |
|---|---|
| Type | Description |
PlaybookOutput|null |
|
hasPlaybookOutput
clearPlaybookOutput
setPlaybookOutput
Optional. Output of the child playbook invocation.
| Parameter | |
|---|---|
| Name | Description |
var |
PlaybookOutput
|
| Returns | |
|---|---|
| Type | Description |
$this |
|
getPlaybookState
Required. Playbook invocation's output state.
| Returns | |
|---|---|
| Type | Description |
int |
Enum of type OutputState. |
setPlaybookState
Required. Playbook invocation's output state.
| Parameter | |
|---|---|
| Name | Description |
var |
int
Enum of type OutputState. |
| Returns | |
|---|---|
| Type | Description |
$this |
|