lib/ionoscloud/api/requests_api.rb in ionoscloud-6.0.0.beta.1 vs lib/ionoscloud/api/requests_api.rb in ionoscloud-6.0.0.beta.2
- old
+ new
@@ -103,13 +103,21 @@
# Retrieve a list of API requests.
# @param [Hash] opts the optional parameters
# @option opts [Boolean] :pretty Controls whether response is pretty-printed (with indentation and new lines) (default to true)
# @option opts [Integer] :depth Controls the details depth of response objects. Eg. GET /datacenters/[ID] - depth=0: only direct properties are included. Children (servers etc.) 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)
# @option opts [Integer] :x_contract_number Users having more than 1 contract need to provide contract number, against which all API requests should be executed
- # @option opts [String] :filter_status Request status filter to fetch all the request based on a particular status [QUEUED, RUNNING, DONE, FAILED]
- # @option opts [String] :filter_created_after Filter all the requests after the created date
- # @option opts [String] :filter_created_before Filter all the requests before the created date
+ # @option opts [String] :filter_status Request filter to fetch all requests based on a particular status [QUEUED, RUNNING, DONE, FAILED]. It doesn't depend on depth query parameter
+ # @option opts [String] :filter_created_after Request filter to fetch all requests created after the specified date. It doesn't depend on depth query parameter. Date format e.g. 2021-01-01+00:00:00
+ # @option opts [String] :filter_created_before Request filter to fetch all requests created before the specified date. It doesn't depend on depth query parameter. Date format e.g. 2021-01-01+00:00:00
+ # @option opts [String] :filter_created_date Response filter to select and display only the requests that contains the specified createdDate. The value is case insensitive and it depends on depth query parameter that should have a value greater than 0. Date format e.g. 2020-11-16T17:42:59Z
+ # @option opts [String] :filter_created_by Response filter to select and display only the requests that contains the specified createdBy. The value is case insensitive and it depends on depth query parameter that should have a value greater than 0.
+ # @option opts [String] :filter_etag Response filter to select and display only the requests that contains the specified etag. The value is case insensitive and it depends on depth query parameter that should have a value greater than 0.
+ # @option opts [String] :filter_request_status Response filter to select and display only the requests that contains the specified requestStatus. The value is case insensitive and it depends on depth query parameter that should have a value greater than 0.
+ # @option opts [String] :filter_method Response filter to select and display only the requests that contains the specified method. The value is case insensitive and it depends on depth query parameter that should have a value greater than 0.
+ # @option opts [String] :filter_headers Response filter to select and display only the requests that contains the specified headers. The value is case insensitive and it depends on depth query parameter that should have a value greater than 0.
+ # @option opts [String] :filter_body Response filter to select and display only the requests that contains the specified body. The value is case insensitive and it depends on depth query parameter that should have a value greater than 0.
+ # @option opts [String] :filter_url Response filter to select and display only the requests that contains the specified url. The value is case insensitive and it depends on depth query parameter that should have a value greater than 0.
# @option opts [Integer] :offset the first element (of the total list of elements) to include in the response (use together with limit for pagination) (default to 0)
# @option opts [Integer] :limit the maximum number of elements to return (use together with offset for pagination) (default to 1000)
# @return [Requests]
def requests_get(opts = {})
data, _status_code, _headers = requests_get_with_http_info(opts)
@@ -120,13 +128,21 @@
# Retrieve a list of API requests.
# @param [Hash] opts the optional parameters
# @option opts [Boolean] :pretty Controls whether response is pretty-printed (with indentation and new lines)
# @option opts [Integer] :depth Controls the details depth of response objects. Eg. GET /datacenters/[ID] - depth=0: only direct properties are included. Children (servers etc.) 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
# @option opts [Integer] :x_contract_number Users having more than 1 contract need to provide contract number, against which all API requests should be executed
- # @option opts [String] :filter_status Request status filter to fetch all the request based on a particular status [QUEUED, RUNNING, DONE, FAILED]
- # @option opts [String] :filter_created_after Filter all the requests after the created date
- # @option opts [String] :filter_created_before Filter all the requests before the created date
+ # @option opts [String] :filter_status Request filter to fetch all requests based on a particular status [QUEUED, RUNNING, DONE, FAILED]. It doesn't depend on depth query parameter
+ # @option opts [String] :filter_created_after Request filter to fetch all requests created after the specified date. It doesn't depend on depth query parameter. Date format e.g. 2021-01-01+00:00:00
+ # @option opts [String] :filter_created_before Request filter to fetch all requests created before the specified date. It doesn't depend on depth query parameter. Date format e.g. 2021-01-01+00:00:00
+ # @option opts [String] :filter_created_date Response filter to select and display only the requests that contains the specified createdDate. The value is case insensitive and it depends on depth query parameter that should have a value greater than 0. Date format e.g. 2020-11-16T17:42:59Z
+ # @option opts [String] :filter_created_by Response filter to select and display only the requests that contains the specified createdBy. The value is case insensitive and it depends on depth query parameter that should have a value greater than 0.
+ # @option opts [String] :filter_etag Response filter to select and display only the requests that contains the specified etag. The value is case insensitive and it depends on depth query parameter that should have a value greater than 0.
+ # @option opts [String] :filter_request_status Response filter to select and display only the requests that contains the specified requestStatus. The value is case insensitive and it depends on depth query parameter that should have a value greater than 0.
+ # @option opts [String] :filter_method Response filter to select and display only the requests that contains the specified method. The value is case insensitive and it depends on depth query parameter that should have a value greater than 0.
+ # @option opts [String] :filter_headers Response filter to select and display only the requests that contains the specified headers. The value is case insensitive and it depends on depth query parameter that should have a value greater than 0.
+ # @option opts [String] :filter_body Response filter to select and display only the requests that contains the specified body. The value is case insensitive and it depends on depth query parameter that should have a value greater than 0.
+ # @option opts [String] :filter_url Response filter to select and display only the requests that contains the specified url. The value is case insensitive and it depends on depth query parameter that should have a value greater than 0.
# @option opts [Integer] :offset the first element (of the total list of elements) to include in the response (use together with limit for pagination)
# @option opts [Integer] :limit the maximum number of elements to return (use together with offset for pagination)
# @return [Array<(Requests, Integer, Hash)>] Requests data, response status code and response headers
def requests_get_with_http_info(opts = {})
if @api_client.config.debugging
@@ -160,9 +176,17 @@
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] || {}