Dialogflow CX V3 API - Module Google::Cloud::Dialogflow::CX::V3::Playbooks::Paths (v1.11.0)

Reference documentation and code samples for the Dialogflow CX V3 API module Google::Cloud::Dialogflow::CX::V3::Playbooks::Paths.

Path helper methods for the Playbooks API.

Extended By

Included In

Methods

#agent_path

def agent_path(project:, location:, agent:) -> ::String

Create a fully-qualified Agent resource string.

The resource will be in the following format:

projects/{project}/locations/{location}/agents/{agent}

Parameters
  • project (String)
  • location (String)
  • agent (String)
Returns
  • (::String)
Raises
  • (::ArgumentError)

#example_path

def example_path(project:, location:, agent:, playbook:, example:) -> ::String

Create a fully-qualified Example resource string.

The resource will be in the following format:

projects/{project}/locations/{location}/agents/{agent}/playbooks/{playbook}/examples/{example}

Parameters
  • project (String)
  • location (String)
  • agent (String)
  • playbook (String)
  • example (String)
Returns
  • (::String)
Raises
  • (::ArgumentError)

#flow_path

def flow_path(project:, location:, agent:, flow:) -> ::String

Create a fully-qualified Flow resource string.

The resource will be in the following format:

projects/{project}/locations/{location}/agents/{agent}/flows/{flow}

Parameters
  • project (String)
  • location (String)
  • agent (String)
  • flow (String)
Returns
  • (::String)
Raises
  • (::ArgumentError)

#generator_path

def generator_path(project:, location:, agent:, generator:) -> ::String

Create a fully-qualified Generator resource string.

The resource will be in the following format:

projects/{project}/locations/{location}/agents/{agent}/generators/{generator}

Parameters
  • project (String)
  • location (String)
  • agent (String)
  • generator (String)
Returns
  • (::String)
Raises
  • (::ArgumentError)

#playbook_path

def playbook_path(project:, location:, agent:, playbook:) -> ::String

Create a fully-qualified Playbook resource string.

The resource will be in the following format:

projects/{project}/locations/{location}/agents/{agent}/playbooks/{playbook}

Parameters
  • project (String)
  • location (String)
  • agent (String)
  • playbook (String)
Returns
  • (::String)
Raises
  • (::ArgumentError)

#playbook_version_path

def playbook_version_path(project:, location:, agent:, playbook:, version:) -> ::String

Create a fully-qualified PlaybookVersion resource string.

The resource will be in the following format:

projects/{project}/locations/{location}/agents/{agent}/playbooks/{playbook}/versions/{version}

Parameters
  • project (String)
  • location (String)
  • agent (String)
  • playbook (String)
  • version (String)
Returns
  • (::String)
Raises
  • (::ArgumentError)

#tool_path

def tool_path(project:, location:, agent:, tool:) -> ::String

Create a fully-qualified Tool resource string.

The resource will be in the following format:

projects/{project}/locations/{location}/agents/{agent}/tools/{tool}

Parameters
  • project (String)
  • location (String)
  • agent (String)
  • tool (String)
Returns
  • (::String)
Raises
  • (::ArgumentError)

#webhook_path

def webhook_path(project:, location:, agent:, webhook:) -> ::String

Create a fully-qualified Webhook resource string.

The resource will be in the following format:

projects/{project}/locations/{location}/agents/{agent}/webhooks/{webhook}

Parameters
  • project (String)
  • location (String)
  • agent (String)
  • webhook (String)
Returns
  • (::String)
Raises
  • (::ArgumentError)