Module: Google::Cloud::VmwareEngine::V1::VmwareEngine::Paths

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

Overview

Path helper methods for the VmwareEngine API.

Instance Method Summary collapse

Instance Method Details

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

Create a fully-qualified Cluster resource string.

The resource will be in the following format:

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

Parameters:

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

Returns:

  • (::String)

Raises:

  • (::ArgumentError) 


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

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

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

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

Create a fully-qualified DnsBindPermission resource string.

The resource will be in the following format:

projects/{project}/locations/{location}/dnsBindPermission

Parameters:

  • project (String)
  • location (String)

Returns:

  • (::String)

Raises:

  • (::ArgumentError) 


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

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

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

#dns_forwarding_path(project:, location:, private_cloud:) ⇒ ::String

Create a fully-qualified DnsForwarding resource string.

The resource will be in the following format:

projects/{project}/locations/{location}/privateClouds/{private_cloud}/dnsForwarding

Parameters:

  • project (String)
  • location (String)
  • private_cloud (String)

Returns:

  • (::String)

Raises:

  • (::ArgumentError) 


77
78
79
80
81
82
 
# File 'lib/google/cloud/vmware_engine/v1/vmware_engine/paths.rb', line 77

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

  "projects/#{project}/locations/#{location}/privateClouds/#{private_cloud}/dnsForwarding"
end

#external_access_rule_path(project:, location:, network_policy:, external_access_rule:) ⇒ ::String

Create a fully-qualified ExternalAccessRule resource string.

The resource will be in the following format:

projects/{project}/locations/{location}/networkPolicies/{network_policy}/externalAccessRules/{external_access_rule}

Parameters:

  • project (String)
  • location (String)
  • network_policy (String)
  • external_access_rule (String)

Returns:

  • (::String)

Raises:

  • (::ArgumentError) 


97
98
99
100
101
102
103
 
# File 'lib/google/cloud/vmware_engine/v1/vmware_engine/paths.rb', line 97

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

  "projects/#{project}/locations/#{location}/networkPolicies/#{network_policy}/externalAccessRules/#{external_access_rule}"
end

#external_address_path(project:, location:, private_cloud:, external_address:) ⇒ ::String

Create a fully-qualified ExternalAddress resource string.

The resource will be in the following format:

projects/{project}/locations/{location}/privateClouds/{private_cloud}/externalAddresses/{external_address}

Parameters:

  • project (String)
  • location (String)
  • private_cloud (String)
  • external_address (String)

Returns:

  • (::String)

Raises:

  • (::ArgumentError) 


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

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

  "projects/#{project}/locations/#{location}/privateClouds/#{private_cloud}/externalAddresses/#{external_address}"
end

#hcx_activation_key_path(project:, location:, private_cloud:, hcx_activation_key:) ⇒ ::String

Create a fully-qualified HcxActivationKey resource string.

The resource will be in the following format:

projects/{project}/locations/{location}/privateClouds/{private_cloud}/hcxActivationKeys/{hcx_activation_key}

Parameters:

  • project (String)
  • location (String)
  • private_cloud (String)
  • hcx_activation_key (String)

Returns:

  • (::String)

Raises:

  • (::ArgumentError) 


139
140
141
142
143
144
145
 
# File 'lib/google/cloud/vmware_engine/v1/vmware_engine/paths.rb', line 139

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

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


158
159
160
161
162
 
# File 'lib/google/cloud/vmware_engine/v1/vmware_engine/paths.rb', line 158

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

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

#logging_server_path(project:, location:, private_cloud:, logging_server:) ⇒ ::String

Create a fully-qualified LoggingServer resource string.

The resource will be in the following format:

projects/{project}/locations/{location}/privateClouds/{private_cloud}/loggingServers/{logging_server}

Parameters:

  • project (String)
  • location (String)
  • private_cloud (String)
  • logging_server (String)

Returns:

  • (::String)

Raises:

  • (::ArgumentError) 


177
178
179
180
181
182
183
 
# File 'lib/google/cloud/vmware_engine/v1/vmware_engine/paths.rb', line 177

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

  "projects/#{project}/locations/#{location}/privateClouds/#{private_cloud}/loggingServers/#{logging_server}"
end

#management_dns_zone_binding_path(project:, location:, private_cloud:, management_dns_zone_binding:) ⇒ ::String

Create a fully-qualified ManagementDnsZoneBinding resource string.

The resource will be in the following format:

projects/{project}/locations/{location}/privateClouds/{private_cloud}/managementDnsZoneBindings/{management_dns_zone_binding}

Parameters:

  • project (String)
  • location (String)
  • private_cloud (String)
  • management_dns_zone_binding (String)

Returns:

  • (::String)

Raises:

  • (::ArgumentError) 


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

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

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


217
218
219
220
221
 
# File 'lib/google/cloud/vmware_engine/v1/vmware_engine/paths.rb', line 217

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

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

#network_peering_path(project:, location:, network_peering:) ⇒ ::String

Create a fully-qualified NetworkPeering resource string.

The resource will be in the following format:

projects/{project}/locations/{location}/networkPeerings/{network_peering}

Parameters:

  • project (String)
  • location (String)
  • network_peering (String)

Returns:

  • (::String)

Raises:

  • (::ArgumentError) 


235
236
237
238
239
240
 
# File 'lib/google/cloud/vmware_engine/v1/vmware_engine/paths.rb', line 235

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

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

#network_policy_path(project:, location:, network_policy:) ⇒ ::String

Create a fully-qualified NetworkPolicy resource string.

The resource will be in the following format:

projects/{project}/locations/{location}/networkPolicies/{network_policy}

Parameters:

  • project (String)
  • location (String)
  • network_policy (String)

Returns:

  • (::String)

Raises:

  • (::ArgumentError) 


254
255
256
257
258
259
 
# File 'lib/google/cloud/vmware_engine/v1/vmware_engine/paths.rb', line 254

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

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

#node_path(project:, location:, private_cloud:, cluster:, node:) ⇒ ::String

Create a fully-qualified Node resource string.

The resource will be in the following format:

projects/{project}/locations/{location}/privateClouds/{private_cloud}/clusters/{cluster}/nodes/{node}

Parameters:

  • project (String)
  • location (String)
  • private_cloud (String)
  • cluster (String)
  • node (String)

Returns:

  • (::String)

Raises:

  • (::ArgumentError) 


275
276
277
278
279
280
281
282
 
# File 'lib/google/cloud/vmware_engine/v1/vmware_engine/paths.rb', line 275

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

  "projects/#{project}/locations/#{location}/privateClouds/#{private_cloud}/clusters/#{cluster}/nodes/#{node}"
end

#node_type_path(project:, location:, node_type:) ⇒ ::String

Create a fully-qualified NodeType resource string.

The resource will be in the following format:

projects/{project}/locations/{location}/nodeTypes/{node_type}

Parameters:

  • project (String)
  • location (String)
  • node_type (String)

Returns:

  • (::String)

Raises:

  • (::ArgumentError) 


296
297
298
299
300
301
 
# File 'lib/google/cloud/vmware_engine/v1/vmware_engine/paths.rb', line 296

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

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

#private_cloud_path(project:, location:, private_cloud:) ⇒ ::String

Create a fully-qualified PrivateCloud resource string.

The resource will be in the following format:

projects/{project}/locations/{location}/privateClouds/{private_cloud}

Parameters:

  • project (String)
  • location (String)
  • private_cloud (String)

Returns:

  • (::String)

Raises:

  • (::ArgumentError) 


315
316
317
318
319
320
 
# File 'lib/google/cloud/vmware_engine/v1/vmware_engine/paths.rb', line 315

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

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

#private_connection_path(project:, location:, private_connection:) ⇒ ::String

Create a fully-qualified PrivateConnection resource string.

The resource will be in the following format:

projects/{project}/locations/{location}/privateConnections/{private_connection}

Parameters:

  • project (String)
  • location (String)
  • private_connection (String)

Returns:

  • (::String)

Raises:

  • (::ArgumentError) 


334
335
336
337
338
339
 
# File 'lib/google/cloud/vmware_engine/v1/vmware_engine/paths.rb', line 334

def private_connection_path project:, location:, private_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}/privateConnections/#{private_connection}"
end

#subnet_path(project:, location:, private_cloud:, subnet:) ⇒ ::String

Create a fully-qualified Subnet resource string.

The resource will be in the following format:

projects/{project}/locations/{location}/privateClouds/{private_cloud}/subnets/{subnet}

Parameters:

  • project (String)
  • location (String)
  • private_cloud (String)
  • subnet (String)

Returns:

  • (::String)

Raises:

  • (::ArgumentError) 


354
355
356
357
358
359
360
 
# File 'lib/google/cloud/vmware_engine/v1/vmware_engine/paths.rb', line 354

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

  "projects/#{project}/locations/#{location}/privateClouds/#{private_cloud}/subnets/#{subnet}"
end

#vmware_engine_network_path(project:, location:, vmware_engine_network:) ⇒ ::String

Create a fully-qualified VmwareEngineNetwork resource string.

The resource will be in the following format:

projects/{project}/locations/{location}/vmwareEngineNetworks/{vmware_engine_network}

Parameters:

  • project (String)
  • location (String)
  • vmware_engine_network (String)

Returns:

  • (::String)

Raises:

  • (::ArgumentError) 


374
375
376
377
378
379
 
# File 'lib/google/cloud/vmware_engine/v1/vmware_engine/paths.rb', line 374

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

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