Dialogflow CX V3 API - Module Google::Cloud::Dialogflow::CX::V3::Sessions::Paths (v1.3.0)

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

Path helper methods for the Sessions API.

Extended By

Methods

#data_store_path

def data_store_path(project:, location:, data_store:) -> ::String
def data_store_path(project:, location:, collection:, data_store:) -> ::String

Create a fully-qualified DataStore resource string.

Overloads 
def data_store_path(project:, location:, data_store:) -> ::String
The resource will be in the following format:

projects/{project}/locations/{location}/dataStores/{data_store}

Parameters
  • project (String)
  • location (String)
  • data_store (String) 
def data_store_path(project:, location:, collection:, data_store:) -> ::String
The resource will be in the following format:

projects/{project}/locations/{location}/collections/{collection}/dataStores/{data_store}

Parameters
  • project (String)
  • location (String)
  • collection (String)
  • data_store (String)
Returns
  • (::String)
Raises
  • (::ArgumentError)

#entity_type_path

def entity_type_path(project:, location:, agent:, entity_type:) -> ::String

Create a fully-qualified EntityType resource string.

The resource will be in the following format:

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

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

#intent_path

def intent_path(project:, location:, agent:, intent:) -> ::String

Create a fully-qualified Intent resource string.

The resource will be in the following format:

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

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

#page_path

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

Create a fully-qualified Page resource string.

The resource will be in the following format:

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

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

#session_entity_type_path

def session_entity_type_path(project:, location:, agent:, session:, entity_type:) -> ::String
def session_entity_type_path(project:, location:, agent:, environment:, session:, entity_type:) -> ::String

Create a fully-qualified SessionEntityType resource string.

Overloads 
def session_entity_type_path(project:, location:, agent:, session:, entity_type:) -> ::String
The resource will be in the following format:

projects/{project}/locations/{location}/agents/{agent}/sessions/{session}/entityTypes/{entity_type}

Parameters
  • project (String)
  • location (String)
  • agent (String)
  • session (String)
  • entity_type (String) 
def session_entity_type_path(project:, location:, agent:, environment:, session:, entity_type:) -> ::String
The resource will be in the following format:

projects/{project}/locations/{location}/agents/{agent}/environments/{environment}/sessions/{session}/entityTypes/{entity_type}

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

#session_path

def session_path(project:, location:, agent:, session:) -> ::String
def session_path(project:, location:, agent:, environment:, session:) -> ::String

Create a fully-qualified Session resource string.

Overloads 
def session_path(project:, location:, agent:, session:) -> ::String
The resource will be in the following format:

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

Parameters
  • project (String)
  • location (String)
  • agent (String)
  • session (String) 
def session_path(project:, location:, agent:, environment:, session:) -> ::String
The resource will be in the following format:

projects/{project}/locations/{location}/agents/{agent}/environments/{environment}/sessions/{session}

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

#version_path

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

Create a fully-qualified Version resource string.

The resource will be in the following format:

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

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