Class: SwaggerClient::QuotaApi

Inherits:
Object
  • Object
show all
Defined in:
lib/harbor_swagger_client/api/quota_api.rb

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(api_client = ApiClient.default) ⇒ QuotaApi 



19
20
21
 
# File 'lib/harbor_swagger_client/api/quota_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/harbor_swagger_client/api/quota_api.rb', line 17

def api_client
  @api_client
end

Instance Method Details

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

List quotas List quotas

Options Hash (opts):

  • :reference (String) —

    The reference type of quota.

  • :sort (String) —

    Sort method, valid values include: &#39;hard.resource_name&#39;, &#39;-hard.resource_name&#39;, &#39;used.resource_name&#39;, &#39;-used.resource_name&#39;. Here &#39;-&#39; stands for descending order, resource_name should be the real resource name of the quota.

  • :page (Integer) —

    The page number, default is 1.

  • :page_size (Integer) —

    The size of per page, default is 10, maximum is 100.



30
31
32
33
 
# File 'lib/harbor_swagger_client/api/quota_api.rb', line 30

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>, Fixnum, Hash)>

List quotas List quotas

Options Hash (opts):

  • :reference (String) —

    The reference type of quota.

  • :sort (String) —

    Sort method, valid values include: &#39;hard.resource_name&#39;, &#39;-hard.resource_name&#39;, &#39;used.resource_name&#39;, &#39;-used.resource_name&#39;. Here &#39;-&#39; stands for descending order, resource_name should be the real resource name of the quota.

  • :page (Integer) —

    The page number, default is 1.

  • :page_size (Integer) —

    The size of per page, default is 10, maximum is 100.



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
 
# File 'lib/harbor_swagger_client/api/quota_api.rb', line 43

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

  # query parameters
  query_params = {}
  query_params[:'reference'] = opts[:'reference'] if !opts[:'reference'].nil?
  query_params[:'sort'] = opts[:'sort'] if !opts[:'sort'].nil?
  query_params[:'page'] = opts[:'page'] if !opts[:'page'].nil?
  query_params[:'page_size'] = opts[:'page_size'] if !opts[:'page_size'].nil?

  # header parameters
  header_params = {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json', 'text/plain'])
  # HTTP header 'Content-Type'
  header_params['Content-Type'] = @api_client.select_header_content_type(['application/json'])

  # form parameters
  form_params = {}

  # http body (model)
  post_body = nil
  auth_names = ['basicAuth']
  data, status_code, headers = @api_client.call_api(:GET, local_var_path,
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => 'Array<Quota>')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: QuotaApi#quotas_get\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#quotas_id_get(id, opts = {}) ⇒ Quota

Get the specified quota Get the specified quota



87
88
89
90
 
# File 'lib/harbor_swagger_client/api/quota_api.rb', line 87

def quotas_id_get(id, opts = {})
  data, _status_code, _headers = quotas_id_get_with_http_info(id, opts)
  data
end

#quotas_id_get_with_http_info(id, opts = {}) ⇒ Array<(Quota, Fixnum, Hash)>

Get the specified quota Get the specified quota



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
 
# File 'lib/harbor_swagger_client/api/quota_api.rb', line 97

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

  # query parameters
  query_params = {}

  # header parameters
  header_params = {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json', 'text/plain'])
  # HTTP header 'Content-Type'
  header_params['Content-Type'] = @api_client.select_header_content_type(['application/json'])

  # form parameters
  form_params = {}

  # http body (model)
  post_body = nil
  auth_names = ['basicAuth']
  data, status_code, headers = @api_client.call_api(:GET, local_var_path,
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => 'Quota')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: QuotaApi#quotas_id_get\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#quotas_id_put(id, hard, opts = {}) ⇒ nil

Update the specified quota Update hard limits of the specified quota



142
143
144
145
 
# File 'lib/harbor_swagger_client/api/quota_api.rb', line 142

def quotas_id_put(id, hard, opts = {})
  quotas_id_put_with_http_info(id, hard, opts)
  nil
end

#quotas_id_put_with_http_info(id, hard, opts = {}) ⇒ Array<(nil, Fixnum, Hash)>

Update the specified quota Update hard limits of the specified quota



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
 
# File 'lib/harbor_swagger_client/api/quota_api.rb', line 153

def quotas_id_put_with_http_info(id, hard, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: QuotaApi.quotas_id_put ...'
  end
  # verify the required parameter 'id' is set
  if @api_client.config.client_side_validation && id.nil?
    fail ArgumentError, "Missing the required parameter 'id' when calling QuotaApi.quotas_id_put"
  end
  # verify the required parameter 'hard' is set
  if @api_client.config.client_side_validation && hard.nil?
    fail ArgumentError, "Missing the required parameter 'hard' when calling QuotaApi.quotas_id_put"
  end
  # resource path
  local_var_path = '/quotas/{id}'.sub('{' + 'id' + '}', id.to_s)

  # query parameters
  query_params = {}

  # header parameters
  header_params = {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json', 'text/plain'])
  # HTTP header 'Content-Type'
  header_params['Content-Type'] = @api_client.select_header_content_type(['application/json'])

  # form parameters
  form_params = {}

  # http body (model)
  post_body = @api_client.object_to_http_body(hard)
  auth_names = ['basicAuth']
  data, status_code, headers = @api_client.call_api(:PUT, local_var_path,
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: QuotaApi#quotas_id_put\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end