Module: Google::Cloud::Dataplex::V1::DataScanService::Paths

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

Overview

Path helper methods for the DataScanService API.

Instance Method Summary collapse

Instance Method Details

#connection_path(project:, location:, connection:) ⇒ ::String

Create a fully-qualified Connection resource string.

The resource will be in the following format:

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

Parameters:

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

Returns:

  • (::String)

Raises:

  • (::ArgumentError) 


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

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

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

#data_scan_job_path(project:, location:, data_scan:, job:) ⇒ ::String

Create a fully-qualified DataScanJob resource string.

The resource will be in the following format:

projects/{project}/locations/{location}/dataScans/{data_scan}/jobs/{job}

Parameters:

  • project (String)
  • location (String)
  • data_scan (String)
  • job (String)

Returns:

  • (::String)

Raises:

  • (::ArgumentError) 


78
79
80
81
82
83
84
 
# File 'lib/google/cloud/dataplex/v1/data_scan_service/paths.rb', line 78

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

  "projects/#{project}/locations/#{location}/dataScans/#{data_scan}/jobs/#{job}"
end

#data_scan_path(project:, location:, data_scan:) ⇒ ::String

Create a fully-qualified DataScan resource string.

The resource will be in the following format:

projects/{project}/locations/{location}/dataScans/{data_scan}

Parameters:

  • project (String)
  • location (String)
  • data_scan (String)

Returns:

  • (::String)

Raises:

  • (::ArgumentError) 


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

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

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

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

Create a fully-qualified Dataset resource string.

The resource will be in the following format:

projects/{project}/datasets/{dataset}

Parameters:

  • project (String)
  • dataset (String)

Returns:

  • (::String)

Raises:

  • (::ArgumentError) 


97
98
99
100
101
 
# File 'lib/google/cloud/dataplex/v1/data_scan_service/paths.rb', line 97

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

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

#entity_path(project:, location:, lake:, zone:, entity:) ⇒ ::String

Create a fully-qualified Entity resource string.

The resource will be in the following format:

projects/{project}/locations/{location}/lakes/{lake}/zones/{zone}/entities/{entity}

Parameters:

  • project (String)
  • location (String)
  • lake (String)
  • zone (String)
  • entity (String)

Returns:

  • (::String)

Raises:

  • (::ArgumentError) 


117
118
119
120
121
122
123
124
 
# File 'lib/google/cloud/dataplex/v1/data_scan_service/paths.rb', line 117

def entity_path project:, location:, lake:, zone:, entity:
  raise ::ArgumentError, "project cannot contain /" if project.to_s.include? "/"
  raise ::ArgumentError, "location cannot contain /" if location.to_s.include? "/"
  raise ::ArgumentError, "lake cannot contain /" if lake.to_s.include? "/"
  raise ::ArgumentError, "zone cannot contain /" if zone.to_s.include? "/"

  "projects/#{project}/locations/#{location}/lakes/#{lake}/zones/#{zone}/entities/#{entity}"
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) 


137
138
139
140
141
 
# File 'lib/google/cloud/dataplex/v1/data_scan_service/paths.rb', line 137

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

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