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

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

Overview

Path helper methods for the Experiments API.

Instance Method Summary collapse

Instance Method Details

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


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

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

#experiment_path(project:, location:, agent:, environment:, experiment:) ⇒ ::String

Create a fully-qualified Experiment resource string.

The resource will be in the following format:

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

Parameters:

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

Returns:

  • (::String)

Raises:

  • (::ArgumentError) 


63
64
65
66
67
68
69
70
 
# File 'lib/google/cloud/dialogflow/cx/v3/experiments/paths.rb', line 63

def experiment_path project:, location:, agent:, environment:, experiment:
  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, "environment cannot contain /" if environment.to_s.include? "/"

  "projects/#{project}/locations/#{location}/agents/#{agent}/environments/#{environment}/experiments/#{experiment}"
end

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


86
87
88
89
90
91
92
93
 
# File 'lib/google/cloud/dialogflow/cx/v3/experiments/paths.rb', line 86

def version_path project:, location:, agent:, flow:, 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, "flow cannot contain /" if flow.to_s.include? "/"

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