Class: Harbor2Client::UsergroupApi

Inherits:
Object
  • Object
show all
Defined in:
lib/harbor2_client/api/usergroup_api.rb

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(api_client = ApiClient.default) ⇒ UsergroupApi 



19
20
21
 
# File 'lib/harbor2_client/api/usergroup_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/harbor2_client/api/usergroup_api.rb', line 17

def api_client
  @api_client
end

Instance Method Details

#create_user_group(opts = {}) ⇒ nil

Create user group Create user group information

Options Hash (opts):

  • :x_request_id (String) —

    An unique ID for the request

  • :usergroup (UserGroup) 


28
29
30
31
 
# File 'lib/harbor2_client/api/usergroup_api.rb', line 28

def create_user_group(opts = {})
  create_user_group_with_http_info(opts)
  nil
end

#create_user_group_with_http_info(opts = {}) ⇒ Array<(nil, Fixnum, Hash)>

Create user group Create user group information

Options Hash (opts):

  • :x_request_id (String) —

    An unique ID for the request

  • :usergroup (UserGroup) 


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/harbor2_client/api/usergroup_api.rb', line 39

def create_user_group_with_http_info(opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: UsergroupApi.create_user_group ...'
  end
  if @api_client.config.client_side_validation && !opts[:'x_request_id'].nil? && opts[:'x_request_id'].to_s.length < 1
    fail ArgumentError, 'invalid value for "opts[:"x_request_id"]" when calling UsergroupApi.create_user_group, the character length must be great than or equal to 1.'
  end

  # resource path
  local_var_path = '/usergroups'

  # query parameters
  query_params = {}

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

  # form parameters
  form_params = {}

  # http body (model)
  post_body = @api_client.object_to_http_body(opts[:'usergroup'])
  auth_names = ['basic']
  data, status_code, headers = @api_client.call_api(:POST, 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: UsergroupApi#create_user_group\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#delete_user_group(group_id, opts = {}) ⇒ nil

Delete user group Delete user group

Options Hash (opts):

  • :x_request_id (String) —

    An unique ID for the request



84
85
86
87
 
# File 'lib/harbor2_client/api/usergroup_api.rb', line 84

def delete_user_group(group_id, opts = {})
  delete_user_group_with_http_info(group_id, opts)
  nil
end

#delete_user_group_with_http_info(group_id, opts = {}) ⇒ Array<(nil, Fixnum, Hash)>

Delete user group Delete user group

Options Hash (opts):

  • :x_request_id (String) —

    An unique ID for the request



95
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
 
# File 'lib/harbor2_client/api/usergroup_api.rb', line 95

def delete_user_group_with_http_info(group_id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: UsergroupApi.delete_user_group ...'
  end
  # verify the required parameter 'group_id' is set
  if @api_client.config.client_side_validation && group_id.nil?
    fail ArgumentError, "Missing the required parameter 'group_id' when calling UsergroupApi.delete_user_group"
  end
  if @api_client.config.client_side_validation && !opts[:'x_request_id'].nil? && opts[:'x_request_id'].to_s.length < 1
    fail ArgumentError, 'invalid value for "opts[:"x_request_id"]" when calling UsergroupApi.delete_user_group, the character length must be great than or equal to 1.'
  end

  # resource path
  local_var_path = '/usergroups/{group_id}'.sub('{' + 'group_id' + '}', group_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'])
  # HTTP header 'Content-Type'
  header_params['Content-Type'] = @api_client.select_header_content_type(['application/json'])
  header_params[:'X-Request-Id'] = opts[:'x_request_id'] if !opts[:'x_request_id'].nil?

  # form parameters
  form_params = {}

  # http body (model)
  post_body = nil
  auth_names = ['basic']
  data, status_code, headers = @api_client.call_api(:DELETE, 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: UsergroupApi#delete_user_group\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#get_user_group(group_id, opts = {}) ⇒ UserGroup

Get user group information Get user group information

Options Hash (opts):

  • :x_request_id (String) —

    An unique ID for the request



144
145
146
147
 
# File 'lib/harbor2_client/api/usergroup_api.rb', line 144

def get_user_group(group_id, opts = {})
  data, _status_code, _headers = get_user_group_with_http_info(group_id, opts)
  data
end

#get_user_group_with_http_info(group_id, opts = {}) ⇒ Array<(UserGroup, Fixnum, Hash)>

Get user group information Get user group information

Options Hash (opts):

  • :x_request_id (String) —

    An unique ID for the request



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
 
# File 'lib/harbor2_client/api/usergroup_api.rb', line 155

def get_user_group_with_http_info(group_id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: UsergroupApi.get_user_group ...'
  end
  # verify the required parameter 'group_id' is set
  if @api_client.config.client_side_validation && group_id.nil?
    fail ArgumentError, "Missing the required parameter 'group_id' when calling UsergroupApi.get_user_group"
  end
  if @api_client.config.client_side_validation && !opts[:'x_request_id'].nil? && opts[:'x_request_id'].to_s.length < 1
    fail ArgumentError, 'invalid value for "opts[:"x_request_id"]" when calling UsergroupApi.get_user_group, the character length must be great than or equal to 1.'
  end

  # resource path
  local_var_path = '/usergroups/{group_id}'.sub('{' + 'group_id' + '}', group_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'])
  # HTTP header 'Content-Type'
  header_params['Content-Type'] = @api_client.select_header_content_type(['application/json'])
  header_params[:'X-Request-Id'] = opts[:'x_request_id'] if !opts[:'x_request_id'].nil?

  # form parameters
  form_params = {}

  # http body (model)
  post_body = nil
  auth_names = ['basic']
  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 => 'UserGroup')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: UsergroupApi#get_user_group\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#list_user_groups(opts = {}) ⇒ Array<UserGroup>

Get all user groups information Get all user groups information

Options Hash (opts):

  • :x_request_id (String) —

    An unique ID for the request



204
205
206
207
 
# File 'lib/harbor2_client/api/usergroup_api.rb', line 204

def list_user_groups(opts = {})
  data, _status_code, _headers = list_user_groups_with_http_info(opts)
  data
end

#list_user_groups_with_http_info(opts = {}) ⇒ Array<(Array<UserGroup>, Fixnum, Hash)>

Get all user groups information Get all user groups information

Options Hash (opts):

  • :x_request_id (String) —

    An unique ID for the request



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
 
# File 'lib/harbor2_client/api/usergroup_api.rb', line 214

def list_user_groups_with_http_info(opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: UsergroupApi.list_user_groups ...'
  end
  if @api_client.config.client_side_validation && !opts[:'x_request_id'].nil? && opts[:'x_request_id'].to_s.length < 1
    fail ArgumentError, 'invalid value for "opts[:"x_request_id"]" when calling UsergroupApi.list_user_groups, the character length must be great than or equal to 1.'
  end

  # resource path
  local_var_path = '/usergroups'

  # query parameters
  query_params = {}

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

  # form parameters
  form_params = {}

  # http body (model)
  post_body = nil
  auth_names = ['basic']
  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<UserGroup>')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: UsergroupApi#list_user_groups\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#update_user_group(group_id, opts = {}) ⇒ nil

Update group information Update user group information

Options Hash (opts):

  • :x_request_id (String) —

    An unique ID for the request

  • :usergroup (UserGroup) 


261
262
263
264
 
# File 'lib/harbor2_client/api/usergroup_api.rb', line 261

def update_user_group(group_id, opts = {})
  update_user_group_with_http_info(group_id, opts)
  nil
end

#update_user_group_with_http_info(group_id, opts = {}) ⇒ Array<(nil, Fixnum, Hash)>

Update group information Update user group information

Options Hash (opts):

  • :x_request_id (String) —

    An unique ID for the request

  • :usergroup (UserGroup) 


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
306
307
308
309
310
311
312
313
314
315
 
# File 'lib/harbor2_client/api/usergroup_api.rb', line 273

def update_user_group_with_http_info(group_id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: UsergroupApi.update_user_group ...'
  end
  # verify the required parameter 'group_id' is set
  if @api_client.config.client_side_validation && group_id.nil?
    fail ArgumentError, "Missing the required parameter 'group_id' when calling UsergroupApi.update_user_group"
  end
  if @api_client.config.client_side_validation && !opts[:'x_request_id'].nil? && opts[:'x_request_id'].to_s.length < 1
    fail ArgumentError, 'invalid value for "opts[:"x_request_id"]" when calling UsergroupApi.update_user_group, the character length must be great than or equal to 1.'
  end

  # resource path
  local_var_path = '/usergroups/{group_id}'.sub('{' + 'group_id' + '}', group_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'])
  # HTTP header 'Content-Type'
  header_params['Content-Type'] = @api_client.select_header_content_type(['application/json'])
  header_params[:'X-Request-Id'] = opts[:'x_request_id'] if !opts[:'x_request_id'].nil?

  # form parameters
  form_params = {}

  # http body (model)
  post_body = @api_client.object_to_http_body(opts[:'usergroup'])
  auth_names = ['basic']
  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: UsergroupApi#update_user_group\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end