Module: Google::Cloud::AIPlatform::V1::JobService::Paths

Extended by:
Paths
Included in:
Client, Paths
Defined in:
lib/google/cloud/ai_platform/v1/job_service/paths.rb

Overview

Path helper methods for the JobService API.

Instance Method Summary collapse

Instance Method Details

#batch_prediction_job_path(project:, location:, batch_prediction_job:) ⇒ ::String

Create a fully-qualified BatchPredictionJob resource string.

The resource will be in the following format:

projects/{project}/locations/{location}/batchPredictionJobs/{batch_prediction_job}

Parameters:

  • project (String)
  • location (String)
  • batch_prediction_job (String)

Returns:

  • (::String)

Raises:

  • (::ArgumentError) 


39
40
41
42
43
44
 
# File 'lib/google/cloud/ai_platform/v1/job_service/paths.rb', line 39

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

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

#custom_job_path(project:, location:, custom_job:) ⇒ ::String

Create a fully-qualified CustomJob resource string.

The resource will be in the following format:

projects/{project}/locations/{location}/customJobs/{custom_job}

Parameters:

  • project (String)
  • location (String)
  • custom_job (String)

Returns:

  • (::String)

Raises:

  • (::ArgumentError) 


58
59
60
61
62
63
 
# File 'lib/google/cloud/ai_platform/v1/job_service/paths.rb', line 58

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

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

#data_labeling_job_path(project:, location:, data_labeling_job:) ⇒ ::String

Create a fully-qualified DataLabelingJob resource string.

The resource will be in the following format:

projects/{project}/locations/{location}/dataLabelingJobs/{data_labeling_job}

Parameters:

  • project (String)
  • location (String)
  • data_labeling_job (String)

Returns:

  • (::String)

Raises:

  • (::ArgumentError) 


77
78
79
80
81
82
 
# File 'lib/google/cloud/ai_platform/v1/job_service/paths.rb', line 77

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

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

#dataset_path(project:, location:, dataset:) ⇒ ::String

Create a fully-qualified Dataset resource string.

The resource will be in the following format:

projects/{project}/locations/{location}/datasets/{dataset}

Parameters:

  • project (String)
  • location (String)
  • dataset (String)

Returns:

  • (::String)

Raises:

  • (::ArgumentError) 


96
97
98
99
100
101
 
# File 'lib/google/cloud/ai_platform/v1/job_service/paths.rb', line 96

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

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

#endpoint_path(project:, location:, endpoint:) ⇒ ::String

Create a fully-qualified Endpoint resource string.

The resource will be in the following format:

projects/{project}/locations/{location}/endpoints/{endpoint}

Parameters:

  • project (String)
  • location (String)
  • endpoint (String)

Returns:

  • (::String)

Raises:

  • (::ArgumentError) 


115
116
117
118
119
120
 
# File 'lib/google/cloud/ai_platform/v1/job_service/paths.rb', line 115

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

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

#hyperparameter_tuning_job_path(project:, location:, hyperparameter_tuning_job:) ⇒ ::String

Create a fully-qualified HyperparameterTuningJob resource string.

The resource will be in the following format:

projects/{project}/locations/{location}/hyperparameterTuningJobs/{hyperparameter_tuning_job}

Parameters:

  • project (String)
  • location (String)
  • hyperparameter_tuning_job (String)

Returns:

  • (::String)

Raises:

  • (::ArgumentError) 


134
135
136
137
138
139
 
# File 'lib/google/cloud/ai_platform/v1/job_service/paths.rb', line 134

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

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


152
153
154
155
156
 
# File 'lib/google/cloud/ai_platform/v1/job_service/paths.rb', line 152

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

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

#model_deployment_monitoring_job_path(project:, location:, model_deployment_monitoring_job:) ⇒ ::String

Create a fully-qualified ModelDeploymentMonitoringJob resource string.

The resource will be in the following format:

projects/{project}/locations/{location}/modelDeploymentMonitoringJobs/{model_deployment_monitoring_job}

Parameters:

  • project (String)
  • location (String)
  • model_deployment_monitoring_job (String)

Returns:

  • (::String)

Raises:

  • (::ArgumentError) 


189
190
191
192
193
194
 
# File 'lib/google/cloud/ai_platform/v1/job_service/paths.rb', line 189

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

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

#model_path(project:, location:, model:) ⇒ ::String

Create a fully-qualified Model resource string.

The resource will be in the following format:

projects/{project}/locations/{location}/models/{model}

Parameters:

  • project (String)
  • location (String)
  • model (String)

Returns:

  • (::String)

Raises:

  • (::ArgumentError) 


170
171
172
173
174
175
 
# File 'lib/google/cloud/ai_platform/v1/job_service/paths.rb', line 170

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

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

#network_path(project:, network:) ⇒ ::String

Create a fully-qualified Network resource string.

The resource will be in the following format:

projects/{project}/global/networks/{network}

Parameters:

  • project (String)
  • network (String)

Returns:

  • (::String)

Raises:

  • (::ArgumentError) 


207
208
209
210
211
 
# File 'lib/google/cloud/ai_platform/v1/job_service/paths.rb', line 207

def network_path project:, network:
  raise ::ArgumentError, "project cannot contain /" if project.to_s.include? "/"

  "projects/#{project}/global/networks/#{network}"
end

#tensorboard_path(project:, location:, tensorboard:) ⇒ ::String

Create a fully-qualified Tensorboard resource string.

The resource will be in the following format:

projects/{project}/locations/{location}/tensorboards/{tensorboard}

Parameters:

  • project (String)
  • location (String)
  • tensorboard (String)

Returns:

  • (::String)

Raises:

  • (::ArgumentError) 


225
226
227
228
229
230
 
# File 'lib/google/cloud/ai_platform/v1/job_service/paths.rb', line 225

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

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

#trial_path(project:, location:, study:, trial:) ⇒ ::String

Create a fully-qualified Trial resource string.

The resource will be in the following format:

projects/{project}/locations/{location}/studies/{study}/trials/{trial}

Parameters:

  • project (String)
  • location (String)
  • study (String)
  • trial (String)

Returns:

  • (::String)

Raises:

  • (::ArgumentError) 


245
246
247
248
249
250
251
 
# File 'lib/google/cloud/ai_platform/v1/job_service/paths.rb', line 245

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

  "projects/#{project}/locations/#{location}/studies/#{study}/trials/#{trial}"
end