Module: Google::Cloud::Dialogflow::CX::V3::Playbooks::Paths

Extended by:
Paths
Included in:
Client, Paths, Rest::Client
Defined in:
lib/google/cloud/dialogflow/cx/v3/playbooks/paths.rb

Overview

Path helper methods for the Playbooks API.

Instance Method Summary collapse

Instance Method Details

#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) 


40
41
42
43
44
45
 
# File 'lib/google/cloud/dialogflow/cx/v3/playbooks/paths.rb', line 40

def agent_path project:, location:, agent:
  raise ::ArgumentError, "project cannot contain /" if project.to_s.include? "/"
  raise ::ArgumentError, "location cannot contain /" if location.to_s.include? "/"

  "projects/#{project}/locations/#{location}/agents/#{agent}"
end

#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) 


61
62
63
64
65
66
67
68
 
# File 'lib/google/cloud/dialogflow/cx/v3/playbooks/paths.rb', line 61

def example_path project:, location:, agent:, playbook:, example:
  raise ::ArgumentError, "project cannot contain /" if project.to_s.include? "/"
  raise ::ArgumentError, "location cannot contain /" if location.to_s.include? "/"
  raise ::ArgumentError, "agent cannot contain /" if agent.to_s.include? "/"
  raise ::ArgumentError, "playbook cannot contain /" if playbook.to_s.include? "/"

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

#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) 


83
84
85
86
87
88
89
 
# File 'lib/google/cloud/dialogflow/cx/v3/playbooks/paths.rb', line 83

def flow_path project:, location:, agent:, flow:
  raise ::ArgumentError, "project cannot contain /" if project.to_s.include? "/"
  raise ::ArgumentError, "location cannot contain /" if location.to_s.include? "/"
  raise ::ArgumentError, "agent cannot contain /" if agent.to_s.include? "/"

  "projects/#{project}/locations/#{location}/agents/#{agent}/flows/#{flow}"
end

#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) 


104
105
106
107
108
109
110
 
# File 'lib/google/cloud/dialogflow/cx/v3/playbooks/paths.rb', line 104

def generator_path project:, location:, agent:, generator:
  raise ::ArgumentError, "project cannot contain /" if project.to_s.include? "/"
  raise ::ArgumentError, "location cannot contain /" if location.to_s.include? "/"
  raise ::ArgumentError, "agent cannot contain /" if agent.to_s.include? "/"

  "projects/#{project}/locations/#{location}/agents/#{agent}/generators/#{generator}"
end

#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) 


125
126
127
128
129
130
131
 
# File 'lib/google/cloud/dialogflow/cx/v3/playbooks/paths.rb', line 125

def playbook_path project:, location:, agent:, playbook:
  raise ::ArgumentError, "project cannot contain /" if project.to_s.include? "/"
  raise ::ArgumentError, "location cannot contain /" if location.to_s.include? "/"
  raise ::ArgumentError, "agent cannot contain /" if agent.to_s.include? "/"

  "projects/#{project}/locations/#{location}/agents/#{agent}/playbooks/#{playbook}"
end

#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) 


147
148
149
150
151
152
153
154
 
# File 'lib/google/cloud/dialogflow/cx/v3/playbooks/paths.rb', line 147

def playbook_version_path project:, location:, agent:, playbook:, version:
  raise ::ArgumentError, "project cannot contain /" if project.to_s.include? "/"
  raise ::ArgumentError, "location cannot contain /" if location.to_s.include? "/"
  raise ::ArgumentError, "agent cannot contain /" if agent.to_s.include? "/"
  raise ::ArgumentError, "playbook cannot contain /" if playbook.to_s.include? "/"

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

#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) 


169
170
171
172
173
174
175
 
# File 'lib/google/cloud/dialogflow/cx/v3/playbooks/paths.rb', line 169

def tool_path project:, location:, agent:, tool:
  raise ::ArgumentError, "project cannot contain /" if project.to_s.include? "/"
  raise ::ArgumentError, "location cannot contain /" if location.to_s.include? "/"
  raise ::ArgumentError, "agent cannot contain /" if agent.to_s.include? "/"

  "projects/#{project}/locations/#{location}/agents/#{agent}/tools/#{tool}"
end

#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) 


190
191
192
193
194
195
196
 
# File 'lib/google/cloud/dialogflow/cx/v3/playbooks/paths.rb', line 190

def webhook_path project:, location:, agent:, webhook:
  raise ::ArgumentError, "project cannot contain /" if project.to_s.include? "/"
  raise ::ArgumentError, "location cannot contain /" if location.to_s.include? "/"
  raise ::ArgumentError, "agent cannot contain /" if agent.to_s.include? "/"

  "projects/#{project}/locations/#{location}/agents/#{agent}/webhooks/#{webhook}"
end