Module: Google::Cloud::Redis::Cluster::V1beta1::CloudRedisCluster::Paths

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

Overview

Path helper methods for the CloudRedisCluster API.

Instance Method Summary collapse

Instance Method Details

#backup_collection_path(project:, location:, backup_collection:) ⇒ ::String

Create a fully-qualified BackupCollection resource string.

The resource will be in the following format:

projects/{project}/locations/{location}/backupCollections/{backup_collection}

Parameters:

  • project (String)
  • location (String)
  • backup_collection (String)

Returns:

  • (::String)

Raises:

  • (::ArgumentError) 


61
62
63
64
65
66
 
# File 'lib/google/cloud/redis/cluster/v1beta1/cloud_redis_cluster/paths.rb', line 61

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

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

#backup_path(project:, location:, backup_collection:, backup:) ⇒ ::String

Create a fully-qualified Backup resource string.

The resource will be in the following format:

projects/{project}/locations/{location}/backupCollections/{backup_collection}/backups/{backup}

Parameters:

  • project (String)
  • location (String)
  • backup_collection (String)
  • backup (String)

Returns:

  • (::String)

Raises:

  • (::ArgumentError) 


41
42
43
44
45
46
47
 
# File 'lib/google/cloud/redis/cluster/v1beta1/cloud_redis_cluster/paths.rb', line 41

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

  "projects/#{project}/locations/#{location}/backupCollections/#{backup_collection}/backups/#{backup}"
end

#certificate_authority_path(project:, location:, cluster:) ⇒ ::String

Create a fully-qualified CertificateAuthority resource string.

The resource will be in the following format:

projects/{project}/locations/{location}/clusters/{cluster}/certificateAuthority

Parameters:

  • project (String)
  • location (String)
  • cluster (String)

Returns:

  • (::String)

Raises:

  • (::ArgumentError) 


80
81
82
83
84
85
 
# File 'lib/google/cloud/redis/cluster/v1beta1/cloud_redis_cluster/paths.rb', line 80

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

  "projects/#{project}/locations/#{location}/clusters/#{cluster}/certificateAuthority"
end

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

Create a fully-qualified Cluster resource string.

The resource will be in the following format:

projects/{project}/locations/{location}/clusters/{cluster}

Parameters:

  • project (String)
  • location (String)
  • cluster (String)

Returns:

  • (::String)

Raises:

  • (::ArgumentError) 


99
100
101
102
103
104
 
# File 'lib/google/cloud/redis/cluster/v1beta1/cloud_redis_cluster/paths.rb', line 99

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

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


119
120
121
122
123
124
125
 
# File 'lib/google/cloud/redis/cluster/v1beta1/cloud_redis_cluster/paths.rb', line 119

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) 


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

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

#forwarding_rule_path(project:, region:, forwarding_rule:) ⇒ ::String

Create a fully-qualified ForwardingRule resource string.

The resource will be in the following format:

projects/{project}/regions/{region}/forwardingRules/{forwarding_rule}

Parameters:

  • project (String)
  • region (String)
  • forwarding_rule (String)

Returns:

  • (::String)

Raises:

  • (::ArgumentError) 


162
163
164
165
166
167
 
# File 'lib/google/cloud/redis/cluster/v1beta1/cloud_redis_cluster/paths.rb', line 162

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

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


180
181
182
183
184
 
# File 'lib/google/cloud/redis/cluster/v1beta1/cloud_redis_cluster/paths.rb', line 180

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) 


197
198
199
200
201
 
# File 'lib/google/cloud/redis/cluster/v1beta1/cloud_redis_cluster/paths.rb', line 197

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

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

#service_attachment_path(project:, region:, service_attachment:) ⇒ ::String

Create a fully-qualified ServiceAttachment resource string.

The resource will be in the following format:

projects/{project}/regions/{region}/serviceAttachments/{service_attachment}

Parameters:

  • project (String)
  • region (String)
  • service_attachment (String)

Returns:

  • (::String)

Raises:

  • (::ArgumentError) 


215
216
217
218
219
220
 
# File 'lib/google/cloud/redis/cluster/v1beta1/cloud_redis_cluster/paths.rb', line 215

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

  "projects/#{project}/regions/#{region}/serviceAttachments/#{service_attachment}"
end