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

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

Overview

Path helper methods for the Agents API.

Instance Method Summary collapse

Instance Method Details

#agent_generative_settings_path(project:, location:, agent:) ⇒ ::String

Create a fully-qualified AgentGenerativeSettings resource string.

The resource will be in the following format:

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

Parameters:

  • project (String)
  • location (String)
  • agent (String)

Returns:

  • (::String)

Raises:

  • (::ArgumentError) 


59
60
61
62
63
64
 
# File 'lib/google/cloud/dialogflow/cx/v3/agents/paths.rb', line 59

def agent_generative_settings_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}/generativeSettings"
end

#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/agents/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

#agent_validation_result_path(project:, location:, agent:) ⇒ ::String

Create a fully-qualified AgentValidationResult resource string.

The resource will be in the following format:

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

Parameters:

  • project (String)
  • location (String)
  • agent (String)

Returns:

  • (::String)

Raises:

  • (::ArgumentError) 


78
79
80
81
82
83
 
# File 'lib/google/cloud/dialogflow/cx/v3/agents/paths.rb', line 78

def agent_validation_result_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}/validationResult"
end

#environment_path(project:, location:, agent:, environment:) ⇒ ::String

Create a fully-qualified Environment resource string.

The resource will be in the following format:

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

Parameters:

  • project (String)
  • location (String)
  • agent (String)
  • environment (String)

Returns:

  • (::String)

Raises:

  • (::ArgumentError) 


98
99
100
101
102
103
104
 
# File 'lib/google/cloud/dialogflow/cx/v3/agents/paths.rb', line 98

def environment_path project:, location:, agent:, environment:
  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}/environments/#{environment}"
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) 


119
120
121
122
123
124
125
 
# File 'lib/google/cloud/dialogflow/cx/v3/agents/paths.rb', line 119

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

#location_path(project:, location:) ⇒ ::String

Create a fully-qualified Location resource string.

The resource will be in the following format:

projects/{project}/locations/{location}

Parameters:

  • project (String)
  • location (String)

Returns:

  • (::String)

Raises:

  • (::ArgumentError) 


138
139
140
141
142
 
# File 'lib/google/cloud/dialogflow/cx/v3/agents/paths.rb', line 138

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

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

#secret_version_path(project:, secret:, version:) ⇒ ::String

Create a fully-qualified SecretVersion resource string.

The resource will be in the following format:

projects/{project}/secrets/{secret}/versions/{version}

Parameters:

  • project (String)
  • secret (String)
  • version (String)

Returns:

  • (::String)

Raises:

  • (::ArgumentError) 


156
157
158
159
160
161
 
# File 'lib/google/cloud/dialogflow/cx/v3/agents/paths.rb', line 156

def secret_version_path project:, secret:, version:
  raise ::ArgumentError, "project cannot contain /" if project.to_s.include? "/"
  raise ::ArgumentError, "secret cannot contain /" if secret.to_s.include? "/"

  "projects/#{project}/secrets/#{secret}/versions/#{version}"
end

#security_settings_path(project:, location:, security_settings:) ⇒ ::String

Create a fully-qualified SecuritySettings resource string.

The resource will be in the following format:

projects/{project}/locations/{location}/securitySettings/{security_settings}

Parameters:

  • project (String)
  • location (String)
  • security_settings (String)

Returns:

  • (::String)

Raises:

  • (::ArgumentError) 


175
176
177
178
179
180
 
# File 'lib/google/cloud/dialogflow/cx/v3/agents/paths.rb', line 175

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

  "projects/#{project}/locations/#{location}/securitySettings/#{security_settings}"
end