Class: Ionoscloud::RequestsApi

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

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(api_client = ApiClient.default) ⇒ RequestsApi

Returns a new instance of RequestsApi.



19
20
21
 
# File 'lib/ionoscloud/api/requests_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/requests_api.rb', line 17

def api_client
  @api_client
end

Instance Method Details

#requests_find_by_id(request_id, opts = {}) ⇒ Request

Retrieve requests Retrieve the properties of the specified request.

Parameters:

  • request_id (String) —

    The unique ID of the request.

  • 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/requests_api.rb', line 30

def requests_find_by_id(request_id, opts = {})
  data, _status_code, _headers = requests_find_by_id_with_http_info(request_id, opts)
  data
end

#requests_find_by_id_with_http_info(request_id, opts = {}) ⇒ Array<(Request, Integer, Hash)>

Retrieve requests Retrieve the properties of the specified request.

Parameters:

  • request_id (String) —

    The unique ID of the request.

  • 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<(Request, Integer, Hash)>) —

    Request 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/requests_api.rb', line 43

def requests_find_by_id_with_http_info(request_id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: RequestsApi.requests_find_by_id ...'
  end
  # verify the required parameter 'request_id' is set
  if @api_client.config.client_side_validation && request_id.nil?
    fail ArgumentError, "Missing the required parameter 'request_id' when calling RequestsApi.requests_find_by_id"
  end
  if @api_client.config.client_side_validation && !opts[:'depth'].nil? && opts[:'depth'] > 10
    fail ArgumentError, 'invalid value for "opts[:"depth"]" when calling RequestsApi.requests_find_by_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 RequestsApi.requests_find_by_id, must be greater than or equal to 0.'
  end

  # resource path
  local_var_path = '/requests/{requestId}'.sub('{' + 'requestId' + '}', CGI.escape(request_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] || 'Request'

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

  new_options = opts.merge(
    :operation => :"RequestsApi.requests_find_by_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: RequestsApi#requests_find_by_id\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#requests_get(opts = {}) ⇒ Requests

List requests List all API requests.

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.

  • :filter_status (String) —

    Filter the list by request status [QUEUED, RUNNING, DONE, FAILED]. Filter is not affected by the depth query parameter.

  • :filter_created_after (String) —

    Filter the list to only include the requests created after the date, specified in the yyyy-MM-dd HH:mm:ss format. Filter is not affected by the depth query parameter.

  • :filter_created_before (String) —

    Filter the list to only include the requests created before the date, specified in the yyyy-MM-dd HH:mm:ss format. Filter is not affected by the depth query parameter.

  • :filter_created_date (String) —

    Filter the list to only include the requests that contain the createdDate, specified in the yyyy-MM-dd HH:mm:ss format. The value is not case-sensitive, and the filter requires that the depth query parameter value is greater than zero.

  • :filter_created_by (String) —

    Filter the list to only include the requests that contain the createdBy, specified in the yyyy-MM-dd HH:mm:ss format. The value is not case-sensitive, and the filter requires that the depth query parameter value is greater than zero.

  • :filter_etag (String) —

    Filter the list to only include the requests that contain the specified etag. The value is not case-sensitive, and the filter requires that the depth query parameter value is greater than zero.

  • :filter_request_status (String) —

    Filter the list to only include the requests that contain the specified requestStatus. The value is not case-sensitive, and the filter requires that the depth query parameter value is greater than zero.

  • :filter_method (String) —

    Filter the list to only include the requests that contain the specified method. The value is not case-sensitive, and the filter requires that the depth query parameter value is greater than zero.

  • :filter_headers (String) —

    Filter the list to only include the requests that contain the specified headers. The value is not case-sensitive, and the filter requires that the depth query parameter value is greater than zero.

  • :filter_body (String) —

    Filter the list to only include the requests that contain the specified body. The value is not case-sensitive, and the filter requires that the depth query parameter value is greater than zero.

  • :filter_url (String) —

    Filter the list to only include the requests that contain the specified URL. The value is not case-sensitive, and the filter requires that the depth query parameter value is greater than zero.

  • :offset (Integer) —

    The first element (from the complete list of the elements) to include in the response (used together with &lt;b&gt;&lt;i&gt;limit&lt;/i&gt;&lt;/b&gt; for pagination). (default to 0)

  • :limit (Integer) —

    The maximum number of elements to return (use together with offset for pagination). (default to 1000)

Returns:



122
123
124
125
 
# File 'lib/ionoscloud/api/requests_api.rb', line 122

def requests_get(opts = {})
  data, _status_code, _headers = requests_get_with_http_info(opts)
  data
end

#requests_get_with_http_info(opts = {}) ⇒ Array<(Requests, Integer, Hash)>

List requests List all API requests.

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.

  • :filter_status (String) —

    Filter the list by request status [QUEUED, RUNNING, DONE, FAILED]. Filter is not affected by the depth query parameter.

  • :filter_created_after (String) —

    Filter the list to only include the requests created after the date, specified in the yyyy-MM-dd HH:mm:ss format. Filter is not affected by the depth query parameter.

  • :filter_created_before (String) —

    Filter the list to only include the requests created before the date, specified in the yyyy-MM-dd HH:mm:ss format. Filter is not affected by the depth query parameter.

  • :filter_created_date (String) —

    Filter the list to only include the requests that contain the createdDate, specified in the yyyy-MM-dd HH:mm:ss format. The value is not case-sensitive, and the filter requires that the depth query parameter value is greater than zero.

  • :filter_created_by (String) —

    Filter the list to only include the requests that contain the createdBy, specified in the yyyy-MM-dd HH:mm:ss format. The value is not case-sensitive, and the filter requires that the depth query parameter value is greater than zero.

  • :filter_etag (String) —

    Filter the list to only include the requests that contain the specified etag. The value is not case-sensitive, and the filter requires that the depth query parameter value is greater than zero.

  • :filter_request_status (String) —

    Filter the list to only include the requests that contain the specified requestStatus. The value is not case-sensitive, and the filter requires that the depth query parameter value is greater than zero.

  • :filter_method (String) —

    Filter the list to only include the requests that contain the specified method. The value is not case-sensitive, and the filter requires that the depth query parameter value is greater than zero.

  • :filter_headers (String) —

    Filter the list to only include the requests that contain the specified headers. The value is not case-sensitive, and the filter requires that the depth query parameter value is greater than zero.

  • :filter_body (String) —

    Filter the list to only include the requests that contain the specified body. The value is not case-sensitive, and the filter requires that the depth query parameter value is greater than zero.

  • :filter_url (String) —

    Filter the list to only include the requests that contain the specified URL. The value is not case-sensitive, and the filter requires that the depth query parameter value is greater than zero.

  • :offset (Integer) —

    The first element (from the complete list of the elements) to include in the response (used together with &lt;b&gt;&lt;i&gt;limit&lt;/i&gt;&lt;/b&gt; for pagination).

  • :limit (Integer) —

    The maximum number of elements to return (use together with offset for pagination).

Returns:

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

    Requests data, response status code and response headers



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
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
 
# File 'lib/ionoscloud/api/requests_api.rb', line 147

def requests_get_with_http_info(opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: RequestsApi.requests_get ...'
  end
  if @api_client.config.client_side_validation && !opts[:'depth'].nil? && opts[:'depth'] > 10
    fail ArgumentError, 'invalid value for "opts[:"depth"]" when calling RequestsApi.requests_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 RequestsApi.requests_get, must be greater than or equal to 0.'
  end

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

  if @api_client.config.client_side_validation && !opts[:'limit'].nil? && opts[:'limit'] > 10000
    fail ArgumentError, 'invalid value for "opts[:"limit"]" when calling RequestsApi.requests_get, must be smaller than or equal to 10000.'
  end

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

  # resource path
  local_var_path = '/requests'

  # 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?
  query_params[:'filter.status'] = opts[:'filter_status'] if !opts[:'filter_status'].nil?
  query_params[:'filter.createdAfter'] = opts[:'filter_created_after'] if !opts[:'filter_created_after'].nil?
  query_params[:'filter.createdBefore'] = opts[:'filter_created_before'] if !opts[:'filter_created_before'].nil?
  query_params[:'filter.createdDate'] = opts[:'filter_created_date'] if !opts[:'filter_created_date'].nil?
  query_params[:'filter.createdBy'] = opts[:'filter_created_by'] if !opts[:'filter_created_by'].nil?
  query_params[:'filter.etag'] = opts[:'filter_etag'] if !opts[:'filter_etag'].nil?
  query_params[:'filter.requestStatus'] = opts[:'filter_request_status'] if !opts[:'filter_request_status'].nil?
  query_params[:'filter.method'] = opts[:'filter_method'] if !opts[:'filter_method'].nil?
  query_params[:'filter.headers'] = opts[:'filter_headers'] if !opts[:'filter_headers'].nil?
  query_params[:'filter.body'] = opts[:'filter_body'] if !opts[:'filter_body'].nil?
  query_params[:'filter.url'] = opts[:'filter_url'] if !opts[:'filter_url'].nil?
  query_params[:'offset'] = opts[:'offset'] if !opts[:'offset'].nil?
  query_params[:'limit'] = opts[:'limit'] if !opts[:'limit'].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] || 'Requests'

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

  new_options = opts.merge(
    :operation => :"RequestsApi.requests_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: RequestsApi#requests_get\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#requests_status_get(request_id, opts = {}) ⇒ RequestStatus

Retrieve request status Retrieve the status of the specified request.

Parameters:

  • request_id (String) —

    The unique ID of the request.

  • 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:



235
236
237
238
 
# File 'lib/ionoscloud/api/requests_api.rb', line 235

def requests_status_get(request_id, opts = {})
  data, _status_code, _headers = requests_status_get_with_http_info(request_id, opts)
  data
end

#requests_status_get_with_http_info(request_id, opts = {}) ⇒ Array<(RequestStatus, Integer, Hash)>

Retrieve request status Retrieve the status of the specified request.

Parameters:

  • request_id (String) —

    The unique ID of the request.

  • 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<(RequestStatus, Integer, Hash)>) —

    RequestStatus data, response status code and response headers



248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
 
# File 'lib/ionoscloud/api/requests_api.rb', line 248

def requests_status_get_with_http_info(request_id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: RequestsApi.requests_status_get ...'
  end
  # verify the required parameter 'request_id' is set
  if @api_client.config.client_side_validation && request_id.nil?
    fail ArgumentError, "Missing the required parameter 'request_id' when calling RequestsApi.requests_status_get"
  end
  if @api_client.config.client_side_validation && !opts[:'depth'].nil? && opts[:'depth'] > 10
    fail ArgumentError, 'invalid value for "opts[:"depth"]" when calling RequestsApi.requests_status_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 RequestsApi.requests_status_get, must be greater than or equal to 0.'
  end

  # resource path
  local_var_path = '/requests/{requestId}/status'.sub('{' + 'requestId' + '}', CGI.escape(request_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] || 'RequestStatus'

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

  new_options = opts.merge(
    :operation => :"RequestsApi.requests_status_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: RequestsApi#requests_status_get\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end