Class: PulpMavenClient::RepositoriesMavenApi

Inherits:
Object
  • Object
show all
Defined in:
lib/pulp_maven_client/api/repositories_maven_api.rb

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(api_client = ApiClient.default) ⇒ RepositoriesMavenApi

Returns a new instance of RepositoriesMavenApi.



19
20
21
 
# File 'lib/pulp_maven_client/api/repositories_maven_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/pulp_maven_client/api/repositories_maven_api.rb', line 17

def api_client
  @api_client
end

Instance Method Details

#add_role(maven_maven_repository_href, nested_role, opts = {}) ⇒ NestedRoleResponse

Add a role Add a role for this object to users/groups.

Parameters:

  • maven_maven_repository_href (String)
  • nested_role (NestedRole)
  • opts (Hash) (defaults to: {}) —

    the optional parameters

Options Hash (opts):

  • :x_task_diagnostics (Array<String>) —

    List of profilers to use on tasks.

Returns:



29
30
31
32
 
# File 'lib/pulp_maven_client/api/repositories_maven_api.rb', line 29

def add_role(maven_maven_repository_href, nested_role, opts = {})
  data, _status_code, _headers = add_role_with_http_info(maven_maven_repository_href, nested_role, opts)
  data
end

#add_role_with_http_info(maven_maven_repository_href, nested_role, opts = {}) ⇒ Array<(NestedRoleResponse, Integer, Hash)>

Add a role Add a role for this object to users/groups.

Parameters:

  • maven_maven_repository_href (String)
  • nested_role (NestedRole)
  • opts (Hash) (defaults to: {}) —

    the optional parameters

Options Hash (opts):

  • :x_task_diagnostics (Array<String>) —

    List of profilers to use on tasks.

Returns:

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

    NestedRoleResponse data, response status code and response headers



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
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
 
# File 'lib/pulp_maven_client/api/repositories_maven_api.rb', line 41

def add_role_with_http_info(maven_maven_repository_href, nested_role, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: RepositoriesMavenApi.add_role ...'
  end
  # verify the required parameter 'maven_maven_repository_href' is set
  if @api_client.config.client_side_validation && maven_maven_repository_href.nil?
    fail ArgumentError, "Missing the required parameter 'maven_maven_repository_href' when calling RepositoriesMavenApi.add_role"
  end
  # verify the required parameter 'nested_role' is set
  if @api_client.config.client_side_validation && nested_role.nil?
    fail ArgumentError, "Missing the required parameter 'nested_role' when calling RepositoriesMavenApi.add_role"
  end
  # resource path
  local_var_path = '{maven_maven_repository_href}add_role/'.sub('{' + 'maven_maven_repository_href' + '}', CGI.escape(maven_maven_repository_href.to_s).gsub('%2F', '/'))

  # 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']) unless header_params['Accept']
  # HTTP header 'Content-Type'
  content_type = @api_client.select_header_content_type(['application/json', 'application/x-www-form-urlencoded', 'multipart/form-data'])
  if !content_type.nil?
      header_params['Content-Type'] = content_type
  end
  header_params[:'X-Task-Diagnostics'] = @api_client.build_collection_param(opts[:'x_task_diagnostics'], :csv) if !opts[:'x_task_diagnostics'].nil?

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

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

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

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

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

#create(maven_maven_repository, opts = {}) ⇒ MavenMavenRepositoryResponse

Create a maven repository A ViewSet for MavenRepository.

Parameters:

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

    the optional parameters

Options Hash (opts):

  • :x_task_diagnostics (Array<String>) —

    List of profilers to use on tasks.

Returns:



105
106
107
108
 
# File 'lib/pulp_maven_client/api/repositories_maven_api.rb', line 105

def create(maven_maven_repository, opts = {})
  data, _status_code, _headers = create_with_http_info(maven_maven_repository, opts)
  data
end

#create_with_http_info(maven_maven_repository, opts = {}) ⇒ Array<(MavenMavenRepositoryResponse, Integer, Hash)>

Create a maven repository A ViewSet for MavenRepository.

Parameters:

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

    the optional parameters

Options Hash (opts):

  • :x_task_diagnostics (Array<String>) —

    List of profilers to use on tasks.

Returns:



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
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
 
# File 'lib/pulp_maven_client/api/repositories_maven_api.rb', line 116

def create_with_http_info(maven_maven_repository, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: RepositoriesMavenApi.create ...'
  end
  # verify the required parameter 'maven_maven_repository' is set
  if @api_client.config.client_side_validation && maven_maven_repository.nil?
    fail ArgumentError, "Missing the required parameter 'maven_maven_repository' when calling RepositoriesMavenApi.create"
  end
  # resource path
  local_var_path = '/pulp/api/v3/repositories/maven/maven/'

  # 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']) unless header_params['Accept']
  # HTTP header 'Content-Type'
  content_type = @api_client.select_header_content_type(['application/json', 'application/x-www-form-urlencoded', 'multipart/form-data'])
  if !content_type.nil?
      header_params['Content-Type'] = content_type
  end
  header_params[:'X-Task-Diagnostics'] = @api_client.build_collection_param(opts[:'x_task_diagnostics'], :csv) if !opts[:'x_task_diagnostics'].nil?

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

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

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

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

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

#delete(maven_maven_repository_href, opts = {}) ⇒ AsyncOperationResponse

Delete a maven repository Trigger an asynchronous delete task

Parameters:

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

    the optional parameters

Options Hash (opts):

  • :x_task_diagnostics (Array<String>) —

    List of profilers to use on tasks.

Returns:



176
177
178
179
 
# File 'lib/pulp_maven_client/api/repositories_maven_api.rb', line 176

def delete(maven_maven_repository_href, opts = {})
  data, _status_code, _headers = delete_with_http_info(maven_maven_repository_href, opts)
  data
end

#delete_with_http_info(maven_maven_repository_href, opts = {}) ⇒ Array<(AsyncOperationResponse, Integer, Hash)>

Delete a maven repository Trigger an asynchronous delete task

Parameters:

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

    the optional parameters

Options Hash (opts):

  • :x_task_diagnostics (Array<String>) —

    List of profilers to use on tasks.

Returns:

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

    AsyncOperationResponse data, response status code and response headers



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
226
227
228
229
230
231
232
233
234
 
# File 'lib/pulp_maven_client/api/repositories_maven_api.rb', line 187

def delete_with_http_info(maven_maven_repository_href, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: RepositoriesMavenApi.delete ...'
  end
  # verify the required parameter 'maven_maven_repository_href' is set
  if @api_client.config.client_side_validation && maven_maven_repository_href.nil?
    fail ArgumentError, "Missing the required parameter 'maven_maven_repository_href' when calling RepositoriesMavenApi.delete"
  end
  # resource path
  local_var_path = '{maven_maven_repository_href}'.sub('{' + 'maven_maven_repository_href' + '}', CGI.escape(maven_maven_repository_href.to_s).gsub('%2F', '/'))

  # 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']) unless header_params['Accept']
  header_params[:'X-Task-Diagnostics'] = @api_client.build_collection_param(opts[:'x_task_diagnostics'], :csv) if !opts[:'x_task_diagnostics'].nil?

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

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

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

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

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

#list(opts = {}) ⇒ PaginatedmavenMavenRepositoryResponseList

List maven repositorys A ViewSet for MavenRepository.

Parameters:

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

    the optional parameters

Options Hash (opts):

  • :x_task_diagnostics (Array<String>) —

    List of profilers to use on tasks.

  • :latest_with_content (String) —

    Content Unit referenced by HREF/PRN

  • :limit (Integer) —

    Number of results to return per page.

  • :name (String) —

    Filter results where name matches value

  • :name__contains (String) —

    Filter results where name contains value

  • :name__icontains (String) —

    Filter results where name contains value

  • :name__iexact (String) —

    Filter results where name matches value

  • :name__in (Array<String>) —

    Filter results where name is in a comma-separated list of values

  • :name__iregex (String) —

    Filter results where name matches regex value

  • :name__istartswith (String) —

    Filter results where name starts with value

  • :name__regex (String) —

    Filter results where name matches regex value

  • :name__startswith (String) —

    Filter results where name starts with value

  • :offset (Integer) —

    The initial index from which to return the results.

  • :ordering (Array<String>) —

    Ordering * `pulp_id` - Pulp id * `-pulp_id` - Pulp id (descending) * `pulp_created` - Pulp created * `-pulp_created` - Pulp created (descending) * `pulp_last_updated` - Pulp last updated * `-pulp_last_updated` - Pulp last updated (descending) * `pulp_type` - Pulp type * `-pulp_type` - Pulp type (descending) * `name` - Name * `-name` - Name (descending) * `pulp_labels` - Pulp labels * `-pulp_labels` - Pulp labels (descending) * `description` - Description * `-description` - Description (descending) * `next_version` - Next version * `-next_version` - Next version (descending) * `retain_repo_versions` - Retain repo versions * `-retain_repo_versions` - Retain repo versions (descending) * `retain_checkpoints` - Retain checkpoints * `-retain_checkpoints` - Retain checkpoints (descending) * `user_hidden` - User hidden * `-user_hidden` - User hidden (descending) * `pk` - Pk * `-pk` - Pk (descending)

  • :prn__in (Array<String>) —

    Multiple values may be separated by commas.

  • :pulp_href__in (Array<String>) —

    Multiple values may be separated by commas.

  • :pulp_id__in (Array<String>) —

    Multiple values may be separated by commas.

  • :pulp_label_select (String) —

    Filter labels by search string

  • :q (String) —

    Filter results by using NOT, AND and OR operations on other filters

  • :remote (String)
  • :retain_checkpoints (Integer) —

    Filter results where retain_checkpoints matches value

  • :retain_checkpoints__gt (Integer) —

    Filter results where retain_checkpoints is greater than value

  • :retain_checkpoints__gte (Integer) —

    Filter results where retain_checkpoints is greater than or equal to value

  • :retain_checkpoints__isnull (Boolean) —

    Filter results where retain_checkpoints has a null value

  • :retain_checkpoints__lt (Integer) —

    Filter results where retain_checkpoints is less than value

  • :retain_checkpoints__lte (Integer) —

    Filter results where retain_checkpoints is less than or equal to value

  • :retain_checkpoints__ne (Integer) —

    Filter results where retain_checkpoints not equal to value

  • :retain_checkpoints__range (Array<Integer>) —

    Filter results where retain_checkpoints is between two comma separated values

  • :retain_repo_versions (Integer) —

    Filter results where retain_repo_versions matches value

  • :retain_repo_versions__gt (Integer) —

    Filter results where retain_repo_versions is greater than value

  • :retain_repo_versions__gte (Integer) —

    Filter results where retain_repo_versions is greater than or equal to value

  • :retain_repo_versions__isnull (Boolean) —

    Filter results where retain_repo_versions has a null value

  • :retain_repo_versions__lt (Integer) —

    Filter results where retain_repo_versions is less than value

  • :retain_repo_versions__lte (Integer) —

    Filter results where retain_repo_versions is less than or equal to value

  • :retain_repo_versions__ne (Integer) —

    Filter results where retain_repo_versions not equal to value

  • :retain_repo_versions__range (Array<Integer>) —

    Filter results where retain_repo_versions is between two comma separated values

  • :with_content (String) —

    Content Unit referenced by HREF/PRN

  • :fields (Array<String>) —

    A list of fields to include in the response.

  • :exclude_fields (Array<String>) —

    A list of fields to exclude from the response.

Returns:



279
280
281
282
 
# File 'lib/pulp_maven_client/api/repositories_maven_api.rb', line 279

def list(opts = {})
  data, _status_code, _headers = list_with_http_info(opts)
  data
end

#list_roles(maven_maven_repository_href, opts = {}) ⇒ ObjectRolesResponse

List roles List roles assigned to this object.

Parameters:

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

    the optional parameters

Options Hash (opts):

  • :x_task_diagnostics (Array<String>) —

    List of profilers to use on tasks.

  • :fields (Array<String>) —

    A list of fields to include in the response.

  • :exclude_fields (Array<String>) —

    A list of fields to exclude from the response.

Returns:



422
423
424
425
 
# File 'lib/pulp_maven_client/api/repositories_maven_api.rb', line 422

def list_roles(maven_maven_repository_href, opts = {})
  data, _status_code, _headers = list_roles_with_http_info(maven_maven_repository_href, opts)
  data
end

#list_roles_with_http_info(maven_maven_repository_href, opts = {}) ⇒ Array<(ObjectRolesResponse, Integer, Hash)>

List roles List roles assigned to this object.

Parameters:

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

    the optional parameters

Options Hash (opts):

  • :x_task_diagnostics (Array<String>) —

    List of profilers to use on tasks.

  • :fields (Array<String>) —

    A list of fields to include in the response.

  • :exclude_fields (Array<String>) —

    A list of fields to exclude from the response.

Returns:

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

    ObjectRolesResponse data, response status code and response headers



435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
 
# File 'lib/pulp_maven_client/api/repositories_maven_api.rb', line 435

def list_roles_with_http_info(maven_maven_repository_href, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: RepositoriesMavenApi.list_roles ...'
  end
  # verify the required parameter 'maven_maven_repository_href' is set
  if @api_client.config.client_side_validation && maven_maven_repository_href.nil?
    fail ArgumentError, "Missing the required parameter 'maven_maven_repository_href' when calling RepositoriesMavenApi.list_roles"
  end
  # resource path
  local_var_path = '{maven_maven_repository_href}list_roles/'.sub('{' + 'maven_maven_repository_href' + '}', CGI.escape(maven_maven_repository_href.to_s).gsub('%2F', '/'))

  # query parameters
  query_params = opts[:query_params] || {}
  query_params[:'fields'] = @api_client.build_collection_param(opts[:'fields'], :multi) if !opts[:'fields'].nil?
  query_params[:'exclude_fields'] = @api_client.build_collection_param(opts[:'exclude_fields'], :multi) if !opts[:'exclude_fields'].nil?

  # header parameters
  header_params = opts[:header_params] || {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json']) unless header_params['Accept']
  header_params[:'X-Task-Diagnostics'] = @api_client.build_collection_param(opts[:'x_task_diagnostics'], :csv) if !opts[:'x_task_diagnostics'].nil?

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

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

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

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

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

#list_with_http_info(opts = {}) ⇒ Array<(PaginatedmavenMavenRepositoryResponseList, Integer, Hash)>

List maven repositorys A ViewSet for MavenRepository.

Parameters:

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

    the optional parameters

Options Hash (opts):

  • :x_task_diagnostics (Array<String>) —

    List of profilers to use on tasks.

  • :latest_with_content (String) —

    Content Unit referenced by HREF/PRN

  • :limit (Integer) —

    Number of results to return per page.

  • :name (String) —

    Filter results where name matches value

  • :name__contains (String) —

    Filter results where name contains value

  • :name__icontains (String) —

    Filter results where name contains value

  • :name__iexact (String) —

    Filter results where name matches value

  • :name__in (Array<String>) —

    Filter results where name is in a comma-separated list of values

  • :name__iregex (String) —

    Filter results where name matches regex value

  • :name__istartswith (String) —

    Filter results where name starts with value

  • :name__regex (String) —

    Filter results where name matches regex value

  • :name__startswith (String) —

    Filter results where name starts with value

  • :offset (Integer) —

    The initial index from which to return the results.

  • :ordering (Array<String>) —

    Ordering * `pulp_id` - Pulp id * `-pulp_id` - Pulp id (descending) * `pulp_created` - Pulp created * `-pulp_created` - Pulp created (descending) * `pulp_last_updated` - Pulp last updated * `-pulp_last_updated` - Pulp last updated (descending) * `pulp_type` - Pulp type * `-pulp_type` - Pulp type (descending) * `name` - Name * `-name` - Name (descending) * `pulp_labels` - Pulp labels * `-pulp_labels` - Pulp labels (descending) * `description` - Description * `-description` - Description (descending) * `next_version` - Next version * `-next_version` - Next version (descending) * `retain_repo_versions` - Retain repo versions * `-retain_repo_versions` - Retain repo versions (descending) * `retain_checkpoints` - Retain checkpoints * `-retain_checkpoints` - Retain checkpoints (descending) * `user_hidden` - User hidden * `-user_hidden` - User hidden (descending) * `pk` - Pk * `-pk` - Pk (descending)

  • :prn__in (Array<String>) —

    Multiple values may be separated by commas.

  • :pulp_href__in (Array<String>) —

    Multiple values may be separated by commas.

  • :pulp_id__in (Array<String>) —

    Multiple values may be separated by commas.

  • :pulp_label_select (String) —

    Filter labels by search string

  • :q (String) —

    Filter results by using NOT, AND and OR operations on other filters

  • :remote (String)
  • :retain_checkpoints (Integer) —

    Filter results where retain_checkpoints matches value

  • :retain_checkpoints__gt (Integer) —

    Filter results where retain_checkpoints is greater than value

  • :retain_checkpoints__gte (Integer) —

    Filter results where retain_checkpoints is greater than or equal to value

  • :retain_checkpoints__isnull (Boolean) —

    Filter results where retain_checkpoints has a null value

  • :retain_checkpoints__lt (Integer) —

    Filter results where retain_checkpoints is less than value

  • :retain_checkpoints__lte (Integer) —

    Filter results where retain_checkpoints is less than or equal to value

  • :retain_checkpoints__ne (Integer) —

    Filter results where retain_checkpoints not equal to value

  • :retain_checkpoints__range (Array<Integer>) —

    Filter results where retain_checkpoints is between two comma separated values

  • :retain_repo_versions (Integer) —

    Filter results where retain_repo_versions matches value

  • :retain_repo_versions__gt (Integer) —

    Filter results where retain_repo_versions is greater than value

  • :retain_repo_versions__gte (Integer) —

    Filter results where retain_repo_versions is greater than or equal to value

  • :retain_repo_versions__isnull (Boolean) —

    Filter results where retain_repo_versions has a null value

  • :retain_repo_versions__lt (Integer) —

    Filter results where retain_repo_versions is less than value

  • :retain_repo_versions__lte (Integer) —

    Filter results where retain_repo_versions is less than or equal to value

  • :retain_repo_versions__ne (Integer) —

    Filter results where retain_repo_versions not equal to value

  • :retain_repo_versions__range (Array<Integer>) —

    Filter results where retain_repo_versions is between two comma separated values

  • :with_content (String) —

    Content Unit referenced by HREF/PRN

  • :fields (Array<String>) —

    A list of fields to include in the response.

  • :exclude_fields (Array<String>) —

    A list of fields to exclude from the response.

Returns:



327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
 
# File 'lib/pulp_maven_client/api/repositories_maven_api.rb', line 327

def list_with_http_info(opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: RepositoriesMavenApi.list ...'
  end
  allowable_values = ["-description", "-name", "-next_version", "-pk", "-pulp_created", "-pulp_id", "-pulp_labels", "-pulp_last_updated", "-pulp_type", "-retain_checkpoints", "-retain_repo_versions", "-user_hidden", "description", "name", "next_version", "pk", "pulp_created", "pulp_id", "pulp_labels", "pulp_last_updated", "pulp_type", "retain_checkpoints", "retain_repo_versions", "user_hidden"]
  if @api_client.config.client_side_validation && opts[:'ordering'] && !opts[:'ordering'].all? { |item| allowable_values.include?(item) }
    fail ArgumentError, "invalid value for \"ordering\", must include one of #{allowable_values}"
  end
  # resource path
  local_var_path = '/pulp/api/v3/repositories/maven/maven/'

  # query parameters
  query_params = opts[:query_params] || {}
  query_params[:'latest_with_content'] = opts[:'latest_with_content'] if !opts[:'latest_with_content'].nil?
  query_params[:'limit'] = opts[:'limit'] if !opts[:'limit'].nil?
  query_params[:'name'] = opts[:'name'] if !opts[:'name'].nil?
  query_params[:'name__contains'] = opts[:'name__contains'] if !opts[:'name__contains'].nil?
  query_params[:'name__icontains'] = opts[:'name__icontains'] if !opts[:'name__icontains'].nil?
  query_params[:'name__iexact'] = opts[:'name__iexact'] if !opts[:'name__iexact'].nil?
  query_params[:'name__in'] = @api_client.build_collection_param(opts[:'name__in'], :csv) if !opts[:'name__in'].nil?
  query_params[:'name__iregex'] = opts[:'name__iregex'] if !opts[:'name__iregex'].nil?
  query_params[:'name__istartswith'] = opts[:'name__istartswith'] if !opts[:'name__istartswith'].nil?
  query_params[:'name__regex'] = opts[:'name__regex'] if !opts[:'name__regex'].nil?
  query_params[:'name__startswith'] = opts[:'name__startswith'] if !opts[:'name__startswith'].nil?
  query_params[:'offset'] = opts[:'offset'] if !opts[:'offset'].nil?
  query_params[:'ordering'] = @api_client.build_collection_param(opts[:'ordering'], :csv) if !opts[:'ordering'].nil?
  query_params[:'prn__in'] = @api_client.build_collection_param(opts[:'prn__in'], :csv) if !opts[:'prn__in'].nil?
  query_params[:'pulp_href__in'] = @api_client.build_collection_param(opts[:'pulp_href__in'], :csv) if !opts[:'pulp_href__in'].nil?
  query_params[:'pulp_id__in'] = @api_client.build_collection_param(opts[:'pulp_id__in'], :csv) if !opts[:'pulp_id__in'].nil?
  query_params[:'pulp_label_select'] = opts[:'pulp_label_select'] if !opts[:'pulp_label_select'].nil?
  query_params[:'q'] = opts[:'q'] if !opts[:'q'].nil?
  query_params[:'remote'] = opts[:'remote'] if !opts[:'remote'].nil?
  query_params[:'retain_checkpoints'] = opts[:'retain_checkpoints'] if !opts[:'retain_checkpoints'].nil?
  query_params[:'retain_checkpoints__gt'] = opts[:'retain_checkpoints__gt'] if !opts[:'retain_checkpoints__gt'].nil?
  query_params[:'retain_checkpoints__gte'] = opts[:'retain_checkpoints__gte'] if !opts[:'retain_checkpoints__gte'].nil?
  query_params[:'retain_checkpoints__isnull'] = opts[:'retain_checkpoints__isnull'] if !opts[:'retain_checkpoints__isnull'].nil?
  query_params[:'retain_checkpoints__lt'] = opts[:'retain_checkpoints__lt'] if !opts[:'retain_checkpoints__lt'].nil?
  query_params[:'retain_checkpoints__lte'] = opts[:'retain_checkpoints__lte'] if !opts[:'retain_checkpoints__lte'].nil?
  query_params[:'retain_checkpoints__ne'] = opts[:'retain_checkpoints__ne'] if !opts[:'retain_checkpoints__ne'].nil?
  query_params[:'retain_checkpoints__range'] = @api_client.build_collection_param(opts[:'retain_checkpoints__range'], :csv) if !opts[:'retain_checkpoints__range'].nil?
  query_params[:'retain_repo_versions'] = opts[:'retain_repo_versions'] if !opts[:'retain_repo_versions'].nil?
  query_params[:'retain_repo_versions__gt'] = opts[:'retain_repo_versions__gt'] if !opts[:'retain_repo_versions__gt'].nil?
  query_params[:'retain_repo_versions__gte'] = opts[:'retain_repo_versions__gte'] if !opts[:'retain_repo_versions__gte'].nil?
  query_params[:'retain_repo_versions__isnull'] = opts[:'retain_repo_versions__isnull'] if !opts[:'retain_repo_versions__isnull'].nil?
  query_params[:'retain_repo_versions__lt'] = opts[:'retain_repo_versions__lt'] if !opts[:'retain_repo_versions__lt'].nil?
  query_params[:'retain_repo_versions__lte'] = opts[:'retain_repo_versions__lte'] if !opts[:'retain_repo_versions__lte'].nil?
  query_params[:'retain_repo_versions__ne'] = opts[:'retain_repo_versions__ne'] if !opts[:'retain_repo_versions__ne'].nil?
  query_params[:'retain_repo_versions__range'] = @api_client.build_collection_param(opts[:'retain_repo_versions__range'], :csv) if !opts[:'retain_repo_versions__range'].nil?
  query_params[:'with_content'] = opts[:'with_content'] if !opts[:'with_content'].nil?
  query_params[:'fields'] = @api_client.build_collection_param(opts[:'fields'], :multi) if !opts[:'fields'].nil?
  query_params[:'exclude_fields'] = @api_client.build_collection_param(opts[:'exclude_fields'], :multi) if !opts[:'exclude_fields'].nil?

  # header parameters
  header_params = opts[:header_params] || {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json']) unless header_params['Accept']
  header_params[:'X-Task-Diagnostics'] = @api_client.build_collection_param(opts[:'x_task_diagnostics'], :csv) if !opts[:'x_task_diagnostics'].nil?

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

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

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

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

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

#metrics(maven_maven_repository_href, opts = {}) ⇒ MavenRepositoryMetricsResponse

Repository metrics Distinct counts for MavenPackage content in a repository version (latest complete version if repository_version is omitted). package_count is distinct (group_id, artifact_id). version_count is distinct (group_id, artifact_id, base_version) after rebuild-suffix strip. build_count is distinct (group_id, artifact_id, full version). Counts use MavenPackage (POM-backed GAV), not MavenArtifact files.

Parameters:

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

    the optional parameters

Options Hash (opts):

  • :x_task_diagnostics (Array<String>) —

    List of profilers to use on tasks.

  • :repository_version (String) —

    HREF or PRN of a version of this repository. Defaults to the latest complete version.

  • :fields (Array<String>) —

    A list of fields to include in the response.

  • :exclude_fields (Array<String>) —

    A list of fields to exclude from the response.

Returns:



495
496
497
498
 
# File 'lib/pulp_maven_client/api/repositories_maven_api.rb', line 495

def metrics(maven_maven_repository_href, opts = {})
  data, _status_code, _headers = metrics_with_http_info(maven_maven_repository_href, opts)
  data
end

#metrics_with_http_info(maven_maven_repository_href, opts = {}) ⇒ Array<(MavenRepositoryMetricsResponse, Integer, Hash)>

Repository metrics Distinct counts for MavenPackage content in a repository version (latest complete version if repository_version is omitted). package_count is distinct (group_id, artifact_id). version_count is distinct (group_id, artifact_id, base_version) after rebuild-suffix strip. build_count is distinct (group_id, artifact_id, full version). Counts use MavenPackage (POM-backed GAV), not MavenArtifact files.

Parameters:

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

    the optional parameters

Options Hash (opts):

  • :x_task_diagnostics (Array<String>) —

    List of profilers to use on tasks.

  • :repository_version (String) —

    HREF or PRN of a version of this repository. Defaults to the latest complete version.

  • :fields (Array<String>) —

    A list of fields to include in the response.

  • :exclude_fields (Array<String>) —

    A list of fields to exclude from the response.

Returns:



509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
 
# File 'lib/pulp_maven_client/api/repositories_maven_api.rb', line 509

def metrics_with_http_info(maven_maven_repository_href, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: RepositoriesMavenApi.metrics ...'
  end
  # verify the required parameter 'maven_maven_repository_href' is set
  if @api_client.config.client_side_validation && maven_maven_repository_href.nil?
    fail ArgumentError, "Missing the required parameter 'maven_maven_repository_href' when calling RepositoriesMavenApi.metrics"
  end
  # resource path
  local_var_path = '{maven_maven_repository_href}metrics/'.sub('{' + 'maven_maven_repository_href' + '}', CGI.escape(maven_maven_repository_href.to_s).gsub('%2F', '/'))

  # query parameters
  query_params = opts[:query_params] || {}
  query_params[:'repository_version'] = opts[:'repository_version'] if !opts[:'repository_version'].nil?
  query_params[:'fields'] = @api_client.build_collection_param(opts[:'fields'], :multi) if !opts[:'fields'].nil?
  query_params[:'exclude_fields'] = @api_client.build_collection_param(opts[:'exclude_fields'], :multi) if !opts[:'exclude_fields'].nil?

  # header parameters
  header_params = opts[:header_params] || {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json']) unless header_params['Accept']
  header_params[:'X-Task-Diagnostics'] = @api_client.build_collection_param(opts[:'x_task_diagnostics'], :csv) if !opts[:'x_task_diagnostics'].nil?

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

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

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

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

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

#modify(maven_maven_repository_href, repository_add_remove_content, opts = {}) ⇒ AsyncOperationResponse

Modify Repository Content Trigger an asynchronous task to create a new repository version.

Parameters:

  • maven_maven_repository_href (String)
  • repository_add_remove_content (RepositoryAddRemoveContent)
  • opts (Hash) (defaults to: {}) —

    the optional parameters

Options Hash (opts):

  • :x_task_diagnostics (Array<String>) —

    List of profilers to use on tasks.

Returns:



568
569
570
571
 
# File 'lib/pulp_maven_client/api/repositories_maven_api.rb', line 568

def modify(maven_maven_repository_href, repository_add_remove_content, opts = {})
  data, _status_code, _headers = modify_with_http_info(maven_maven_repository_href, repository_add_remove_content, opts)
  data
end

#modify_with_http_info(maven_maven_repository_href, repository_add_remove_content, opts = {}) ⇒ Array<(AsyncOperationResponse, Integer, Hash)>

Modify Repository Content Trigger an asynchronous task to create a new repository version.

Parameters:

  • maven_maven_repository_href (String)
  • repository_add_remove_content (RepositoryAddRemoveContent)
  • opts (Hash) (defaults to: {}) —

    the optional parameters

Options Hash (opts):

  • :x_task_diagnostics (Array<String>) —

    List of profilers to use on tasks.

Returns:

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

    AsyncOperationResponse data, response status code and response headers



580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
 
# File 'lib/pulp_maven_client/api/repositories_maven_api.rb', line 580

def modify_with_http_info(maven_maven_repository_href, repository_add_remove_content, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: RepositoriesMavenApi.modify ...'
  end
  # verify the required parameter 'maven_maven_repository_href' is set
  if @api_client.config.client_side_validation && maven_maven_repository_href.nil?
    fail ArgumentError, "Missing the required parameter 'maven_maven_repository_href' when calling RepositoriesMavenApi.modify"
  end
  # verify the required parameter 'repository_add_remove_content' is set
  if @api_client.config.client_side_validation && repository_add_remove_content.nil?
    fail ArgumentError, "Missing the required parameter 'repository_add_remove_content' when calling RepositoriesMavenApi.modify"
  end
  # resource path
  local_var_path = '{maven_maven_repository_href}modify/'.sub('{' + 'maven_maven_repository_href' + '}', CGI.escape(maven_maven_repository_href.to_s).gsub('%2F', '/'))

  # 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']) unless header_params['Accept']
  # HTTP header 'Content-Type'
  content_type = @api_client.select_header_content_type(['application/json', 'application/x-www-form-urlencoded', 'multipart/form-data'])
  if !content_type.nil?
      header_params['Content-Type'] = content_type
  end
  header_params[:'X-Task-Diagnostics'] = @api_client.build_collection_param(opts[:'x_task_diagnostics'], :csv) if !opts[:'x_task_diagnostics'].nil?

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

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

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

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

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

#my_permissions(maven_maven_repository_href, opts = {}) ⇒ MyPermissionsResponse

List user permissions List permissions available to the current user on this object.

Parameters:

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

    the optional parameters

Options Hash (opts):

  • :x_task_diagnostics (Array<String>) —

    List of profilers to use on tasks.

  • :fields (Array<String>) —

    A list of fields to include in the response.

  • :exclude_fields (Array<String>) —

    A list of fields to exclude from the response.

Returns:



646
647
648
649
 
# File 'lib/pulp_maven_client/api/repositories_maven_api.rb', line 646

def my_permissions(maven_maven_repository_href, opts = {})
  data, _status_code, _headers = my_permissions_with_http_info(maven_maven_repository_href, opts)
  data
end

#my_permissions_with_http_info(maven_maven_repository_href, opts = {}) ⇒ Array<(MyPermissionsResponse, Integer, Hash)>

List user permissions List permissions available to the current user on this object.

Parameters:

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

    the optional parameters

Options Hash (opts):

  • :x_task_diagnostics (Array<String>) —

    List of profilers to use on tasks.

  • :fields (Array<String>) —

    A list of fields to include in the response.

  • :exclude_fields (Array<String>) —

    A list of fields to exclude from the response.

Returns:

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

    MyPermissionsResponse data, response status code and response headers



659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
 
# File 'lib/pulp_maven_client/api/repositories_maven_api.rb', line 659

def my_permissions_with_http_info(maven_maven_repository_href, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: RepositoriesMavenApi.my_permissions ...'
  end
  # verify the required parameter 'maven_maven_repository_href' is set
  if @api_client.config.client_side_validation && maven_maven_repository_href.nil?
    fail ArgumentError, "Missing the required parameter 'maven_maven_repository_href' when calling RepositoriesMavenApi.my_permissions"
  end
  # resource path
  local_var_path = '{maven_maven_repository_href}my_permissions/'.sub('{' + 'maven_maven_repository_href' + '}', CGI.escape(maven_maven_repository_href.to_s).gsub('%2F', '/'))

  # query parameters
  query_params = opts[:query_params] || {}
  query_params[:'fields'] = @api_client.build_collection_param(opts[:'fields'], :multi) if !opts[:'fields'].nil?
  query_params[:'exclude_fields'] = @api_client.build_collection_param(opts[:'exclude_fields'], :multi) if !opts[:'exclude_fields'].nil?

  # header parameters
  header_params = opts[:header_params] || {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json']) unless header_params['Accept']
  header_params[:'X-Task-Diagnostics'] = @api_client.build_collection_param(opts[:'x_task_diagnostics'], :csv) if !opts[:'x_task_diagnostics'].nil?

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

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

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

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

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

#packages(maven_maven_repository_href, opts = {}) ⇒ PaginatedMavenRepositoryPackageListResponse

List packages Return one row per distinct (group_id, artifact_id) in a repository version (latest complete version if repository_version is omitted). Pagination count is the number of distinct packages, not GAVs. Each row includes last_updated (newest membership among any rebuild), versions (logical version keys after rebuild-suffix strip, newest first), and latest_releases (newest rebuild per logical version, same order). set(versions) === set(latest_releases.version).

Parameters:

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

    the optional parameters

Options Hash (opts):

  • :x_task_diagnostics (Array<String>) —

    List of profilers to use on tasks.

  • :artifact_id__istartswith (String) —

    Case-insensitive prefix on artifact_id.

  • :group_id__istartswith (String) —

    Case-insensitive prefix on group_id.

  • :limit (Integer) —

    Number of results to return per page.

  • :offset (Integer) —

    The initial index from which to return the results.

  • :ordering (Array<String>) —

    Order catalog rows. Allowed: group_id, artifact_id, last_updated. Prefix with '-' for descending. Default is group_id, artifact_id. Ordering by group_id without artifact_id also sorts by artifact_id.

  • :repository_version (String) —

    HREF or PRN of a version of this repository. Defaults to the latest complete version.

  • :search (String) —

    Case-insensitive package search. Without ':', group_id or artifact_id contains the term (OR). With ':', group_id contains the left part AND artifact_id contains the right part. A third ':' segment (version) is ignored. Empty or ':' is a no-op. Combines with prefix filters using AND.

  • :fields (Array<String>) —

    A list of fields to include in the response.

  • :exclude_fields (Array<String>) —

    A list of fields to exclude from the response.

Returns:



725
726
727
728
 
# File 'lib/pulp_maven_client/api/repositories_maven_api.rb', line 725

def packages(maven_maven_repository_href, opts = {})
  data, _status_code, _headers = packages_with_http_info(maven_maven_repository_href, opts)
  data
end

#packages_with_http_info(maven_maven_repository_href, opts = {}) ⇒ Array<(PaginatedMavenRepositoryPackageListResponse, Integer, Hash)>

List packages Return one row per distinct (group_id, artifact_id) in a repository version (latest complete version if repository_version is omitted). Pagination count is the number of distinct packages, not GAVs. Each row includes last_updated (newest membership among any rebuild), versions (logical version keys after rebuild-suffix strip, newest first), and latest_releases (newest rebuild per logical version, same order). set(versions) === set(latest_releases.version).

Parameters:

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

    the optional parameters

Options Hash (opts):

  • :x_task_diagnostics (Array<String>) —

    List of profilers to use on tasks.

  • :artifact_id__istartswith (String) —

    Case-insensitive prefix on artifact_id.

  • :group_id__istartswith (String) —

    Case-insensitive prefix on group_id.

  • :limit (Integer) —

    Number of results to return per page.

  • :offset (Integer) —

    The initial index from which to return the results.

  • :ordering (Array<String>) —

    Order catalog rows. Allowed: group_id, artifact_id, last_updated. Prefix with '-' for descending. Default is group_id, artifact_id. Ordering by group_id without artifact_id also sorts by artifact_id.

  • :repository_version (String) —

    HREF or PRN of a version of this repository. Defaults to the latest complete version.

  • :search (String) —

    Case-insensitive package search. Without ':', group_id or artifact_id contains the term (OR). With ':', group_id contains the left part AND artifact_id contains the right part. A third ':' segment (version) is ignored. Empty or ':' is a no-op. Combines with prefix filters using AND.

  • :fields (Array<String>) —

    A list of fields to include in the response.

  • :exclude_fields (Array<String>) —

    A list of fields to exclude from the response.

Returns:



745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
 
# File 'lib/pulp_maven_client/api/repositories_maven_api.rb', line 745

def packages_with_http_info(maven_maven_repository_href, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: RepositoriesMavenApi.packages ...'
  end
  # verify the required parameter 'maven_maven_repository_href' is set
  if @api_client.config.client_side_validation && maven_maven_repository_href.nil?
    fail ArgumentError, "Missing the required parameter 'maven_maven_repository_href' when calling RepositoriesMavenApi.packages"
  end
  # resource path
  local_var_path = '{maven_maven_repository_href}packages/'.sub('{' + 'maven_maven_repository_href' + '}', CGI.escape(maven_maven_repository_href.to_s).gsub('%2F', '/'))

  # query parameters
  query_params = opts[:query_params] || {}
  query_params[:'artifact_id__istartswith'] = opts[:'artifact_id__istartswith'] if !opts[:'artifact_id__istartswith'].nil?
  query_params[:'group_id__istartswith'] = opts[:'group_id__istartswith'] if !opts[:'group_id__istartswith'].nil?
  query_params[:'limit'] = opts[:'limit'] if !opts[:'limit'].nil?
  query_params[:'offset'] = opts[:'offset'] if !opts[:'offset'].nil?
  query_params[:'ordering'] = @api_client.build_collection_param(opts[:'ordering'], :multi) if !opts[:'ordering'].nil?
  query_params[:'repository_version'] = opts[:'repository_version'] if !opts[:'repository_version'].nil?
  query_params[:'search'] = opts[:'search'] if !opts[:'search'].nil?
  query_params[:'fields'] = @api_client.build_collection_param(opts[:'fields'], :multi) if !opts[:'fields'].nil?
  query_params[:'exclude_fields'] = @api_client.build_collection_param(opts[:'exclude_fields'], :multi) if !opts[:'exclude_fields'].nil?

  # header parameters
  header_params = opts[:header_params] || {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json']) unless header_params['Accept']
  header_params[:'X-Task-Diagnostics'] = @api_client.build_collection_param(opts[:'x_task_diagnostics'], :csv) if !opts[:'x_task_diagnostics'].nil?

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

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

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

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

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

#partial_update(maven_maven_repository_href, patchedmaven_maven_repository, opts = {}) ⇒ MavenMavenRepositoryResponse

Update a maven repository Update the entity partially and trigger an asynchronous task if necessary

Parameters:

  • maven_maven_repository_href (String)
  • patchedmaven_maven_repository (PatchedmavenMavenRepository)
  • opts (Hash) (defaults to: {}) —

    the optional parameters

Options Hash (opts):

  • :x_task_diagnostics (Array<String>) —

    List of profilers to use on tasks.

Returns:



810
811
812
813
 
# File 'lib/pulp_maven_client/api/repositories_maven_api.rb', line 810

def partial_update(maven_maven_repository_href, patchedmaven_maven_repository, opts = {})
  data, _status_code, _headers = partial_update_with_http_info(maven_maven_repository_href, patchedmaven_maven_repository, opts)
  data
end

#partial_update_with_http_info(maven_maven_repository_href, patchedmaven_maven_repository, opts = {}) ⇒ Array<(MavenMavenRepositoryResponse, Integer, Hash)>

Update a maven repository Update the entity partially and trigger an asynchronous task if necessary

Parameters:

  • maven_maven_repository_href (String)
  • patchedmaven_maven_repository (PatchedmavenMavenRepository)
  • opts (Hash) (defaults to: {}) —

    the optional parameters

Options Hash (opts):

  • :x_task_diagnostics (Array<String>) —

    List of profilers to use on tasks.

Returns:



822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
862
863
864
865
866
867
868
869
870
871
872
873
874
875
876
877
878
 
# File 'lib/pulp_maven_client/api/repositories_maven_api.rb', line 822

def partial_update_with_http_info(maven_maven_repository_href, patchedmaven_maven_repository, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: RepositoriesMavenApi.partial_update ...'
  end
  # verify the required parameter 'maven_maven_repository_href' is set
  if @api_client.config.client_side_validation && maven_maven_repository_href.nil?
    fail ArgumentError, "Missing the required parameter 'maven_maven_repository_href' when calling RepositoriesMavenApi.partial_update"
  end
  # verify the required parameter 'patchedmaven_maven_repository' is set
  if @api_client.config.client_side_validation && patchedmaven_maven_repository.nil?
    fail ArgumentError, "Missing the required parameter 'patchedmaven_maven_repository' when calling RepositoriesMavenApi.partial_update"
  end
  # resource path
  local_var_path = '{maven_maven_repository_href}'.sub('{' + 'maven_maven_repository_href' + '}', CGI.escape(maven_maven_repository_href.to_s).gsub('%2F', '/'))

  # 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']) unless header_params['Accept']
  # HTTP header 'Content-Type'
  content_type = @api_client.select_header_content_type(['application/json', 'application/x-www-form-urlencoded', 'multipart/form-data'])
  if !content_type.nil?
      header_params['Content-Type'] = content_type
  end
  header_params[:'X-Task-Diagnostics'] = @api_client.build_collection_param(opts[:'x_task_diagnostics'], :csv) if !opts[:'x_task_diagnostics'].nil?

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

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

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

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

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

#read(maven_maven_repository_href, opts = {}) ⇒ MavenMavenRepositoryResponse

Inspect a maven repository A ViewSet for MavenRepository.

Parameters:

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

    the optional parameters

Options Hash (opts):

  • :x_task_diagnostics (Array<String>) —

    List of profilers to use on tasks.

  • :fields (Array<String>) —

    A list of fields to include in the response.

  • :exclude_fields (Array<String>) —

    A list of fields to exclude from the response.

Returns:



888
889
890
891
 
# File 'lib/pulp_maven_client/api/repositories_maven_api.rb', line 888

def read(maven_maven_repository_href, opts = {})
  data, _status_code, _headers = read_with_http_info(maven_maven_repository_href, opts)
  data
end

#read_with_http_info(maven_maven_repository_href, opts = {}) ⇒ Array<(MavenMavenRepositoryResponse, Integer, Hash)>

Inspect a maven repository A ViewSet for MavenRepository.

Parameters:

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

    the optional parameters

Options Hash (opts):

  • :x_task_diagnostics (Array<String>) —

    List of profilers to use on tasks.

  • :fields (Array<String>) —

    A list of fields to include in the response.

  • :exclude_fields (Array<String>) —

    A list of fields to exclude from the response.

Returns:



901
902
903
904
905
906
907
908
909
910
911
912
913
914
915
916
917
918
919
920
921
922
923
924
925
926
927
928
929
930
931
932
933
934
935
936
937
938
939
940
941
942
943
944
945
946
947
948
949
950
 
# File 'lib/pulp_maven_client/api/repositories_maven_api.rb', line 901

def read_with_http_info(maven_maven_repository_href, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: RepositoriesMavenApi.read ...'
  end
  # verify the required parameter 'maven_maven_repository_href' is set
  if @api_client.config.client_side_validation && maven_maven_repository_href.nil?
    fail ArgumentError, "Missing the required parameter 'maven_maven_repository_href' when calling RepositoriesMavenApi.read"
  end
  # resource path
  local_var_path = '{maven_maven_repository_href}'.sub('{' + 'maven_maven_repository_href' + '}', CGI.escape(maven_maven_repository_href.to_s).gsub('%2F', '/'))

  # query parameters
  query_params = opts[:query_params] || {}
  query_params[:'fields'] = @api_client.build_collection_param(opts[:'fields'], :multi) if !opts[:'fields'].nil?
  query_params[:'exclude_fields'] = @api_client.build_collection_param(opts[:'exclude_fields'], :multi) if !opts[:'exclude_fields'].nil?

  # header parameters
  header_params = opts[:header_params] || {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json']) unless header_params['Accept']
  header_params[:'X-Task-Diagnostics'] = @api_client.build_collection_param(opts[:'x_task_diagnostics'], :csv) if !opts[:'x_task_diagnostics'].nil?

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

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

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

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

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

#remove_role(maven_maven_repository_href, nested_role, opts = {}) ⇒ NestedRoleResponse

Remove a role Remove a role for this object from users/groups.

Parameters:

  • maven_maven_repository_href (String)
  • nested_role (NestedRole)
  • opts (Hash) (defaults to: {}) —

    the optional parameters

Options Hash (opts):

  • :x_task_diagnostics (Array<String>) —

    List of profilers to use on tasks.

Returns:



959
960
961
962
 
# File 'lib/pulp_maven_client/api/repositories_maven_api.rb', line 959

def remove_role(maven_maven_repository_href, nested_role, opts = {})
  data, _status_code, _headers = remove_role_with_http_info(maven_maven_repository_href, nested_role, opts)
  data
end

#remove_role_with_http_info(maven_maven_repository_href, nested_role, opts = {}) ⇒ Array<(NestedRoleResponse, Integer, Hash)>

Remove a role Remove a role for this object from users/groups.

Parameters:

  • maven_maven_repository_href (String)
  • nested_role (NestedRole)
  • opts (Hash) (defaults to: {}) —

    the optional parameters

Options Hash (opts):

  • :x_task_diagnostics (Array<String>) —

    List of profilers to use on tasks.

Returns:

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

    NestedRoleResponse data, response status code and response headers



971
972
973
974
975
976
977
978
979
980
981
982
983
984
985
986
987
988
989
990
991
992
993
994
995
996
997
998
999
1000
1001
1002
1003
1004
1005
1006
1007
1008
1009
1010
1011
1012
1013
1014
1015
1016
1017
1018
1019
1020
1021
1022
1023
1024
1025
1026
1027
 
# File 'lib/pulp_maven_client/api/repositories_maven_api.rb', line 971

def remove_role_with_http_info(maven_maven_repository_href, nested_role, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: RepositoriesMavenApi.remove_role ...'
  end
  # verify the required parameter 'maven_maven_repository_href' is set
  if @api_client.config.client_side_validation && maven_maven_repository_href.nil?
    fail ArgumentError, "Missing the required parameter 'maven_maven_repository_href' when calling RepositoriesMavenApi.remove_role"
  end
  # verify the required parameter 'nested_role' is set
  if @api_client.config.client_side_validation && nested_role.nil?
    fail ArgumentError, "Missing the required parameter 'nested_role' when calling RepositoriesMavenApi.remove_role"
  end
  # resource path
  local_var_path = '{maven_maven_repository_href}remove_role/'.sub('{' + 'maven_maven_repository_href' + '}', CGI.escape(maven_maven_repository_href.to_s).gsub('%2F', '/'))

  # 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']) unless header_params['Accept']
  # HTTP header 'Content-Type'
  content_type = @api_client.select_header_content_type(['application/json', 'application/x-www-form-urlencoded', 'multipart/form-data'])
  if !content_type.nil?
      header_params['Content-Type'] = content_type
  end
  header_params[:'X-Task-Diagnostics'] = @api_client.build_collection_param(opts[:'x_task_diagnostics'], :csv) if !opts[:'x_task_diagnostics'].nil?

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

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

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

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

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

#repair_index_pages(maven_maven_repository_href, opts = {}) ⇒ AsyncOperationResponse

Repair index pages Trigger an asynchronous task to generate (or regenerate) HTML directory index pages for every directory in the latest repository version. This is a one-time catch-up for repositories created before the pre-generation feature was deployed. After the task completes every directory URL will be served by a pre-generated page rather than the on-demand fallback.

Parameters:

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

    the optional parameters

Options Hash (opts):

  • :x_task_diagnostics (Array<String>) —

    List of profilers to use on tasks.

Returns:



1035
1036
1037
1038
 
# File 'lib/pulp_maven_client/api/repositories_maven_api.rb', line 1035

def repair_index_pages(maven_maven_repository_href, opts = {})
  data, _status_code, _headers = repair_index_pages_with_http_info(maven_maven_repository_href, opts)
  data
end

#repair_index_pages_with_http_info(maven_maven_repository_href, opts = {}) ⇒ Array<(AsyncOperationResponse, Integer, Hash)>

Repair index pages Trigger an asynchronous task to generate (or regenerate) HTML directory index pages for every directory in the latest repository version. This is a one-time catch-up for repositories created before the pre-generation feature was deployed. After the task completes every directory URL will be served by a pre-generated page rather than the on-demand fallback.

Parameters:

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

    the optional parameters

Options Hash (opts):

  • :x_task_diagnostics (Array<String>) —

    List of profilers to use on tasks.

Returns:

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

    AsyncOperationResponse data, response status code and response headers



1046
1047
1048
1049
1050
1051
1052
1053
1054
1055
1056
1057
1058
1059
1060
1061
1062
1063
1064
1065
1066
1067
1068
1069
1070
1071
1072
1073
1074
1075
1076
1077
1078
1079
1080
1081
1082
1083
1084
1085
1086
1087
1088
1089
1090
1091
1092
1093
 
# File 'lib/pulp_maven_client/api/repositories_maven_api.rb', line 1046

def repair_index_pages_with_http_info(maven_maven_repository_href, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: RepositoriesMavenApi.repair_index_pages ...'
  end
  # verify the required parameter 'maven_maven_repository_href' is set
  if @api_client.config.client_side_validation && maven_maven_repository_href.nil?
    fail ArgumentError, "Missing the required parameter 'maven_maven_repository_href' when calling RepositoriesMavenApi.repair_index_pages"
  end
  # resource path
  local_var_path = '{maven_maven_repository_href}repair_index_pages/'.sub('{' + 'maven_maven_repository_href' + '}', CGI.escape(maven_maven_repository_href.to_s).gsub('%2F', '/'))

  # 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']) unless header_params['Accept']
  header_params[:'X-Task-Diagnostics'] = @api_client.build_collection_param(opts[:'x_task_diagnostics'], :csv) if !opts[:'x_task_diagnostics'].nil?

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

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

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

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

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

#repair_metadata(maven_maven_repository_href, opts = {}) ⇒ AsyncOperationResponse

Repair metadata Trigger an asynchronous task to regenerate all maven-metadata.xml files and their checksums for every artifact in the repository.

Parameters:

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

    the optional parameters

Options Hash (opts):

  • :x_task_diagnostics (Array<String>) —

    List of profilers to use on tasks.

Returns:



1101
1102
1103
1104
 
# File 'lib/pulp_maven_client/api/repositories_maven_api.rb', line 1101

def repair_metadata(maven_maven_repository_href, opts = {})
  data, _status_code, _headers = repair_metadata_with_http_info(maven_maven_repository_href, opts)
  data
end

#repair_metadata_with_http_info(maven_maven_repository_href, opts = {}) ⇒ Array<(AsyncOperationResponse, Integer, Hash)>

Repair metadata Trigger an asynchronous task to regenerate all maven-metadata.xml files and their checksums for every artifact in the repository.

Parameters:

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

    the optional parameters

Options Hash (opts):

  • :x_task_diagnostics (Array<String>) —

    List of profilers to use on tasks.

Returns:

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

    AsyncOperationResponse data, response status code and response headers



1112
1113
1114
1115
1116
1117
1118
1119
1120
1121
1122
1123
1124
1125
1126
1127
1128
1129
1130
1131
1132
1133
1134
1135
1136
1137
1138
1139
1140
1141
1142
1143
1144
1145
1146
1147
1148
1149
1150
1151
1152
1153
1154
1155
1156
1157
1158
1159
 
# File 'lib/pulp_maven_client/api/repositories_maven_api.rb', line 1112

def repair_metadata_with_http_info(maven_maven_repository_href, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: RepositoriesMavenApi.repair_metadata ...'
  end
  # verify the required parameter 'maven_maven_repository_href' is set
  if @api_client.config.client_side_validation && maven_maven_repository_href.nil?
    fail ArgumentError, "Missing the required parameter 'maven_maven_repository_href' when calling RepositoriesMavenApi.repair_metadata"
  end
  # resource path
  local_var_path = '{maven_maven_repository_href}repair_metadata/'.sub('{' + 'maven_maven_repository_href' + '}', CGI.escape(maven_maven_repository_href.to_s).gsub('%2F', '/'))

  # 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']) unless header_params['Accept']
  header_params[:'X-Task-Diagnostics'] = @api_client.build_collection_param(opts[:'x_task_diagnostics'], :csv) if !opts[:'x_task_diagnostics'].nil?

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

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

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

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

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

#set_label(maven_maven_repository_href, set_label, opts = {}) ⇒ SetLabelResponse

Set a label Set a single pulp_label on the object to a specific value or null.

Parameters:

  • maven_maven_repository_href (String)
  • set_label (SetLabel)
  • opts (Hash) (defaults to: {}) —

    the optional parameters

Options Hash (opts):

  • :x_task_diagnostics (Array<String>) —

    List of profilers to use on tasks.

Returns:



1168
1169
1170
1171
 
# File 'lib/pulp_maven_client/api/repositories_maven_api.rb', line 1168

def set_label(maven_maven_repository_href, set_label, opts = {})
  data, _status_code, _headers = set_label_with_http_info(maven_maven_repository_href, set_label, opts)
  data
end

#set_label_with_http_info(maven_maven_repository_href, set_label, opts = {}) ⇒ Array<(SetLabelResponse, Integer, Hash)>

Set a label Set a single pulp_label on the object to a specific value or null.

Parameters:

  • maven_maven_repository_href (String)
  • set_label (SetLabel)
  • opts (Hash) (defaults to: {}) —

    the optional parameters

Options Hash (opts):

  • :x_task_diagnostics (Array<String>) —

    List of profilers to use on tasks.

Returns:

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

    SetLabelResponse data, response status code and response headers



1180
1181
1182
1183
1184
1185
1186
1187
1188
1189
1190
1191
1192
1193
1194
1195
1196
1197
1198
1199
1200
1201
1202
1203
1204
1205
1206
1207
1208
1209
1210
1211
1212
1213
1214
1215
1216
1217
1218
1219
1220
1221
1222
1223
1224
1225
1226
1227
1228
1229
1230
1231
1232
1233
1234
1235
1236
 
# File 'lib/pulp_maven_client/api/repositories_maven_api.rb', line 1180

def set_label_with_http_info(maven_maven_repository_href, set_label, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: RepositoriesMavenApi.set_label ...'
  end
  # verify the required parameter 'maven_maven_repository_href' is set
  if @api_client.config.client_side_validation && maven_maven_repository_href.nil?
    fail ArgumentError, "Missing the required parameter 'maven_maven_repository_href' when calling RepositoriesMavenApi.set_label"
  end
  # verify the required parameter 'set_label' is set
  if @api_client.config.client_side_validation && set_label.nil?
    fail ArgumentError, "Missing the required parameter 'set_label' when calling RepositoriesMavenApi.set_label"
  end
  # resource path
  local_var_path = '{maven_maven_repository_href}set_label/'.sub('{' + 'maven_maven_repository_href' + '}', CGI.escape(maven_maven_repository_href.to_s).gsub('%2F', '/'))

  # 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']) unless header_params['Accept']
  # HTTP header 'Content-Type'
  content_type = @api_client.select_header_content_type(['application/json', 'application/x-www-form-urlencoded', 'multipart/form-data'])
  if !content_type.nil?
      header_params['Content-Type'] = content_type
  end
  header_params[:'X-Task-Diagnostics'] = @api_client.build_collection_param(opts[:'x_task_diagnostics'], :csv) if !opts[:'x_task_diagnostics'].nil?

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

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

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

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

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

#unset_label(maven_maven_repository_href, unset_label, opts = {}) ⇒ UnsetLabelResponse

Unset a label Unset a single pulp_label on the object.

Parameters:

  • maven_maven_repository_href (String)
  • unset_label (UnsetLabel)
  • opts (Hash) (defaults to: {}) —

    the optional parameters

Options Hash (opts):

  • :x_task_diagnostics (Array<String>) —

    List of profilers to use on tasks.

Returns:



1245
1246
1247
1248
 
# File 'lib/pulp_maven_client/api/repositories_maven_api.rb', line 1245

def unset_label(maven_maven_repository_href, unset_label, opts = {})
  data, _status_code, _headers = unset_label_with_http_info(maven_maven_repository_href, unset_label, opts)
  data
end

#unset_label_with_http_info(maven_maven_repository_href, unset_label, opts = {}) ⇒ Array<(UnsetLabelResponse, Integer, Hash)>

Unset a label Unset a single pulp_label on the object.

Parameters:

  • maven_maven_repository_href (String)
  • unset_label (UnsetLabel)
  • opts (Hash) (defaults to: {}) —

    the optional parameters

Options Hash (opts):

  • :x_task_diagnostics (Array<String>) —

    List of profilers to use on tasks.

Returns:

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

    UnsetLabelResponse data, response status code and response headers



1257
1258
1259
1260
1261
1262
1263
1264
1265
1266
1267
1268
1269
1270
1271
1272
1273
1274
1275
1276
1277
1278
1279
1280
1281
1282
1283
1284
1285
1286
1287
1288
1289
1290
1291
1292
1293
1294
1295
1296
1297
1298
1299
1300
1301
1302
1303
1304
1305
1306
1307
1308
1309
1310
1311
1312
1313
 
# File 'lib/pulp_maven_client/api/repositories_maven_api.rb', line 1257

def unset_label_with_http_info(maven_maven_repository_href, unset_label, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: RepositoriesMavenApi.unset_label ...'
  end
  # verify the required parameter 'maven_maven_repository_href' is set
  if @api_client.config.client_side_validation && maven_maven_repository_href.nil?
    fail ArgumentError, "Missing the required parameter 'maven_maven_repository_href' when calling RepositoriesMavenApi.unset_label"
  end
  # verify the required parameter 'unset_label' is set
  if @api_client.config.client_side_validation && unset_label.nil?
    fail ArgumentError, "Missing the required parameter 'unset_label' when calling RepositoriesMavenApi.unset_label"
  end
  # resource path
  local_var_path = '{maven_maven_repository_href}unset_label/'.sub('{' + 'maven_maven_repository_href' + '}', CGI.escape(maven_maven_repository_href.to_s).gsub('%2F', '/'))

  # 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']) unless header_params['Accept']
  # HTTP header 'Content-Type'
  content_type = @api_client.select_header_content_type(['application/json', 'application/x-www-form-urlencoded', 'multipart/form-data'])
  if !content_type.nil?
      header_params['Content-Type'] = content_type
  end
  header_params[:'X-Task-Diagnostics'] = @api_client.build_collection_param(opts[:'x_task_diagnostics'], :csv) if !opts[:'x_task_diagnostics'].nil?

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

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

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

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

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

#update(maven_maven_repository_href, maven_maven_repository, opts = {}) ⇒ MavenMavenRepositoryResponse

Update a maven repository Update the entity and trigger an asynchronous task if necessary

Parameters:

  • maven_maven_repository_href (String)
  • maven_maven_repository (MavenMavenRepository)
  • opts (Hash) (defaults to: {}) —

    the optional parameters

Options Hash (opts):

  • :x_task_diagnostics (Array<String>) —

    List of profilers to use on tasks.

Returns:



1322
1323
1324
1325
 
# File 'lib/pulp_maven_client/api/repositories_maven_api.rb', line 1322

def update(maven_maven_repository_href, maven_maven_repository, opts = {})
  data, _status_code, _headers = update_with_http_info(maven_maven_repository_href, maven_maven_repository, opts)
  data
end

#update_with_http_info(maven_maven_repository_href, maven_maven_repository, opts = {}) ⇒ Array<(MavenMavenRepositoryResponse, Integer, Hash)>

Update a maven repository Update the entity and trigger an asynchronous task if necessary

Parameters:

  • maven_maven_repository_href (String)
  • maven_maven_repository (MavenMavenRepository)
  • opts (Hash) (defaults to: {}) —

    the optional parameters

Options Hash (opts):

  • :x_task_diagnostics (Array<String>) —

    List of profilers to use on tasks.

Returns:



1334
1335
1336
1337
1338
1339
1340
1341
1342
1343
1344
1345
1346
1347
1348
1349
1350
1351
1352
1353
1354
1355
1356
1357
1358
1359
1360
1361
1362
1363
1364
1365
1366
1367
1368
1369
1370
1371
1372
1373
1374
1375
1376
1377
1378
1379
1380
1381
1382
1383
1384
1385
1386
1387
1388
1389
1390
 
# File 'lib/pulp_maven_client/api/repositories_maven_api.rb', line 1334

def update_with_http_info(maven_maven_repository_href, maven_maven_repository, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: RepositoriesMavenApi.update ...'
  end
  # verify the required parameter 'maven_maven_repository_href' is set
  if @api_client.config.client_side_validation && maven_maven_repository_href.nil?
    fail ArgumentError, "Missing the required parameter 'maven_maven_repository_href' when calling RepositoriesMavenApi.update"
  end
  # verify the required parameter 'maven_maven_repository' is set
  if @api_client.config.client_side_validation && maven_maven_repository.nil?
    fail ArgumentError, "Missing the required parameter 'maven_maven_repository' when calling RepositoriesMavenApi.update"
  end
  # resource path
  local_var_path = '{maven_maven_repository_href}'.sub('{' + 'maven_maven_repository_href' + '}', CGI.escape(maven_maven_repository_href.to_s).gsub('%2F', '/'))

  # 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']) unless header_params['Accept']
  # HTTP header 'Content-Type'
  content_type = @api_client.select_header_content_type(['application/json', 'application/x-www-form-urlencoded', 'multipart/form-data'])
  if !content_type.nil?
      header_params['Content-Type'] = content_type
  end
  header_params[:'X-Task-Diagnostics'] = @api_client.build_collection_param(opts[:'x_task_diagnostics'], :csv) if !opts[:'x_task_diagnostics'].nil?

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

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

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

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

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