Reference documentation and code samples for the Dialogflow CX V3 API class Google::Cloud::Dialogflow::CX::V3::PlaybookInvocation.
Stores metadata of the invocation of a child playbook.
Inherits
- Object
Extended By
- Google::Protobuf::MessageExts::ClassMethods
Includes
- Google::Protobuf::MessageExts
Methods
#display_name
def display_name() -> ::String
Returns
- (::String) — Output only. The display name of the playbook.
#playbook
def playbook() -> ::String
Returns
-
(::String) — Required. The unique identifier of the playbook.
Format:
projects/<ProjectID>/locations/<LocationID>/agents/<AgentID>/playbooks/<PlaybookID>.
#playbook=
def playbook=(value) -> ::String
Parameter
-
value (::String) — Required. The unique identifier of the playbook.
Format:
projects/<ProjectID>/locations/<LocationID>/agents/<AgentID>/playbooks/<PlaybookID>.
Returns
-
(::String) — Required. The unique identifier of the playbook.
Format:
projects/<ProjectID>/locations/<LocationID>/agents/<AgentID>/playbooks/<PlaybookID>.
#playbook_input
def playbook_input() -> ::Google::Cloud::Dialogflow::CX::V3::PlaybookInput
Returns
- (::Google::Cloud::Dialogflow::CX::V3::PlaybookInput) — Optional. Input of the child playbook invocation.
#playbook_input=
def playbook_input=(value) -> ::Google::Cloud::Dialogflow::CX::V3::PlaybookInput
Parameter
- value (::Google::Cloud::Dialogflow::CX::V3::PlaybookInput) — Optional. Input of the child playbook invocation.
Returns
- (::Google::Cloud::Dialogflow::CX::V3::PlaybookInput) — Optional. Input of the child playbook invocation.
#playbook_output
def playbook_output() -> ::Google::Cloud::Dialogflow::CX::V3::PlaybookOutput
Returns
- (::Google::Cloud::Dialogflow::CX::V3::PlaybookOutput) — Optional. Output of the child playbook invocation.
#playbook_output=
def playbook_output=(value) -> ::Google::Cloud::Dialogflow::CX::V3::PlaybookOutput
Parameter
- value (::Google::Cloud::Dialogflow::CX::V3::PlaybookOutput) — Optional. Output of the child playbook invocation.
Returns
- (::Google::Cloud::Dialogflow::CX::V3::PlaybookOutput) — Optional. Output of the child playbook invocation.
#playbook_state
def playbook_state() -> ::Google::Cloud::Dialogflow::CX::V3::OutputState
Returns
- (::Google::Cloud::Dialogflow::CX::V3::OutputState) — Required. Playbook invocation's output state.
#playbook_state=
def playbook_state=(value) -> ::Google::Cloud::Dialogflow::CX::V3::OutputState
Parameter
- value (::Google::Cloud::Dialogflow::CX::V3::OutputState) — Required. Playbook invocation's output state.
Returns
- (::Google::Cloud::Dialogflow::CX::V3::OutputState) — Required. Playbook invocation's output state.