Class: PulpRpmClient::ContentModulemdsApi

Inherits:
Object
  • Object
show all
Defined in:
lib/pulp_rpm_client/api/content_modulemds_api.rb

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(api_client = ApiClient.default) ⇒ ContentModulemdsApi

Returns a new instance of ContentModulemdsApi.



19
20
21
 
# File 'lib/pulp_rpm_client/api/content_modulemds_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_rpm_client/api/content_modulemds_api.rb', line 17

def api_client
  @api_client
end

Instance Method Details

#create(relative_path, name, stream, version, context, arch, artifacts, dependencies, opts = {}) ⇒ AsyncOperationResponse

Create a modulemd Trigger an asynchronous task to create content,optionally create new repository version.

Parameters:

  • relative_path (String) —

    Path where the artifact is located relative to distributions base_path

  • name (String) —

    Modulemd name.

  • stream (String) —

    Stream name.

  • version (String) —

    Modulemd version.

  • context (String) —

    Modulemd context.

  • arch (String) —

    Modulemd architecture.

  • artifacts (String) —

    Modulemd artifacts.

  • dependencies (String) —

    Modulemd dependencies.

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

    the optional parameters

Options Hash (opts):

  • :artifact (String) —

    Artifact file representing the physical content

  • :file (File) —

    An uploaded file that should be turned into the artifact of the content unit.

  • :repository (String) —

    A URI of a repository the new content unit should be associated with.

  • :packages (Array<String>) —

    Modulemd artifacts&#39; packages.

Returns:



38
39
40
41
 
# File 'lib/pulp_rpm_client/api/content_modulemds_api.rb', line 38

def create(relative_path, name, stream, version, context, arch, artifacts, dependencies, opts = {})
  data, _status_code, _headers = create_with_http_info(relative_path, name, stream, version, context, arch, artifacts, dependencies, opts)
  data
end

#create_with_http_info(relative_path, name, stream, version, context, arch, artifacts, dependencies, opts = {}) ⇒ Array<(AsyncOperationResponse, Integer, Hash)>

Create a modulemd Trigger an asynchronous task to create content,optionally create new repository version.

Parameters:

  • relative_path (String) —

    Path where the artifact is located relative to distributions base_path

  • name (String) —

    Modulemd name.

  • stream (String) —

    Stream name.

  • version (String) —

    Modulemd version.

  • context (String) —

    Modulemd context.

  • arch (String) —

    Modulemd architecture.

  • artifacts (String) —

    Modulemd artifacts.

  • dependencies (String) —

    Modulemd dependencies.

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

    the optional parameters

Options Hash (opts):

  • :artifact (String) —

    Artifact file representing the physical content

  • :file (File) —

    An uploaded file that should be turned into the artifact of the content unit.

  • :repository (String) —

    A URI of a repository the new content unit should be associated with.

  • :packages (Array<String>) —

    Modulemd artifacts&#39; packages.

Returns:

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

    AsyncOperationResponse data, response status code and response headers



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
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
 
# File 'lib/pulp_rpm_client/api/content_modulemds_api.rb', line 59

def create_with_http_info(relative_path, name, stream, version, context, arch, artifacts, dependencies, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: ContentModulemdsApi.create ...'
  end
  # verify the required parameter 'relative_path' is set
  if @api_client.config.client_side_validation && relative_path.nil?
    fail ArgumentError, "Missing the required parameter 'relative_path' when calling ContentModulemdsApi.create"
  end
  if @api_client.config.client_side_validation && relative_path.to_s.length < 1
    fail ArgumentError, 'invalid value for "relative_path" when calling ContentModulemdsApi.create, the character length must be great than or equal to 1.'
  end

  # verify the required parameter 'name' is set
  if @api_client.config.client_side_validation && name.nil?
    fail ArgumentError, "Missing the required parameter 'name' when calling ContentModulemdsApi.create"
  end
  if @api_client.config.client_side_validation && name.to_s.length < 1
    fail ArgumentError, 'invalid value for "name" when calling ContentModulemdsApi.create, the character length must be great than or equal to 1.'
  end

  # verify the required parameter 'stream' is set
  if @api_client.config.client_side_validation && stream.nil?
    fail ArgumentError, "Missing the required parameter 'stream' when calling ContentModulemdsApi.create"
  end
  if @api_client.config.client_side_validation && stream.to_s.length < 1
    fail ArgumentError, 'invalid value for "stream" when calling ContentModulemdsApi.create, the character length must be great than or equal to 1.'
  end

  # verify the required parameter 'version' is set
  if @api_client.config.client_side_validation && version.nil?
    fail ArgumentError, "Missing the required parameter 'version' when calling ContentModulemdsApi.create"
  end
  if @api_client.config.client_side_validation && version.to_s.length < 1
    fail ArgumentError, 'invalid value for "version" when calling ContentModulemdsApi.create, the character length must be great than or equal to 1.'
  end

  # verify the required parameter 'context' is set
  if @api_client.config.client_side_validation && context.nil?
    fail ArgumentError, "Missing the required parameter 'context' when calling ContentModulemdsApi.create"
  end
  if @api_client.config.client_side_validation && context.to_s.length < 1
    fail ArgumentError, 'invalid value for "context" when calling ContentModulemdsApi.create, the character length must be great than or equal to 1.'
  end

  # verify the required parameter 'arch' is set
  if @api_client.config.client_side_validation && arch.nil?
    fail ArgumentError, "Missing the required parameter 'arch' when calling ContentModulemdsApi.create"
  end
  if @api_client.config.client_side_validation && arch.to_s.length < 1
    fail ArgumentError, 'invalid value for "arch" when calling ContentModulemdsApi.create, the character length must be great than or equal to 1.'
  end

  # verify the required parameter 'artifacts' is set
  if @api_client.config.client_side_validation && artifacts.nil?
    fail ArgumentError, "Missing the required parameter 'artifacts' when calling ContentModulemdsApi.create"
  end
  # verify the required parameter 'dependencies' is set
  if @api_client.config.client_side_validation && dependencies.nil?
    fail ArgumentError, "Missing the required parameter 'dependencies' when calling ContentModulemdsApi.create"
  end
  # resource path
  local_var_path = '/pulp/api/v3/content/rpm/modulemds/'

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

  # header parameters
  header_params = opts[:header_params] || {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json'])
  # HTTP header 'Content-Type'
  header_params['Content-Type'] = @api_client.select_header_content_type(['multipart/form-data', 'application/x-www-form-urlencoded'])

  # form parameters
  form_params = opts[:form_params] || {}
  form_params['relative_path'] = relative_path
  form_params['name'] = name
  form_params['stream'] = stream
  form_params['version'] = version
  form_params['context'] = context
  form_params['arch'] = arch
  form_params['artifacts'] = artifacts
  form_params['dependencies'] = dependencies
  form_params['artifact'] = opts[:'artifact'] if !opts[:'artifact'].nil?
  form_params['file'] = opts[:'file'] if !opts[:'file'].nil?
  form_params['repository'] = opts[:'repository'] if !opts[:'repository'].nil?
  form_params['packages'] = @api_client.build_collection_param(opts[:'packages'], :csv) if !opts[:'packages'].nil?

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

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

  # auth_names
  auth_names = opts[:auth_names] || ['Basic']

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

#list(opts = {}) ⇒ InlineResponse2003

List modulemds ViewSet for Modulemd.

Parameters:

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

    the optional parameters

Options Hash (opts):

  • :name (String) —

    Filter results where name matches value

  • :name__in (String) —

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

  • :stream (String) —

    Filter results where stream matches value

  • :stream__in (String) —

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

  • :repository_version (String) —

    Repository Version referenced by HREF

  • :repository_version_added (String) —

    Repository Version referenced by HREF

  • :repository_version_removed (String) —

    Repository Version referenced by HREF

  • :limit (Integer) —

    Number of results to return per page.

  • :offset (Integer) —

    The initial index from which to return the results.

  • :fields (String) —

    A list of fields to include in the response.

  • :exclude_fields (String) —

    A list of fields to exclude from the response.

Returns:



187
188
189
190
 
# File 'lib/pulp_rpm_client/api/content_modulemds_api.rb', line 187

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

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

List modulemds ViewSet for Modulemd.

Parameters:

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

    the optional parameters

Options Hash (opts):

  • :name (String) —

    Filter results where name matches value

  • :name__in (String) —

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

  • :stream (String) —

    Filter results where stream matches value

  • :stream__in (String) —

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

  • :repository_version (String) —

    Repository Version referenced by HREF

  • :repository_version_added (String) —

    Repository Version referenced by HREF

  • :repository_version_removed (String) —

    Repository Version referenced by HREF

  • :limit (Integer) —

    Number of results to return per page.

  • :offset (Integer) —

    The initial index from which to return the results.

  • :fields (String) —

    A list of fields to include in the response.

  • :exclude_fields (String) —

    A list of fields to exclude from the response.

Returns:

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

    InlineResponse2003 data, response status code and response headers



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
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
 
# File 'lib/pulp_rpm_client/api/content_modulemds_api.rb', line 207

def list_with_http_info(opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: ContentModulemdsApi.list ...'
  end
  # resource path
  local_var_path = '/pulp/api/v3/content/rpm/modulemds/'

  # query parameters
  query_params = opts[:query_params] || {}
  query_params[:'name'] = opts[:'name'] if !opts[:'name'].nil?
  query_params[:'name__in'] = opts[:'name__in'] if !opts[:'name__in'].nil?
  query_params[:'stream'] = opts[:'stream'] if !opts[:'stream'].nil?
  query_params[:'stream__in'] = opts[:'stream__in'] if !opts[:'stream__in'].nil?
  query_params[:'repository_version'] = opts[:'repository_version'] if !opts[:'repository_version'].nil?
  query_params[:'repository_version_added'] = opts[:'repository_version_added'] if !opts[:'repository_version_added'].nil?
  query_params[:'repository_version_removed'] = opts[:'repository_version_removed'] if !opts[:'repository_version_removed'].nil?
  query_params[:'limit'] = opts[:'limit'] if !opts[:'limit'].nil?
  query_params[:'offset'] = opts[:'offset'] if !opts[:'offset'].nil?
  query_params[:'fields'] = opts[:'fields'] if !opts[:'fields'].nil?
  query_params[:'exclude_fields'] = opts[:'exclude_fields'] 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'])

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

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

  # return_type
  return_type = opts[:return_type] || 'InlineResponse2003' 

  # auth_names
  auth_names = opts[:auth_names] || ['Basic']

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

#read(modulemd_href, opts = {}) ⇒ RpmModulemd

Inspect a modulemd ViewSet for Modulemd.

Parameters:

  • modulemd_href (String) —

    URI of Modulemd. e.g.: /pulp/api/v3/content/rpm/modulemds/1/

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

    the optional parameters

Options Hash (opts):

  • :fields (String) —

    A list of fields to include in the response.

  • :exclude_fields (String) —

    A list of fields to exclude from the response.

Returns:



268
269
270
271
 
# File 'lib/pulp_rpm_client/api/content_modulemds_api.rb', line 268

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

#read_with_http_info(modulemd_href, opts = {}) ⇒ Array<(RpmModulemd, Integer, Hash)>

Inspect a modulemd ViewSet for Modulemd.

Parameters:

  • modulemd_href (String) —

    URI of Modulemd. e.g.: /pulp/api/v3/content/rpm/modulemds/1/

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

    the optional parameters

Options Hash (opts):

  • :fields (String) —

    A list of fields to include in the response.

  • :exclude_fields (String) —

    A list of fields to exclude from the response.

Returns:

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

    RpmModulemd data, response status code and response headers



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
316
317
318
319
320
321
322
323
324
325
326
327
 
# File 'lib/pulp_rpm_client/api/content_modulemds_api.rb', line 280

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

  # query parameters
  query_params = opts[:query_params] || {}
  query_params[:'fields'] = opts[:'fields'] if !opts[:'fields'].nil?
  query_params[:'exclude_fields'] = opts[:'exclude_fields'] 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'])

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

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

  # return_type
  return_type = opts[:return_type] || 'RpmModulemd' 

  # auth_names
  auth_names = opts[:auth_names] || ['Basic']

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