Module: Google::Cloud::Bigtable::Admin::V2::BigtableInstanceAdmin::Paths

Extended by:
Paths
Included in:
Client, Paths
Defined in:
lib/google/cloud/bigtable/admin/v2/bigtable_instance_admin/paths.rb

Overview

Path helper methods for the BigtableInstanceAdmin API.

Instance Method Summary collapse

Instance Method Details

#app_profile_path(project:, instance:, app_profile:) ⇒ ::String

Create a fully-qualified AppProfile resource string.

The resource will be in the following format:

projects/{project}/instances/{instance}/appProfiles/{app_profile}

Parameters:

  • project (String)
  • instance (String)
  • app_profile (String)

Returns:

  • (::String)

Raises:

  • (::ArgumentError) 


40
41
42
43
44
45
 
# File 'lib/google/cloud/bigtable/admin/v2/bigtable_instance_admin/paths.rb', line 40

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

  "projects/#{project}/instances/#{instance}/appProfiles/#{app_profile}"
end

#cluster_path(project:, instance:, cluster:) ⇒ ::String

Create a fully-qualified Cluster resource string.

The resource will be in the following format:

projects/{project}/instances/{instance}/clusters/{cluster}

Parameters:

  • project (String)
  • instance (String)
  • cluster (String)

Returns:

  • (::String)

Raises:

  • (::ArgumentError) 


59
60
61
62
63
64
 
# File 'lib/google/cloud/bigtable/admin/v2/bigtable_instance_admin/paths.rb', line 59

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

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


79
80
81
82
83
84
85
 
# File 'lib/google/cloud/bigtable/admin/v2/bigtable_instance_admin/paths.rb', line 79

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

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

Create a fully-qualified Instance resource string.

The resource will be in the following format:

projects/{project}/instances/{instance}

Parameters:

  • project (String)
  • instance (String)

Returns:

  • (::String)

Raises:

  • (::ArgumentError) 


98
99
100
101
102
 
# File 'lib/google/cloud/bigtable/admin/v2/bigtable_instance_admin/paths.rb', line 98

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

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


115
116
117
118
119
 
# File 'lib/google/cloud/bigtable/admin/v2/bigtable_instance_admin/paths.rb', line 115

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

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

#project_path(project:) ⇒ ::String

Create a fully-qualified Project resource string.

The resource will be in the following format:

projects/{project}

Parameters:

  • project (String)

Returns:

  • (::String) 


131
132
133
 
# File 'lib/google/cloud/bigtable/admin/v2/bigtable_instance_admin/paths.rb', line 131

def project_path project:
  "projects/#{project}"
end