Class: PulpRpmClient::ContentModulemdDefaultsApi

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

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(api_client = ApiClient.default) ⇒ ContentModulemdDefaultsApi

Returns a new instance of ContentModulemdDefaultsApi.



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

def api_client
  @api_client
end

Instance Method Details

#create(relative_path, _module, stream, profiles, opts = {}) ⇒ AsyncOperationResponse

Create a modulemd defaults 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

  • _module (String) —

    Modulemd name.

  • stream (String) —

    Modulemd default stream.

  • profiles (String) —

    Default profiles for modulemd streams.

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

    the optional parameters

Options Hash (opts):

  • :artifact (String) —

    Artifact file representing the physical content

  • :file (File) —

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

  • :repository (String) —

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

Returns:



33
34
35
36
 
# File 'lib/pulp_rpm_client/api/content_modulemd_defaults_api.rb', line 33

def create(relative_path, _module, stream, profiles, opts = {})
  data, _status_code, _headers = create_with_http_info(relative_path, _module, stream, profiles, opts)
  data
end

#create_with_http_info(relative_path, _module, stream, profiles, opts = {}) ⇒ Array<(AsyncOperationResponse, Integer, Hash)>

Create a modulemd defaults 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

  • _module (String) —

    Modulemd name.

  • stream (String) —

    Modulemd default stream.

  • profiles (String) —

    Default profiles for modulemd streams.

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

    the optional parameters

Options Hash (opts):

  • :artifact (String) —

    Artifact file representing the physical content

  • :file (File) —

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

  • :repository (String) —

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

Returns:

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

    AsyncOperationResponse data, response status code and response headers



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
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
 
# File 'lib/pulp_rpm_client/api/content_modulemd_defaults_api.rb', line 49

def create_with_http_info(relative_path, _module, stream, profiles, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: ContentModulemdDefaultsApi.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 ContentModulemdDefaultsApi.create"
  end
  if @api_client.config.client_side_validation && relative_path.to_s.length < 1
    fail ArgumentError, 'invalid value for "relative_path" when calling ContentModulemdDefaultsApi.create, the character length must be great than or equal to 1.'
  end

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

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

  # 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['module'] = _module
  form_params['stream'] = stream
  form_params['profiles'] = profiles
  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?

  # 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: ContentModulemdDefaultsApi#create\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#list(opts = {}) ⇒ InlineResponse2002

List modulemd defaultss ViewSet for Modulemd.

Parameters:

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

    the optional parameters

Options Hash (opts):

  • :ordering (String) —

    Which field to use when ordering the results.

  • :_module (String) —

    Filter results where module matches value

  • :module__in (String) —

    Filter results where module 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

  • :sha256 (String)
  • :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:



146
147
148
149
 
# File 'lib/pulp_rpm_client/api/content_modulemd_defaults_api.rb', line 146

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

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

List modulemd defaultss ViewSet for Modulemd.

Parameters:

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

    the optional parameters

Options Hash (opts):

  • :ordering (String) —

    Which field to use when ordering the results.

  • :_module (String) —

    Filter results where module matches value

  • :module__in (String) —

    Filter results where module 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

  • :sha256 (String)
  • :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<(InlineResponse2002, Integer, Hash)>) —

    InlineResponse2002 data, response status code and response headers



168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
 
# File 'lib/pulp_rpm_client/api/content_modulemd_defaults_api.rb', line 168

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

  # query parameters
  query_params = opts[:query_params] || {}
  query_params[:'ordering'] = opts[:'ordering'] if !opts[:'ordering'].nil?
  query_params[:'module'] = opts[:'_module'] if !opts[:'_module'].nil?
  query_params[:'module__in'] = opts[:'module__in'] if !opts[:'module__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[:'sha256'] = opts[:'sha256'] if !opts[:'sha256'].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] || 'InlineResponse2002' 

  # 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: ContentModulemdDefaultsApi#list\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#read(modulemd_defaults_href, opts = {}) ⇒ RpmModulemdDefaults

Inspect a modulemd defaults ViewSet for Modulemd.

Parameters:

  • modulemd_defaults_href (String) —

    URI of Modulemd Defaults. e.g.: /pulp/api/v3/content/rpm/modulemd_defaults/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:



231
232
233
234
 
# File 'lib/pulp_rpm_client/api/content_modulemd_defaults_api.rb', line 231

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

#read_with_http_info(modulemd_defaults_href, opts = {}) ⇒ Array<(RpmModulemdDefaults, Integer, Hash)>

Inspect a modulemd defaults ViewSet for Modulemd.

Parameters:

  • modulemd_defaults_href (String) —

    URI of Modulemd Defaults. e.g.: /pulp/api/v3/content/rpm/modulemd_defaults/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<(RpmModulemdDefaults, Integer, Hash)>) —

    RpmModulemdDefaults data, response status code and response headers



243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
 
# File 'lib/pulp_rpm_client/api/content_modulemd_defaults_api.rb', line 243

def read_with_http_info(modulemd_defaults_href, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: ContentModulemdDefaultsApi.read ...'
  end
  # verify the required parameter 'modulemd_defaults_href' is set
  if @api_client.config.client_side_validation && modulemd_defaults_href.nil?
    fail ArgumentError, "Missing the required parameter 'modulemd_defaults_href' when calling ContentModulemdDefaultsApi.read"
  end
  # resource path
  local_var_path = '{modulemd_defaults_href}'.sub('{' + 'modulemd_defaults_href' + '}', CGI.escape(modulemd_defaults_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] || 'RpmModulemdDefaults' 

  # 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: ContentModulemdDefaultsApi#read\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end