Class: Ionoscloud::LocationsApi

Inherits:
Object
  • Object
show all
Defined in:
lib/ionoscloud/api/locations_api.rb

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(api_client = ApiClient.default) ⇒ LocationsApi

Returns a new instance of LocationsApi.



19
20
21
 
# File 'lib/ionoscloud/api/locations_api.rb', line 19

def initialize(api_client = ApiClient.default)
  @api_client = api_client
end

Instance Attribute Details

#api_client ⇒ Object

Returns the value of attribute api_client.



17
18
19
 
# File 'lib/ionoscloud/api/locations_api.rb', line 17

def api_client
  @api_client
end

Instance Method Details

#locations_find_by_region_id(region_id, opts = {}) ⇒ Locations

List locations within regions List locations by the region ID.

Parameters:

  • region_id (String) —

    The unique ID of the region.

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Options Hash (opts):

  • :pretty (Boolean) —

    Controls whether the response is pretty-printed (with indentations and new lines). (default to true)

  • :depth (Integer) —

    Controls the detail depth of the response objects. GET /datacenters/ - depth=0: Only direct properties are included; children (servers and other elements) are not included. - depth=1: Direct properties and children references are included. - depth=2: Direct properties and children properties are included. - depth=3: Direct properties and children properties and children's children are included. - depth=… and so on (default to 0)

  • :x_contract_number (Integer) —

    Users with multiple contracts must provide the contract number, for which all API requests are to be executed.

Returns:



30
31
32
33
 
# File 'lib/ionoscloud/api/locations_api.rb', line 30

def locations_find_by_region_id(region_id, opts = {})
  data, _status_code, _headers = locations_find_by_region_id_with_http_info(region_id, opts)
  data
end

#locations_find_by_region_id_and_id(region_id, location_id, opts = {}) ⇒ Location

Retrieve specified locations Retrieve the properties of the specified location

Parameters:

  • region_id (String) —

    The unique ID of the region.

  • location_id (String) —

    The unique ID of the location.

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Options Hash (opts):

  • :pretty (Boolean) —

    Controls whether the response is pretty-printed (with indentations and new lines). (default to true)

  • :depth (Integer) —

    Controls the detail depth of the response objects. GET /datacenters/ - depth=0: Only direct properties are included; children (servers and other elements) are not included. - depth=1: Direct properties and children references are included. - depth=2: Direct properties and children properties are included. - depth=3: Direct properties and children properties and children's children are included. - depth=… and so on (default to 0)

  • :x_contract_number (Integer) —

    Users with multiple contracts must provide the contract number, for which all API requests are to be executed.

Returns:



111
112
113
114
 
# File 'lib/ionoscloud/api/locations_api.rb', line 111

def locations_find_by_region_id_and_id(region_id, location_id, opts = {})
  data, _status_code, _headers = locations_find_by_region_id_and_id_with_http_info(region_id, location_id, opts)
  data
end

#locations_find_by_region_id_and_id_with_http_info(region_id, location_id, opts = {}) ⇒ Array<(Location, Integer, Hash)>

Retrieve specified locations Retrieve the properties of the specified location

Parameters:

  • region_id (String) —

    The unique ID of the region.

  • location_id (String) —

    The unique ID of the location.

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Options Hash (opts):

  • :pretty (Boolean) —

    Controls whether the response is pretty-printed (with indentations and new lines).

  • :depth (Integer) —

    Controls the detail depth of the response objects. GET /datacenters/ - depth&#x3D;0: Only direct properties are included; children (servers and other elements) are not included. - depth&#x3D;1: Direct properties and children references are included. - depth&#x3D;2: Direct properties and children properties are included. - depth&#x3D;3: Direct properties and children properties and children&#39;s children are included. - depth&#x3D;… and so on

  • :x_contract_number (Integer) —

    Users with multiple contracts must provide the contract number, for which all API requests are to be executed.

Returns:

  • (Array<(Location, Integer, Hash)>) —

    Location data, response status code and response headers



125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
 
# File 'lib/ionoscloud/api/locations_api.rb', line 125

def locations_find_by_region_id_and_id_with_http_info(region_id, location_id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: LocationsApi.locations_find_by_region_id_and_id ...'
  end
  # verify the required parameter 'region_id' is set
  if @api_client.config.client_side_validation && region_id.nil?
    fail ArgumentError, "Missing the required parameter 'region_id' when calling LocationsApi.locations_find_by_region_id_and_id"
  end
  # verify the required parameter 'location_id' is set
  if @api_client.config.client_side_validation && location_id.nil?
    fail ArgumentError, "Missing the required parameter 'location_id' when calling LocationsApi.locations_find_by_region_id_and_id"
  end
  if @api_client.config.client_side_validation && !opts[:'depth'].nil? && opts[:'depth'] > 10
    fail ArgumentError, 'invalid value for "opts[:"depth"]" when calling LocationsApi.locations_find_by_region_id_and_id, must be smaller than or equal to 10.'
  end

  if @api_client.config.client_side_validation && !opts[:'depth'].nil? && opts[:'depth'] < 0
    fail ArgumentError, 'invalid value for "opts[:"depth"]" when calling LocationsApi.locations_find_by_region_id_and_id, must be greater than or equal to 0.'
  end

  # resource path
  local_var_path = '/locations/{regionId}/{locationId}'.sub('{' + 'regionId' + '}', CGI.escape(region_id.to_s)).sub('{' + 'locationId' + '}', CGI.escape(location_id.to_s))

  # query parameters
  query_params = opts[:query_params] || {}
  query_params[:'pretty'] = opts[:'pretty'] if !opts[:'pretty'].nil?
  query_params[:'depth'] = opts[:'depth'] if !opts[:'depth'].nil?

  # header parameters
  header_params = opts[:header_params] || {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json'])
  header_params[:'X-Contract-Number'] = opts[:'x_contract_number'] if !opts[:'x_contract_number'].nil?

  # form parameters
  form_params = opts[:form_params] || {}

  # http body (model)
  post_body = opts[:debug_body]

  # return_type
  return_type = opts[:debug_return_type] || 'Location'

  # auth_names
  auth_names = opts[:debug_auth_names] || ['Basic Authentication', 'Token Authentication']

  new_options = opts.merge(
    :operation => :"LocationsApi.locations_find_by_region_id_and_id",
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => return_type
  )

  data, status_code, headers = @api_client.call_api(:GET, local_var_path, new_options)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: LocationsApi#locations_find_by_region_id_and_id\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#locations_find_by_region_id_with_http_info(region_id, opts = {}) ⇒ Array<(Locations, Integer, Hash)>

List locations within regions List locations by the region ID.

Parameters:

  • region_id (String) —

    The unique ID of the region.

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Options Hash (opts):

  • :pretty (Boolean) —

    Controls whether the response is pretty-printed (with indentations and new lines).

  • :depth (Integer) —

    Controls the detail depth of the response objects. GET /datacenters/ - depth&#x3D;0: Only direct properties are included; children (servers and other elements) are not included. - depth&#x3D;1: Direct properties and children references are included. - depth&#x3D;2: Direct properties and children properties are included. - depth&#x3D;3: Direct properties and children properties and children&#39;s children are included. - depth&#x3D;… and so on

  • :x_contract_number (Integer) —

    Users with multiple contracts must provide the contract number, for which all API requests are to be executed.

Returns:

  • (Array<(Locations, Integer, Hash)>) —

    Locations data, response status code and response headers



43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
 
# File 'lib/ionoscloud/api/locations_api.rb', line 43

def locations_find_by_region_id_with_http_info(region_id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: LocationsApi.locations_find_by_region_id ...'
  end
  # verify the required parameter 'region_id' is set
  if @api_client.config.client_side_validation && region_id.nil?
    fail ArgumentError, "Missing the required parameter 'region_id' when calling LocationsApi.locations_find_by_region_id"
  end
  if @api_client.config.client_side_validation && !opts[:'depth'].nil? && opts[:'depth'] > 10
    fail ArgumentError, 'invalid value for "opts[:"depth"]" when calling LocationsApi.locations_find_by_region_id, must be smaller than or equal to 10.'
  end

  if @api_client.config.client_side_validation && !opts[:'depth'].nil? && opts[:'depth'] < 0
    fail ArgumentError, 'invalid value for "opts[:"depth"]" when calling LocationsApi.locations_find_by_region_id, must be greater than or equal to 0.'
  end

  # resource path
  local_var_path = '/locations/{regionId}'.sub('{' + 'regionId' + '}', CGI.escape(region_id.to_s))

  # query parameters
  query_params = opts[:query_params] || {}
  query_params[:'pretty'] = opts[:'pretty'] if !opts[:'pretty'].nil?
  query_params[:'depth'] = opts[:'depth'] if !opts[:'depth'].nil?

  # header parameters
  header_params = opts[:header_params] || {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json'])
  header_params[:'X-Contract-Number'] = opts[:'x_contract_number'] if !opts[:'x_contract_number'].nil?

  # form parameters
  form_params = opts[:form_params] || {}

  # http body (model)
  post_body = opts[:debug_body]

  # return_type
  return_type = opts[:debug_return_type] || 'Locations'

  # auth_names
  auth_names = opts[:debug_auth_names] || ['Basic Authentication', 'Token Authentication']

  new_options = opts.merge(
    :operation => :"LocationsApi.locations_find_by_region_id",
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => return_type
  )

  data, status_code, headers = @api_client.call_api(:GET, local_var_path, new_options)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: LocationsApi#locations_find_by_region_id\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#locations_get(opts = {}) ⇒ Locations

List locations List the available locations for provisioning your virtual data centers.

Parameters:

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Options Hash (opts):

  • :pretty (Boolean) —

    Controls whether the response is pretty-printed (with indentations and new lines). (default to true)

  • :depth (Integer) —

    Controls the detail depth of the response objects. GET /datacenters/ - depth&#x3D;0: Only direct properties are included; children (servers and other elements) are not included. - depth&#x3D;1: Direct properties and children references are included. - depth&#x3D;2: Direct properties and children properties are included. - depth&#x3D;3: Direct properties and children properties and children&#39;s children are included. - depth&#x3D;… and so on (default to 0)

  • :x_contract_number (Integer) —

    Users with multiple contracts must provide the contract number, for which all API requests are to be executed.

Returns:



195
196
197
198
 
# File 'lib/ionoscloud/api/locations_api.rb', line 195

def locations_get(opts = {})
  data, _status_code, _headers = locations_get_with_http_info(opts)
  data
end

#locations_get_with_http_info(opts = {}) ⇒ Array<(Locations, Integer, Hash)>

List locations List the available locations for provisioning your virtual data centers.

Parameters:

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Options Hash (opts):

  • :pretty (Boolean) —

    Controls whether the response is pretty-printed (with indentations and new lines).

  • :depth (Integer) —

    Controls the detail depth of the response objects. GET /datacenters/ - depth&#x3D;0: Only direct properties are included; children (servers and other elements) are not included. - depth&#x3D;1: Direct properties and children references are included. - depth&#x3D;2: Direct properties and children properties are included. - depth&#x3D;3: Direct properties and children properties and children&#39;s children are included. - depth&#x3D;… and so on

  • :x_contract_number (Integer) —

    Users with multiple contracts must provide the contract number, for which all API requests are to be executed.

Returns:

  • (Array<(Locations, Integer, Hash)>) —

    Locations data, response status code and response headers



207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
 
# File 'lib/ionoscloud/api/locations_api.rb', line 207

def locations_get_with_http_info(opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: LocationsApi.locations_get ...'
  end
  if @api_client.config.client_side_validation && !opts[:'depth'].nil? && opts[:'depth'] > 10
    fail ArgumentError, 'invalid value for "opts[:"depth"]" when calling LocationsApi.locations_get, must be smaller than or equal to 10.'
  end

  if @api_client.config.client_side_validation && !opts[:'depth'].nil? && opts[:'depth'] < 0
    fail ArgumentError, 'invalid value for "opts[:"depth"]" when calling LocationsApi.locations_get, must be greater than or equal to 0.'
  end

  # resource path
  local_var_path = '/locations'

  # query parameters
  query_params = opts[:query_params] || {}
  query_params[:'pretty'] = opts[:'pretty'] if !opts[:'pretty'].nil?
  query_params[:'depth'] = opts[:'depth'] if !opts[:'depth'].nil?

  # header parameters
  header_params = opts[:header_params] || {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json'])
  header_params[:'X-Contract-Number'] = opts[:'x_contract_number'] if !opts[:'x_contract_number'].nil?

  # form parameters
  form_params = opts[:form_params] || {}

  # http body (model)
  post_body = opts[:debug_body]

  # return_type
  return_type = opts[:debug_return_type] || 'Locations'

  # auth_names
  auth_names = opts[:debug_auth_names] || ['Basic Authentication', 'Token Authentication']

  new_options = opts.merge(
    :operation => :"LocationsApi.locations_get",
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => return_type
  )

  data, status_code, headers = @api_client.call_api(:GET, local_var_path, new_options)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: LocationsApi#locations_get\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end