Class: PulpcoreClient::ArtifactsApi

Inherits:
Object
  • Object
show all
Defined in:
lib/pulpcore_client/api/artifacts_api.rb

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(api_client = ApiClient.default) ⇒ ArtifactsApi

Returns a new instance of ArtifactsApi.



19
20
21
 
# File 'lib/pulpcore_client/api/artifacts_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/pulpcore_client/api/artifacts_api.rb', line 17

def api_client
  @api_client
end

Instance Method Details

#create(file, opts = {}) ⇒ Artifact

Create an artifact

Parameters:

  • file (File) —

    The stored file.

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

    the optional parameters

Options Hash (opts):

  • :size (Integer) —

    The size of the file in bytes.

  • :md5 (String) —

    The MD5 checksum of the file if available.

  • :sha1 (String) —

    The SHA-1 checksum of the file if available.

  • :sha224 (String) —

    The SHA-224 checksum of the file if available.

  • :sha256 (String) —

    The SHA-256 checksum of the file if available.

  • :sha384 (String) —

    The SHA-384 checksum of the file if available.

  • :sha512 (String) —

    The SHA-512 checksum of the file if available.

Returns:



33
34
35
36
 
# File 'lib/pulpcore_client/api/artifacts_api.rb', line 33

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

#create_with_http_info(file, opts = {}) ⇒ Array<(Artifact, Integer, Hash)>

Create an artifact

Parameters:

  • file (File) —

    The stored file.

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

    the optional parameters

Options Hash (opts):

  • :size (Integer) —

    The size of the file in bytes.

  • :md5 (String) —

    The MD5 checksum of the file if available.

  • :sha1 (String) —

    The SHA-1 checksum of the file if available.

  • :sha224 (String) —

    The SHA-224 checksum of the file if available.

  • :sha256 (String) —

    The SHA-256 checksum of the file if available.

  • :sha384 (String) —

    The SHA-384 checksum of the file if available.

  • :sha512 (String) —

    The SHA-512 checksum of the file if available.

Returns:

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

    Artifact 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
128
 
# File 'lib/pulpcore_client/api/artifacts_api.rb', line 49

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

  if @api_client.config.client_side_validation && !opts[:'sha1'].nil? && opts[:'sha1'].to_s.length < 1
    fail ArgumentError, 'invalid value for "opts[:"sha1"]" when calling ArtifactsApi.create, the character length must be great than or equal to 1.'
  end

  if @api_client.config.client_side_validation && !opts[:'sha224'].nil? && opts[:'sha224'].to_s.length < 1
    fail ArgumentError, 'invalid value for "opts[:"sha224"]" when calling ArtifactsApi.create, the character length must be great than or equal to 1.'
  end

  if @api_client.config.client_side_validation && !opts[:'sha256'].nil? && opts[:'sha256'].to_s.length < 1
    fail ArgumentError, 'invalid value for "opts[:"sha256"]" when calling ArtifactsApi.create, the character length must be great than or equal to 1.'
  end

  if @api_client.config.client_side_validation && !opts[:'sha384'].nil? && opts[:'sha384'].to_s.length < 1
    fail ArgumentError, 'invalid value for "opts[:"sha384"]" when calling ArtifactsApi.create, the character length must be great than or equal to 1.'
  end

  if @api_client.config.client_side_validation && !opts[:'sha512'].nil? && opts[:'sha512'].to_s.length < 1
    fail ArgumentError, 'invalid value for "opts[:"sha512"]" when calling ArtifactsApi.create, the character length must be great than or equal to 1.'
  end

  # resource path
  local_var_path = '/pulp/api/v3/artifacts/'

  # 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['file'] = file
  form_params['size'] = opts[:'size'] if !opts[:'size'].nil?
  form_params['md5'] = opts[:'md5'] if !opts[:'md5'].nil?
  form_params['sha1'] = opts[:'sha1'] if !opts[:'sha1'].nil?
  form_params['sha224'] = opts[:'sha224'] if !opts[:'sha224'].nil?
  form_params['sha256'] = opts[:'sha256'] if !opts[:'sha256'].nil?
  form_params['sha384'] = opts[:'sha384'] if !opts[:'sha384'].nil?
  form_params['sha512'] = opts[:'sha512'] if !opts[:'sha512'].nil?

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

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

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

#delete(artifact_href, opts = {}) ⇒ nil

Delete an artifact Remove Artifact only if it is not associated with any Content.

Parameters:

  • artifact_href (String) —

    URI of Artifact. e.g.: /pulp/api/v3/artifacts/1/

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

    the optional parameters

Returns:

  • (nil) 


135
136
137
138
 
# File 'lib/pulpcore_client/api/artifacts_api.rb', line 135

def delete(artifact_href, opts = {})
  delete_with_http_info(artifact_href, opts)
  nil
end

#delete_with_http_info(artifact_href, opts = {}) ⇒ Array<(nil, Integer, Hash)>

Delete an artifact Remove Artifact only if it is not associated with any Content.

Parameters:

  • artifact_href (String) —

    URI of Artifact. e.g.: /pulp/api/v3/artifacts/1/

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

    the optional parameters

Returns:

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

    nil, response status code and response headers



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
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
 
# File 'lib/pulpcore_client/api/artifacts_api.rb', line 145

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

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

  # header parameters
  header_params = opts[:header_params] || {}

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

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

  # return_type
  return_type = opts[:return_type] 

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

#list(opts = {}) ⇒ InlineResponse200

List artifacts

Parameters:

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

    the optional parameters

Options Hash (opts):

  • :repository_version (String) —

    Repository Version referenced by HREF

  • :md5 (String) —

    Filter results where md5 matches value

  • :sha1 (String) —

    Filter results where sha1 matches value

  • :sha224 (String) —

    Filter results where sha224 matches value

  • :sha256 (String) —

    Filter results where sha256 matches value

  • :sha384 (String) —

    Filter results where sha384 matches value

  • :sha512 (String) —

    Filter results where sha512 matches value

  • :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:



204
205
206
207
 
# File 'lib/pulpcore_client/api/artifacts_api.rb', line 204

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

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

List artifacts

Parameters:

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

    the optional parameters

Options Hash (opts):

  • :repository_version (String) —

    Repository Version referenced by HREF

  • :md5 (String) —

    Filter results where md5 matches value

  • :sha1 (String) —

    Filter results where sha1 matches value

  • :sha224 (String) —

    Filter results where sha224 matches value

  • :sha256 (String) —

    Filter results where sha256 matches value

  • :sha384 (String) —

    Filter results where sha384 matches value

  • :sha512 (String) —

    Filter results where sha512 matches value

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

    InlineResponse200 data, response status code and response headers



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
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
 
# File 'lib/pulpcore_client/api/artifacts_api.rb', line 223

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

  # query parameters
  query_params = opts[:query_params] || {}
  query_params[:'repository_version'] = opts[:'repository_version'] if !opts[:'repository_version'].nil?
  query_params[:'md5'] = opts[:'md5'] if !opts[:'md5'].nil?
  query_params[:'sha1'] = opts[:'sha1'] if !opts[:'sha1'].nil?
  query_params[:'sha224'] = opts[:'sha224'] if !opts[:'sha224'].nil?
  query_params[:'sha256'] = opts[:'sha256'] if !opts[:'sha256'].nil?
  query_params[:'sha384'] = opts[:'sha384'] if !opts[:'sha384'].nil?
  query_params[:'sha512'] = opts[:'sha512'] if !opts[:'sha512'].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] || 'InlineResponse200' 

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

#read(artifact_href, opts = {}) ⇒ Artifact

Inspect an artifact

Parameters:

  • artifact_href (String) —

    URI of Artifact. e.g.: /pulp/api/v3/artifacts/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:



283
284
285
286
 
# File 'lib/pulpcore_client/api/artifacts_api.rb', line 283

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

#read_with_http_info(artifact_href, opts = {}) ⇒ Array<(Artifact, Integer, Hash)>

Inspect an artifact

Parameters:

  • artifact_href (String) —

    URI of Artifact. e.g.: /pulp/api/v3/artifacts/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<(Artifact, Integer, Hash)>) —

    Artifact data, response status code and response headers



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
328
329
330
331
332
333
334
335
336
337
338
339
340
341
 
# File 'lib/pulpcore_client/api/artifacts_api.rb', line 294

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

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