Module: Google::Cloud::FinancialServices::V1::AML::Paths

Extended by:
Paths
Included in:
Client, Paths, Rest::Client
Defined in:
lib/google/cloud/financial_services/v1/aml/paths.rb

Overview

Path helper methods for the AML API.

Instance Method Summary collapse

Instance Method Details

#backtest_result_path(project_num:, location:, instance:, backtest_result:) ⇒ ::String

Create a fully-qualified BacktestResult resource string.

The resource will be in the following format:

projects/{project_num}/locations/{location}/instances/{instance}/backtestResults/{backtest_result}

Parameters:

  • project_num (String)
  • location (String)
  • instance (String)
  • backtest_result (String)

Returns:

  • (::String)

Raises:

  • (::ArgumentError) 


40
41
42
43
44
45
46
 
# File 'lib/google/cloud/financial_services/v1/aml/paths.rb', line 40

def backtest_result_path project_num:, location:, instance:, backtest_result:
  raise ::ArgumentError, "project_num cannot contain /" if project_num.to_s.include? "/"
  raise ::ArgumentError, "location cannot contain /" if location.to_s.include? "/"
  raise ::ArgumentError, "instance cannot contain /" if instance.to_s.include? "/"

  "projects/#{project_num}/locations/#{location}/instances/#{instance}/backtestResults/#{backtest_result}"
end

#dataset_path(project_num:, location:, instance:, dataset:) ⇒ ::String

Create a fully-qualified Dataset resource string.

The resource will be in the following format:

projects/{project_num}/locations/{location}/instances/{instance}/datasets/{dataset}

Parameters:

  • project_num (String)
  • location (String)
  • instance (String)
  • dataset (String)

Returns:

  • (::String)

Raises:

  • (::ArgumentError) 


61
62
63
64
65
66
67
 
# File 'lib/google/cloud/financial_services/v1/aml/paths.rb', line 61

def dataset_path project_num:, location:, instance:, dataset:
  raise ::ArgumentError, "project_num cannot contain /" if project_num.to_s.include? "/"
  raise ::ArgumentError, "location cannot contain /" if location.to_s.include? "/"
  raise ::ArgumentError, "instance cannot contain /" if instance.to_s.include? "/"

  "projects/#{project_num}/locations/#{location}/instances/#{instance}/datasets/#{dataset}"
end

#engine_config_path(project_num:, location:, instance:, engine_config:) ⇒ ::String

Create a fully-qualified EngineConfig resource string.

The resource will be in the following format:

projects/{project_num}/locations/{location}/instances/{instance}/engineConfigs/{engine_config}

Parameters:

  • project_num (String)
  • location (String)
  • instance (String)
  • engine_config (String)

Returns:

  • (::String)

Raises:

  • (::ArgumentError) 


82
83
84
85
86
87
88
 
# File 'lib/google/cloud/financial_services/v1/aml/paths.rb', line 82

def engine_config_path project_num:, location:, instance:, engine_config:
  raise ::ArgumentError, "project_num cannot contain /" if project_num.to_s.include? "/"
  raise ::ArgumentError, "location cannot contain /" if location.to_s.include? "/"
  raise ::ArgumentError, "instance cannot contain /" if instance.to_s.include? "/"

  "projects/#{project_num}/locations/#{location}/instances/#{instance}/engineConfigs/#{engine_config}"
end

#engine_version_path(project_num:, location:, instance:, engine_version:) ⇒ ::String

Create a fully-qualified EngineVersion resource string.

The resource will be in the following format:

projects/{project_num}/locations/{location}/instances/{instance}/engineVersions/{engine_version}

Parameters:

  • project_num (String)
  • location (String)
  • instance (String)
  • engine_version (String)

Returns:

  • (::String)

Raises:

  • (::ArgumentError) 


103
104
105
106
107
108
109
 
# File 'lib/google/cloud/financial_services/v1/aml/paths.rb', line 103

def engine_version_path project_num:, location:, instance:, engine_version:
  raise ::ArgumentError, "project_num cannot contain /" if project_num.to_s.include? "/"
  raise ::ArgumentError, "location cannot contain /" if location.to_s.include? "/"
  raise ::ArgumentError, "instance cannot contain /" if instance.to_s.include? "/"

  "projects/#{project_num}/locations/#{location}/instances/#{instance}/engineVersions/#{engine_version}"
end

#instance_path(project:, location:, instance:) ⇒ ::String

Create a fully-qualified Instance resource string.

The resource will be in the following format:

projects/{project}/locations/{location}/instances/{instance}

Parameters:

  • project (String)
  • location (String)
  • instance (String)

Returns:

  • (::String)

Raises:

  • (::ArgumentError) 


123
124
125
126
127
128
 
# File 'lib/google/cloud/financial_services/v1/aml/paths.rb', line 123

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

  "projects/#{project}/locations/#{location}/instances/#{instance}"
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) 


141
142
143
144
145
 
# File 'lib/google/cloud/financial_services/v1/aml/paths.rb', line 141

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

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

#model_path(project_num:, location:, instance:, model:) ⇒ ::String

Create a fully-qualified Model resource string.

The resource will be in the following format:

projects/{project_num}/locations/{location}/instances/{instance}/models/{model}

Parameters:

  • project_num (String)
  • location (String)
  • instance (String)
  • model (String)

Returns:

  • (::String)

Raises:

  • (::ArgumentError) 


160
161
162
163
164
165
166
 
# File 'lib/google/cloud/financial_services/v1/aml/paths.rb', line 160

def model_path project_num:, location:, instance:, model:
  raise ::ArgumentError, "project_num cannot contain /" if project_num.to_s.include? "/"
  raise ::ArgumentError, "location cannot contain /" if location.to_s.include? "/"
  raise ::ArgumentError, "instance cannot contain /" if instance.to_s.include? "/"

  "projects/#{project_num}/locations/#{location}/instances/#{instance}/models/#{model}"
end

#prediction_result_path(project_num:, location:, instance:, prediction_result:) ⇒ ::String

Create a fully-qualified PredictionResult resource string.

The resource will be in the following format:

projects/{project_num}/locations/{location}/instances/{instance}/predictionResults/{prediction_result}

Parameters:

  • project_num (String)
  • location (String)
  • instance (String)
  • prediction_result (String)

Returns:

  • (::String)

Raises:

  • (::ArgumentError) 


181
182
183
184
185
186
187
 
# File 'lib/google/cloud/financial_services/v1/aml/paths.rb', line 181

def prediction_result_path project_num:, location:, instance:, prediction_result:
  raise ::ArgumentError, "project_num cannot contain /" if project_num.to_s.include? "/"
  raise ::ArgumentError, "location cannot contain /" if location.to_s.include? "/"
  raise ::ArgumentError, "instance cannot contain /" if instance.to_s.include? "/"

  "projects/#{project_num}/locations/#{location}/instances/#{instance}/predictionResults/#{prediction_result}"
end