Class: PulpHuggingFaceClient::PublicationsHuggingFaceApi

Inherits:
Object
  • Object
show all
Defined in:
lib/pulp_hugging_face_client/api/publications_hugging_face_api.rb

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(api_client = ApiClient.default) ⇒ PublicationsHuggingFaceApi

Returns a new instance of PublicationsHuggingFaceApi.



19
20
21
 
# File 'lib/pulp_hugging_face_client/api/publications_hugging_face_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_hugging_face_client/api/publications_hugging_face_api.rb', line 17

def api_client
  @api_client
end

Instance Method Details

#create(hugging_face_hugging_face_publication, opts = {}) ⇒ AsyncOperationResponse

Create a hugging face publication Trigger an asynchronous task to publish content

Parameters:

Options Hash (opts):

  • :x_task_diagnostics (Array<String>) —

    List of profilers to use on tasks.

Returns:



28
29
30
31
 
# File 'lib/pulp_hugging_face_client/api/publications_hugging_face_api.rb', line 28

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

#create_with_http_info(hugging_face_hugging_face_publication, opts = {}) ⇒ Array<(AsyncOperationResponse, Integer, Hash)>

Create a hugging face publication Trigger an asynchronous task to publish content

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



39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
 
# File 'lib/pulp_hugging_face_client/api/publications_hugging_face_api.rb', line 39

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

  # 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(hugging_face_hugging_face_publication)

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

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

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

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

Delete a hugging face publication A ViewSet for HuggingFacePublication. Similar to the HuggingFaceContentViewSet above, define endpoint_name, queryset and serializer, at a minimum.

Parameters:

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

  • (nil) 


99
100
101
102
 
# File 'lib/pulp_hugging_face_client/api/publications_hugging_face_api.rb', line 99

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

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

Delete a hugging face publication A ViewSet for HuggingFacePublication. Similar to the HuggingFaceContentViewSet above, define endpoint_name, queryset and serializer, at a minimum.

Parameters:

  • hugging_face_hugging_face_publication_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<(nil, Integer, Hash)>) —

    nil, response status code and response headers



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
 
# File 'lib/pulp_hugging_face_client/api/publications_hugging_face_api.rb', line 110

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

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

  # header parameters
  header_params = opts[:header_params] || {}
  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]

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

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

#list(opts = {}) ⇒ PaginatedhuggingFaceHuggingFacePublicationResponseList

List hugging face publications A ViewSet for HuggingFacePublication. Similar to the HuggingFaceContentViewSet above, define endpoint_name, queryset and serializer, at a minimum.

Parameters:

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

    the optional parameters

Options Hash (opts):

  • :x_task_diagnostics (Array<String>) —

    List of profilers to use on tasks.

  • :checkpoint (Boolean) —

    Filter results where checkpoint matches value

  • :content (String) —

    Content Unit referenced by HREF/PRN

  • :content__in (Array<String>) —

    Multiple values may be separated by commas.

  • :limit (Integer) —

    Number of results to return per page.

  • :offset (Integer) —

    The initial index from which to return the results.

  • :ordering (Array<String>) —

    Ordering * &#x60;pulp_id&#x60; - Pulp id * &#x60;-pulp_id&#x60; - Pulp id (descending) * &#x60;pulp_created&#x60; - Pulp created * &#x60;-pulp_created&#x60; - Pulp created (descending) * &#x60;pulp_last_updated&#x60; - Pulp last updated * &#x60;-pulp_last_updated&#x60; - Pulp last updated (descending) * &#x60;pulp_type&#x60; - Pulp type * &#x60;-pulp_type&#x60; - Pulp type (descending) * &#x60;complete&#x60; - Complete * &#x60;-complete&#x60; - Complete (descending) * &#x60;pass_through&#x60; - Pass through * &#x60;-pass_through&#x60; - Pass through (descending) * &#x60;checkpoint&#x60; - Checkpoint * &#x60;-checkpoint&#x60; - Checkpoint (descending) * &#x60;pk&#x60; - Pk * &#x60;-pk&#x60; - Pk (descending)

  • :prn__in (Array<String>) —

    Multiple values may be separated by commas.

  • :pulp_created (Time) —

    Filter results where pulp_created matches value

  • :pulp_created__gt (Time) —

    Filter results where pulp_created is greater than value

  • :pulp_created__gte (Time) —

    Filter results where pulp_created is greater than or equal to value

  • :pulp_created__isnull (Boolean) —

    Filter results where pulp_created has a null value

  • :pulp_created__lt (Time) —

    Filter results where pulp_created is less than value

  • :pulp_created__lte (Time) —

    Filter results where pulp_created is less than or equal to value

  • :pulp_created__range (Array<Time>) —

    Filter results where pulp_created is between two comma separated values

  • :pulp_href__in (Array<String>) —

    Multiple values may be separated by commas.

  • :pulp_id__in (Array<String>) —

    Multiple values may be separated by commas.

  • :q (String) —

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

  • :repository (String) —

    Repository referenced by HREF/PRN

  • :repository_version (String) —

    Repository Version 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:



183
184
185
186
 
# File 'lib/pulp_hugging_face_client/api/publications_hugging_face_api.rb', line 183

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

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

List hugging face publications A ViewSet for HuggingFacePublication. Similar to the HuggingFaceContentViewSet above, define endpoint_name, queryset and serializer, at a minimum.

Parameters:

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

    the optional parameters

Options Hash (opts):

  • :x_task_diagnostics (Array<String>) —

    List of profilers to use on tasks.

  • :checkpoint (Boolean) —

    Filter results where checkpoint matches value

  • :content (String) —

    Content Unit referenced by HREF/PRN

  • :content__in (Array<String>) —

    Multiple values may be separated by commas.

  • :limit (Integer) —

    Number of results to return per page.

  • :offset (Integer) —

    The initial index from which to return the results.

  • :ordering (Array<String>) —

    Ordering * &#x60;pulp_id&#x60; - Pulp id * &#x60;-pulp_id&#x60; - Pulp id (descending) * &#x60;pulp_created&#x60; - Pulp created * &#x60;-pulp_created&#x60; - Pulp created (descending) * &#x60;pulp_last_updated&#x60; - Pulp last updated * &#x60;-pulp_last_updated&#x60; - Pulp last updated (descending) * &#x60;pulp_type&#x60; - Pulp type * &#x60;-pulp_type&#x60; - Pulp type (descending) * &#x60;complete&#x60; - Complete * &#x60;-complete&#x60; - Complete (descending) * &#x60;pass_through&#x60; - Pass through * &#x60;-pass_through&#x60; - Pass through (descending) * &#x60;checkpoint&#x60; - Checkpoint * &#x60;-checkpoint&#x60; - Checkpoint (descending) * &#x60;pk&#x60; - Pk * &#x60;-pk&#x60; - Pk (descending)

  • :prn__in (Array<String>) —

    Multiple values may be separated by commas.

  • :pulp_created (Time) —

    Filter results where pulp_created matches value

  • :pulp_created__gt (Time) —

    Filter results where pulp_created is greater than value

  • :pulp_created__gte (Time) —

    Filter results where pulp_created is greater than or equal to value

  • :pulp_created__isnull (Boolean) —

    Filter results where pulp_created has a null value

  • :pulp_created__lt (Time) —

    Filter results where pulp_created is less than value

  • :pulp_created__lte (Time) —

    Filter results where pulp_created is less than or equal to value

  • :pulp_created__range (Array<Time>) —

    Filter results where pulp_created is between two comma separated values

  • :pulp_href__in (Array<String>) —

    Multiple values may be separated by commas.

  • :pulp_id__in (Array<String>) —

    Multiple values may be separated by commas.

  • :q (String) —

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

  • :repository (String) —

    Repository referenced by HREF/PRN

  • :repository_version (String) —

    Repository Version 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:



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
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
 
# File 'lib/pulp_hugging_face_client/api/publications_hugging_face_api.rb', line 214

def list_with_http_info(opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: PublicationsHuggingFaceApi.list ...'
  end
  allowable_values = ["-checkpoint", "-complete", "-pass_through", "-pk", "-pulp_created", "-pulp_id", "-pulp_last_updated", "-pulp_type", "checkpoint", "complete", "pass_through", "pk", "pulp_created", "pulp_id", "pulp_last_updated", "pulp_type"]
  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/publications/hugging_face/hugging-face/'

  # query parameters
  query_params = opts[:query_params] || {}
  query_params[:'checkpoint'] = opts[:'checkpoint'] if !opts[:'checkpoint'].nil?
  query_params[:'content'] = opts[:'content'] if !opts[:'content'].nil?
  query_params[:'content__in'] = @api_client.build_collection_param(opts[:'content__in'], :csv) if !opts[:'content__in'].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'], :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_created'] = opts[:'pulp_created'] if !opts[:'pulp_created'].nil?
  query_params[:'pulp_created__gt'] = opts[:'pulp_created__gt'] if !opts[:'pulp_created__gt'].nil?
  query_params[:'pulp_created__gte'] = opts[:'pulp_created__gte'] if !opts[:'pulp_created__gte'].nil?
  query_params[:'pulp_created__isnull'] = opts[:'pulp_created__isnull'] if !opts[:'pulp_created__isnull'].nil?
  query_params[:'pulp_created__lt'] = opts[:'pulp_created__lt'] if !opts[:'pulp_created__lt'].nil?
  query_params[:'pulp_created__lte'] = opts[:'pulp_created__lte'] if !opts[:'pulp_created__lte'].nil?
  query_params[:'pulp_created__range'] = @api_client.build_collection_param(opts[:'pulp_created__range'], :csv) if !opts[:'pulp_created__range'].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[:'q'] = opts[:'q'] if !opts[:'q'].nil?
  query_params[:'repository'] = opts[:'repository'] if !opts[:'repository'].nil?
  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] || 'PaginatedhuggingFaceHuggingFacePublicationResponseList'

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

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

#read(hugging_face_hugging_face_publication_href, opts = {}) ⇒ HuggingFaceHuggingFacePublicationResponse

Inspect a hugging face publication A ViewSet for HuggingFacePublication. Similar to the HuggingFaceContentViewSet above, define endpoint_name, queryset and serializer, at a minimum.

Parameters:

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



292
293
294
295
 
# File 'lib/pulp_hugging_face_client/api/publications_hugging_face_api.rb', line 292

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

#read_with_http_info(hugging_face_hugging_face_publication_href, opts = {}) ⇒ Array<(HuggingFaceHuggingFacePublicationResponse, Integer, Hash)>

Inspect a hugging face publication A ViewSet for HuggingFacePublication. Similar to the HuggingFaceContentViewSet above, define endpoint_name, queryset and serializer, at a minimum.

Parameters:

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



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
342
343
344
345
346
347
348
349
350
351
352
353
354
 
# File 'lib/pulp_hugging_face_client/api/publications_hugging_face_api.rb', line 305

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

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

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