Module: Google::Cloud::AIPlatform::V1::NotebookService::Paths

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

Overview

Path helper methods for the NotebookService API.

Instance Method Summary collapse

Instance Method Details

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


38
39
40
41
42
 
# File 'lib/google/cloud/ai_platform/v1/notebook_service/paths.rb', line 38

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

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


55
56
57
58
59
 
# File 'lib/google/cloud/ai_platform/v1/notebook_service/paths.rb', line 55

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

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

#notebook_execution_job_path(project:, location:, notebook_execution_job:) ⇒ ::String

Create a fully-qualified NotebookExecutionJob resource string.

The resource will be in the following format:

projects/{project}/locations/{location}/notebookExecutionJobs/{notebook_execution_job}

Parameters:

  • project (String)
  • location (String)
  • notebook_execution_job (String)

Returns:

  • (::String)

Raises:

  • (::ArgumentError) 


73
74
75
76
77
78
 
# File 'lib/google/cloud/ai_platform/v1/notebook_service/paths.rb', line 73

def notebook_execution_job_path project:, location:, notebook_execution_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}/notebookExecutionJobs/#{notebook_execution_job}"
end

#notebook_runtime_path(project:, location:, notebook_runtime:) ⇒ ::String

Create a fully-qualified NotebookRuntime resource string.

The resource will be in the following format:

projects/{project}/locations/{location}/notebookRuntimes/{notebook_runtime}

Parameters:

  • project (String)
  • location (String)
  • notebook_runtime (String)

Returns:

  • (::String)

Raises:

  • (::ArgumentError) 


92
93
94
95
96
97
 
# File 'lib/google/cloud/ai_platform/v1/notebook_service/paths.rb', line 92

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

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

#notebook_runtime_template_path(project:, location:, notebook_runtime_template:) ⇒ ::String

Create a fully-qualified NotebookRuntimeTemplate resource string.

The resource will be in the following format:

projects/{project}/locations/{location}/notebookRuntimeTemplates/{notebook_runtime_template}

Parameters:

  • project (String)
  • location (String)
  • notebook_runtime_template (String)

Returns:

  • (::String)

Raises:

  • (::ArgumentError) 


111
112
113
114
115
116
 
# File 'lib/google/cloud/ai_platform/v1/notebook_service/paths.rb', line 111

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

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

#reservation_path(project_id_or_number:, zone:, reservation_name:) ⇒ ::String

Create a fully-qualified Reservation resource string.

The resource will be in the following format:

projects/{project_id_or_number}/zones/{zone}/reservations/{reservation_name}

Parameters:

  • project_id_or_number (String)
  • zone (String)
  • reservation_name (String)

Returns:

  • (::String)

Raises:

  • (::ArgumentError) 


130
131
132
133
134
135
 
# File 'lib/google/cloud/ai_platform/v1/notebook_service/paths.rb', line 130

def reservation_path project_id_or_number:, zone:, reservation_name:
  raise ::ArgumentError, "project_id_or_number cannot contain /" if project_id_or_number.to_s.include? "/"
  raise ::ArgumentError, "zone cannot contain /" if zone.to_s.include? "/"

  "projects/#{project_id_or_number}/zones/#{zone}/reservations/#{reservation_name}"
end

#schedule_path(project:, location:, schedule:) ⇒ ::String

Create a fully-qualified Schedule resource string.

The resource will be in the following format:

projects/{project}/locations/{location}/schedules/{schedule}

Parameters:

  • project (String)
  • location (String)
  • schedule (String)

Returns:

  • (::String)

Raises:

  • (::ArgumentError) 


149
150
151
152
153
154
 
# File 'lib/google/cloud/ai_platform/v1/notebook_service/paths.rb', line 149

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

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

#subnetwork_path(project:, region:, subnetwork:) ⇒ ::String

Create a fully-qualified Subnetwork resource string.

The resource will be in the following format:

projects/{project}/regions/{region}/subnetworks/{subnetwork}

Parameters:

  • project (String)
  • region (String)
  • subnetwork (String)

Returns:

  • (::String)

Raises:

  • (::ArgumentError) 


168
169
170
171
172
173
 
# File 'lib/google/cloud/ai_platform/v1/notebook_service/paths.rb', line 168

def subnetwork_path project:, region:, subnetwork:
  raise ::ArgumentError, "project cannot contain /" if project.to_s.include? "/"
  raise ::ArgumentError, "region cannot contain /" if region.to_s.include? "/"

  "projects/#{project}/regions/#{region}/subnetworks/#{subnetwork}"
end