Module: Google::Cloud::ApiGateway::V1::ApiGatewayService::Paths

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

Overview

Path helper methods for the ApiGatewayService API.

Instance Method Summary collapse

Instance Method Details

#api_config_path(project:, api:, api_config:) ⇒ ::String

Create a fully-qualified ApiConfig resource string.

The resource will be in the following format:

projects/{project}/locations/global/apis/{api}/configs/{api_config}

Parameters:

  • project (String)
  • api (String)
  • api_config (String)

Returns:

  • (::String)

Raises:

  • (::ArgumentError) 


56
57
58
59
60
61
 
# File 'lib/google/cloud/api_gateway/v1/api_gateway_service/paths.rb', line 56

def api_config_path project:, api:, api_config:
  raise ::ArgumentError, "project cannot contain /" if project.to_s.include? "/"
  raise ::ArgumentError, "api cannot contain /" if api.to_s.include? "/"

  "projects/#{project}/locations/global/apis/#{api}/configs/#{api_config}"
end

#api_path(project:, api:) ⇒ ::String

Create a fully-qualified Api resource string.

The resource will be in the following format:

projects/{project}/locations/global/apis/{api}

Parameters:

  • project (String)
  • api (String)

Returns:

  • (::String)

Raises:

  • (::ArgumentError) 


38
39
40
41
42
 
# File 'lib/google/cloud/api_gateway/v1/api_gateway_service/paths.rb', line 38

def api_path project:, api:
  raise ::ArgumentError, "project cannot contain /" if project.to_s.include? "/"

  "projects/#{project}/locations/global/apis/#{api}"
end

#gateway_path(project:, location:, gateway:) ⇒ ::String

Create a fully-qualified Gateway resource string.

The resource will be in the following format:

projects/{project}/locations/{location}/gateways/{gateway}

Parameters:

  • project (String)
  • location (String)
  • gateway (String)

Returns:

  • (::String)

Raises:

  • (::ArgumentError) 


75
76
77
78
79
80
 
# File 'lib/google/cloud/api_gateway/v1/api_gateway_service/paths.rb', line 75

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

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


93
94
95
96
97
 
# File 'lib/google/cloud/api_gateway/v1/api_gateway_service/paths.rb', line 93

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

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

#managed_service_path(service:) ⇒ ::String

Create a fully-qualified ManagedService resource string.

The resource will be in the following format:

services/{service}

Parameters:

  • service (String)

Returns:

  • (::String) 


109
110
111
 
# File 'lib/google/cloud/api_gateway/v1/api_gateway_service/paths.rb', line 109

def managed_service_path service:
  "services/#{service}"
end

#service_account_path(project:, service_account:) ⇒ ::String

Create a fully-qualified ServiceAccount resource string.

The resource will be in the following format:

projects/{project}/serviceAccounts/{service_account}

Parameters:

  • project (String)
  • service_account (String)

Returns:

  • (::String)

Raises:

  • (::ArgumentError) 


141
142
143
144
145
 
# File 'lib/google/cloud/api_gateway/v1/api_gateway_service/paths.rb', line 141

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

  "projects/#{project}/serviceAccounts/#{}"
end

#service_path(service:, config:) ⇒ ::String

Create a fully-qualified Service resource string.

The resource will be in the following format:

services/{service}/configs/{config}

Parameters:

  • service (String)
  • config (String)

Returns:

  • (::String)

Raises:

  • (::ArgumentError) 


124
125
126
127
128
 
# File 'lib/google/cloud/api_gateway/v1/api_gateway_service/paths.rb', line 124

def service_path service:, config:
  raise ::ArgumentError, "service cannot contain /" if service.to_s.include? "/"

  "services/#{service}/configs/#{config}"
end