Module: Google::Cloud::Dataform::V1beta1::Dataform::Paths

Extended by:
Paths
Included in:
Client, Paths, Rest::Client
Defined in:
lib/google/cloud/dataform/v1beta1/dataform/paths.rb

Overview

Path helper methods for the Dataform API.

Instance Method Summary collapse

Instance Method Details

#compilation_result_path(project:, location:, repository:, compilation_result:) ⇒ ::String

Create a fully-qualified CompilationResult resource string.

The resource will be in the following format:

projects/{project}/locations/{location}/repositories/{repository}/compilationResults/{compilation_result}

Parameters:

  • project (String)
  • location (String)
  • repository (String)
  • compilation_result (String)

Returns:

  • (::String)

Raises:

  • (::ArgumentError) 


40
41
42
43
44
45
46
 
# File 'lib/google/cloud/dataform/v1beta1/dataform/paths.rb', line 40

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

  "projects/#{project}/locations/#{location}/repositories/#{repository}/compilationResults/#{compilation_result}"
end

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

Create a fully-qualified Config resource string.

The resource will be in the following format:

projects/{project}/locations/{location}/config

Parameters:

  • project (String)
  • location (String)

Returns:

  • (::String)

Raises:

  • (::ArgumentError) 


59
60
61
62
63
 
# File 'lib/google/cloud/dataform/v1beta1/dataform/paths.rb', line 59

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

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

#crypto_key_path(project:, location:, key_ring:, crypto_key:) ⇒ ::String

Create a fully-qualified CryptoKey resource string.

The resource will be in the following format:

projects/{project}/locations/{location}/keyRings/{key_ring}/cryptoKeys/{crypto_key}

Parameters:

  • project (String)
  • location (String)
  • key_ring (String)
  • crypto_key (String)

Returns:

  • (::String)

Raises:

  • (::ArgumentError) 


78
79
80
81
82
83
84
 
# File 'lib/google/cloud/dataform/v1beta1/dataform/paths.rb', line 78

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

  "projects/#{project}/locations/#{location}/keyRings/#{key_ring}/cryptoKeys/#{crypto_key}"
end

#crypto_key_version_path(project:, location:, key_ring:, crypto_key:, crypto_key_version:) ⇒ ::String

Create a fully-qualified CryptoKeyVersion resource string.

The resource will be in the following format:

projects/{project}/locations/{location}/keyRings/{key_ring}/cryptoKeys/{crypto_key}/cryptoKeyVersions/{crypto_key_version}

Parameters:

  • project (String)
  • location (String)
  • key_ring (String)
  • crypto_key (String)
  • crypto_key_version (String)

Returns:

  • (::String)

Raises:

  • (::ArgumentError) 


100
101
102
103
104
105
106
107
 
# File 'lib/google/cloud/dataform/v1beta1/dataform/paths.rb', line 100

def crypto_key_version_path project:, location:, key_ring:, crypto_key:, crypto_key_version:
  raise ::ArgumentError, "project cannot contain /" if project.to_s.include? "/"
  raise ::ArgumentError, "location cannot contain /" if location.to_s.include? "/"
  raise ::ArgumentError, "key_ring cannot contain /" if key_ring.to_s.include? "/"
  raise ::ArgumentError, "crypto_key cannot contain /" if crypto_key.to_s.include? "/"

  "projects/#{project}/locations/#{location}/keyRings/#{key_ring}/cryptoKeys/#{crypto_key}/cryptoKeyVersions/#{crypto_key_version}"
end

#folder_path(project:, location:, folder:) ⇒ ::String

Create a fully-qualified Folder resource string.

The resource will be in the following format:

projects/{project}/locations/{location}/folders/{folder}

Parameters:

  • project (String)
  • location (String)
  • folder (String)

Returns:

  • (::String)

Raises:

  • (::ArgumentError) 


121
122
123
124
125
126
 
# File 'lib/google/cloud/dataform/v1beta1/dataform/paths.rb', line 121

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

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

#git_repository_link_path(project:, location:, connection:, git_repository_link:) ⇒ ::String

Create a fully-qualified GitRepositoryLink resource string.

The resource will be in the following format:

projects/{project}/locations/{location}/connections/{connection}/gitRepositoryLinks/{git_repository_link}

Parameters:

  • project (String)
  • location (String)
  • connection (String)
  • git_repository_link (String)

Returns:

  • (::String)

Raises:

  • (::ArgumentError) 


141
142
143
144
145
146
147
 
# File 'lib/google/cloud/dataform/v1beta1/dataform/paths.rb', line 141

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

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


160
161
162
163
164
 
# File 'lib/google/cloud/dataform/v1beta1/dataform/paths.rb', line 160

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

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


178
179
180
181
182
183
 
# File 'lib/google/cloud/dataform/v1beta1/dataform/paths.rb', line 178

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

#release_config_path(project:, location:, repository:, release_config:) ⇒ ::String

Create a fully-qualified ReleaseConfig resource string.

The resource will be in the following format:

projects/{project}/locations/{location}/repositories/{repository}/releaseConfigs/{release_config}

Parameters:

  • project (String)
  • location (String)
  • repository (String)
  • release_config (String)

Returns:

  • (::String)

Raises:

  • (::ArgumentError) 


198
199
200
201
202
203
204
 
# File 'lib/google/cloud/dataform/v1beta1/dataform/paths.rb', line 198

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

  "projects/#{project}/locations/#{location}/repositories/#{repository}/releaseConfigs/#{release_config}"
end

#repository_path(project:, location:, repository:) ⇒ ::String

Create a fully-qualified Repository resource string.

The resource will be in the following format:

projects/{project}/locations/{location}/repositories/{repository}

Parameters:

  • project (String)
  • location (String)
  • repository (String)

Returns:

  • (::String)

Raises:

  • (::ArgumentError) 


218
219
220
221
222
223
 
# File 'lib/google/cloud/dataform/v1beta1/dataform/paths.rb', line 218

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

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


237
238
239
240
241
242
 
# File 'lib/google/cloud/dataform/v1beta1/dataform/paths.rb', line 237

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

#team_folder_path(project:, location:, team_folder:) ⇒ ::String

Create a fully-qualified TeamFolder resource string.

The resource will be in the following format:

projects/{project}/locations/{location}/teamFolders/{team_folder}

Parameters:

  • project (String)
  • location (String)
  • team_folder (String)

Returns:

  • (::String)

Raises:

  • (::ArgumentError) 


256
257
258
259
260
261
 
# File 'lib/google/cloud/dataform/v1beta1/dataform/paths.rb', line 256

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

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

#workflow_config_path(project:, location:, repository:, workflow_config:) ⇒ ::String

Create a fully-qualified WorkflowConfig resource string.

The resource will be in the following format:

projects/{project}/locations/{location}/repositories/{repository}/workflowConfigs/{workflow_config}

Parameters:

  • project (String)
  • location (String)
  • repository (String)
  • workflow_config (String)

Returns:

  • (::String)

Raises:

  • (::ArgumentError) 


276
277
278
279
280
281
282
 
# File 'lib/google/cloud/dataform/v1beta1/dataform/paths.rb', line 276

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

  "projects/#{project}/locations/#{location}/repositories/#{repository}/workflowConfigs/#{workflow_config}"
end

#workflow_invocation_path(project:, location:, repository:, workflow_invocation:) ⇒ ::String

Create a fully-qualified WorkflowInvocation resource string.

The resource will be in the following format:

projects/{project}/locations/{location}/repositories/{repository}/workflowInvocations/{workflow_invocation}

Parameters:

  • project (String)
  • location (String)
  • repository (String)
  • workflow_invocation (String)

Returns:

  • (::String)

Raises:

  • (::ArgumentError) 


297
298
299
300
301
302
303
 
# File 'lib/google/cloud/dataform/v1beta1/dataform/paths.rb', line 297

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

  "projects/#{project}/locations/#{location}/repositories/#{repository}/workflowInvocations/#{workflow_invocation}"
end

#workspace_path(project:, location:, repository:, workspace:) ⇒ ::String

Create a fully-qualified Workspace resource string.

The resource will be in the following format:

projects/{project}/locations/{location}/repositories/{repository}/workspaces/{workspace}

Parameters:

  • project (String)
  • location (String)
  • repository (String)
  • workspace (String)

Returns:

  • (::String)

Raises:

  • (::ArgumentError) 


318
319
320
321
322
323
324
 
# File 'lib/google/cloud/dataform/v1beta1/dataform/paths.rb', line 318

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

  "projects/#{project}/locations/#{location}/repositories/#{repository}/workspaces/#{workspace}"
end