Class: BmcApi::QuotasApi

Inherits:
Object
  • Object
show all
Defined in:
lib/pnap_bmc_api/api/quotas_api.rb

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(api_client = ApiClient.default) ⇒ QuotasApi

Returns a new instance of QuotasApi.



19
20
21
 
# File 'lib/pnap_bmc_api/api/quotas_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/pnap_bmc_api/api/quotas_api.rb', line 17

def api_client
  @api_client
end

Instance Method Details

#quotas_get(opts = {}) ⇒ Array<Quota>

List quotas Get account quota details.

Parameters:

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

    the optional parameters

Returns:



26
27
28
29
 
# File 'lib/pnap_bmc_api/api/quotas_api.rb', line 26

def quotas_get(opts = {})
  data, _status_code, _headers = quotas_get_with_http_info(opts)
  data
end

#quotas_get_with_http_info(opts = {}) ⇒ Array<(Array<Quota>, Integer, Hash)>

List quotas Get account quota details.

Parameters:

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

    the optional parameters

Returns:

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

    Array<Quota> data, response status code and response headers



35
36
37
38
39
40
41
42
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
 
# File 'lib/pnap_bmc_api/api/quotas_api.rb', line 35

def quotas_get_with_http_info(opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: QuotasApi.quotas_get ...'
  end
  # resource path
  local_var_path = '/quotas'

  # query parameters
  query_params = opts[:query_params] || {}

  # header parameters
  header_params = opts[:header_params] || {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json'])

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

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

  # return_type
  return_type = opts[:debug_return_type] || 'Array<Quota>'

  # auth_names
  auth_names = opts[:debug_auth_names] || ['OAuth2']

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

#quotas_quota_id_actions_request_edit_post(quota_id, quota_edit_limit_request, opts = {}) ⇒ nil

Request quota limit change. Sends a request to edit the limit of a quota.

Parameters:

  • quota_id (String) —

    The ID of the Quota.

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

    the optional parameters

Returns:

  • (nil) 


85
86
87
88
 
# File 'lib/pnap_bmc_api/api/quotas_api.rb', line 85

def quotas_quota_id_actions_request_edit_post(quota_id, quota_edit_limit_request, opts = {})
  quotas_quota_id_actions_request_edit_post_with_http_info(quota_id, quota_edit_limit_request, opts)
  nil
end

#quotas_quota_id_actions_request_edit_post_with_http_info(quota_id, quota_edit_limit_request, opts = {}) ⇒ Array<(nil, Integer, Hash)>

Request quota limit change. Sends a request to edit the limit of a quota.

Parameters:

  • quota_id (String) —

    The ID of the Quota.

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

    the optional parameters

Returns:

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

    nil, response status code and response headers



96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
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
 
# File 'lib/pnap_bmc_api/api/quotas_api.rb', line 96

def quotas_quota_id_actions_request_edit_post_with_http_info(quota_id, quota_edit_limit_request, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: QuotasApi.quotas_quota_id_actions_request_edit_post ...'
  end
  # verify the required parameter 'quota_id' is set
  if @api_client.config.client_side_validation && quota_id.nil?
    fail ArgumentError, "Missing the required parameter 'quota_id' when calling QuotasApi.quotas_quota_id_actions_request_edit_post"
  end
  # verify the required parameter 'quota_edit_limit_request' is set
  if @api_client.config.client_side_validation && quota_edit_limit_request.nil?
    fail ArgumentError, "Missing the required parameter 'quota_edit_limit_request' when calling QuotasApi.quotas_quota_id_actions_request_edit_post"
  end
  # resource path
  local_var_path = '/quotas/{quotaId}/actions/request-edit'.sub('{' + 'quotaId' + '}', CGI.escape(quota_id.to_s))

  # query parameters
  query_params = opts[:query_params] || {}

  # header parameters
  header_params = opts[:header_params] || {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json'])
  # HTTP header 'Content-Type'
  content_type = @api_client.select_header_content_type(['application/json'])
  if !content_type.nil?
      header_params['Content-Type'] = content_type
  end

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

  # http body (model)
  post_body = opts[:debug_body] || @api_client.object_to_http_body(quota_edit_limit_request)

  # return_type
  return_type = opts[:debug_return_type]

  # auth_names
  auth_names = opts[:debug_auth_names] || ['OAuth2']

  new_options = opts.merge(
    :operation => :"QuotasApi.quotas_quota_id_actions_request_edit_post",
    :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(:POST, local_var_path, new_options)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: QuotasApi#quotas_quota_id_actions_request_edit_post\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#quotas_quota_id_get(quota_id, opts = {}) ⇒ Quota

Get a quota. Get account quota details.

Parameters:

  • quota_id (String) —

    The ID of the Quota.

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

    the optional parameters

Returns:



158
159
160
161
 
# File 'lib/pnap_bmc_api/api/quotas_api.rb', line 158

def quotas_quota_id_get(quota_id, opts = {})
  data, _status_code, _headers = quotas_quota_id_get_with_http_info(quota_id, opts)
  data
end

#quotas_quota_id_get_with_http_info(quota_id, opts = {}) ⇒ Array<(Quota, Integer, Hash)>

Get a quota. Get account quota details.

Parameters:

  • quota_id (String) —

    The ID of the Quota.

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

    the optional parameters

Returns:

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

    Quota data, response status code and response headers



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
 
# File 'lib/pnap_bmc_api/api/quotas_api.rb', line 168

def quotas_quota_id_get_with_http_info(quota_id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: QuotasApi.quotas_quota_id_get ...'
  end
  # verify the required parameter 'quota_id' is set
  if @api_client.config.client_side_validation && quota_id.nil?
    fail ArgumentError, "Missing the required parameter 'quota_id' when calling QuotasApi.quotas_quota_id_get"
  end
  # resource path
  local_var_path = '/quotas/{quotaId}'.sub('{' + 'quotaId' + '}', CGI.escape(quota_id.to_s))

  # query parameters
  query_params = opts[:query_params] || {}

  # header parameters
  header_params = opts[:header_params] || {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json'])

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

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

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

  # auth_names
  auth_names = opts[:debug_auth_names] || ['OAuth2']

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