Class: PulpHuggingFaceClient::ContentHuggingFaceApi
- Inherits:
-
Object
- Object
- PulpHuggingFaceClient::ContentHuggingFaceApi
- Defined in:
- lib/pulp_hugging_face_client/api/content_hugging_face_api.rb
Instance Attribute Summary collapse
-
#api_client ⇒ Object
Returns the value of attribute api_client.
Instance Method Summary collapse
-
#create(hugging_face_hugging_face_content, opts = {}) ⇒ HuggingFaceHuggingFaceContentResponse
Create a hugging face content Perform bookkeeping when saving Content.
-
#create_with_http_info(hugging_face_hugging_face_content, opts = {}) ⇒ Array<(HuggingFaceHuggingFaceContentResponse, Integer, Hash)>
Create a hugging face content Perform bookkeeping when saving Content.
-
#initialize(api_client = ApiClient.default) ⇒ ContentHuggingFaceApi
constructor
A new instance of ContentHuggingFaceApi.
-
#list(opts = {}) ⇒ PaginatedhuggingFaceHuggingFaceContentResponseList
List hugging face contents A ViewSet for HuggingFaceContent.
-
#list_with_http_info(opts = {}) ⇒ Array<(PaginatedhuggingFaceHuggingFaceContentResponseList, Integer, Hash)>
List hugging face contents A ViewSet for HuggingFaceContent.
-
#read(hugging_face_hugging_face_content_href, opts = {}) ⇒ HuggingFaceHuggingFaceContentResponse
Inspect a hugging face content A ViewSet for HuggingFaceContent.
-
#read_with_http_info(hugging_face_hugging_face_content_href, opts = {}) ⇒ Array<(HuggingFaceHuggingFaceContentResponse, Integer, Hash)>
Inspect a hugging face content A ViewSet for HuggingFaceContent.
-
#set_label(hugging_face_hugging_face_content_href, set_label, opts = {}) ⇒ SetLabelResponse
Set a label Set a single pulp_label on the object to a specific value or null.
-
#set_label_with_http_info(hugging_face_hugging_face_content_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.
-
#unset_label(hugging_face_hugging_face_content_href, unset_label, opts = {}) ⇒ UnsetLabelResponse
Unset a label Unset a single pulp_label on the object.
-
#unset_label_with_http_info(hugging_face_hugging_face_content_href, unset_label, opts = {}) ⇒ Array<(UnsetLabelResponse, Integer, Hash)>
Unset a label Unset a single pulp_label on the object.
Constructor Details
#initialize(api_client = ApiClient.default) ⇒ ContentHuggingFaceApi
Returns a new instance of ContentHuggingFaceApi.
19 20 21 |
# File 'lib/pulp_hugging_face_client/api/content_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/content_hugging_face_api.rb', line 17 def api_client @api_client end |
Instance Method Details
#create(hugging_face_hugging_face_content, opts = {}) ⇒ HuggingFaceHuggingFaceContentResponse
Create a hugging face content Perform bookkeeping when saving Content. "Artifacts" need to be popped off and saved indpendently, as they are not actually part of the Content model.
28 29 30 31 |
# File 'lib/pulp_hugging_face_client/api/content_hugging_face_api.rb', line 28 def create(hugging_face_hugging_face_content, opts = {}) data, _status_code, _headers = create_with_http_info(hugging_face_hugging_face_content, opts) data end |
#create_with_http_info(hugging_face_hugging_face_content, opts = {}) ⇒ Array<(HuggingFaceHuggingFaceContentResponse, Integer, Hash)>
Create a hugging face content Perform bookkeeping when saving Content. "Artifacts" need to be popped off and saved indpendently, as they are not actually part of the Content model.
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/content_hugging_face_api.rb', line 39 def create_with_http_info(hugging_face_hugging_face_content, opts = {}) if @api_client.config.debugging @api_client.config.logger.debug 'Calling API: ContentHuggingFaceApi.create ...' end # verify the required parameter 'hugging_face_hugging_face_content' is set if @api_client.config.client_side_validation && hugging_face_hugging_face_content.nil? fail ArgumentError, "Missing the required parameter 'hugging_face_hugging_face_content' when calling ContentHuggingFaceApi.create" end # resource path local_var_path = '/pulp/api/v3/content/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_content) # return_type return_type = opts[:debug_return_type] || 'HuggingFaceHuggingFaceContentResponse' # auth_names auth_names = opts[:debug_auth_names] || ['basicAuth'] = opts.merge( :operation => :"ContentHuggingFaceApi.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, ) if @api_client.config.debugging @api_client.config.logger.debug "API called: ContentHuggingFaceApi#create\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}" end return data, status_code, headers end |
#list(opts = {}) ⇒ PaginatedhuggingFaceHuggingFaceContentResponseList
List hugging face contents
- A ViewSet for HuggingFaceContent. Define endpoint name which will appear in the API endpoint for this content type. For example
-
pulp.example.com/pulp/api/v3/content/hugging-face/units/ Also specify queryset and serializer for HuggingFaceContent.
116 117 118 119 |
# File 'lib/pulp_hugging_face_client/api/content_hugging_face_api.rb', line 116 def list(opts = {}) data, _status_code, _headers = list_with_http_info(opts) data end |
#list_with_http_info(opts = {}) ⇒ Array<(PaginatedhuggingFaceHuggingFaceContentResponseList, Integer, Hash)>
List hugging face contents
- A ViewSet for HuggingFaceContent. Define endpoint name which will appear in the API endpoint for this content type. For example
-
pulp.example.com/pulp/api/v3/content/hugging-face/units/ Also specify queryset and serializer for HuggingFaceContent.
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 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 |
# File 'lib/pulp_hugging_face_client/api/content_hugging_face_api.rb', line 144 def list_with_http_info(opts = {}) if @api_client.config.debugging @api_client.config.logger.debug 'Calling API: ContentHuggingFaceApi.list ...' end allowable_values = ["-etag", "-last_modified", "-pk", "-pulp_created", "-pulp_id", "-pulp_labels", "-pulp_last_updated", "-pulp_type", "-relative_path", "-repo_id", "-repo_type", "-revision", "-size", "-timestamp_of_interest", "-upstream_id", "etag", "last_modified", "pk", "pulp_created", "pulp_id", "pulp_labels", "pulp_last_updated", "pulp_type", "relative_path", "repo_id", "repo_type", "revision", "size", "timestamp_of_interest", "upstream_id"] 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 allowable_values = ["datasets", "models", "spaces"] if @api_client.config.client_side_validation && opts[:'repo_type'] && !allowable_values.include?(opts[:'repo_type']) fail ArgumentError, "invalid value for \"repo_type\", must be one of #{allowable_values}" end # resource path local_var_path = '/pulp/api/v3/content/hugging_face/hugging-face/' # query parameters query_params = opts[:query_params] || {} 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[:'orphaned_for'] = opts[:'orphaned_for'] if !opts[:'orphaned_for'].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[:'relative_path'] = opts[:'relative_path'] if !opts[:'relative_path'].nil? query_params[:'repo_id'] = opts[:'repo_id'] if !opts[:'repo_id'].nil? query_params[:'repo_type'] = opts[:'repo_type'] if !opts[:'repo_type'].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[:'revision'] = opts[:'revision'] if !opts[:'revision'].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] || 'PaginatedhuggingFaceHuggingFaceContentResponseList' # auth_names auth_names = opts[:debug_auth_names] || ['basicAuth'] = opts.merge( :operation => :"ContentHuggingFaceApi.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, ) if @api_client.config.debugging @api_client.config.logger.debug "API called: ContentHuggingFaceApi#list\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}" end return data, status_code, headers end |
#read(hugging_face_hugging_face_content_href, opts = {}) ⇒ HuggingFaceHuggingFaceContentResponse
Inspect a hugging face content
- A ViewSet for HuggingFaceContent. Define endpoint name which will appear in the API endpoint for this content type. For example
-
pulp.example.com/pulp/api/v3/content/hugging-face/units/ Also specify queryset and serializer for HuggingFaceContent.
223 224 225 226 |
# File 'lib/pulp_hugging_face_client/api/content_hugging_face_api.rb', line 223 def read(hugging_face_hugging_face_content_href, opts = {}) data, _status_code, _headers = read_with_http_info(hugging_face_hugging_face_content_href, opts) data end |
#read_with_http_info(hugging_face_hugging_face_content_href, opts = {}) ⇒ Array<(HuggingFaceHuggingFaceContentResponse, Integer, Hash)>
Inspect a hugging face content
- A ViewSet for HuggingFaceContent. Define endpoint name which will appear in the API endpoint for this content type. For example
-
pulp.example.com/pulp/api/v3/content/hugging-face/units/ Also specify queryset and serializer for HuggingFaceContent.
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 283 284 285 |
# File 'lib/pulp_hugging_face_client/api/content_hugging_face_api.rb', line 236 def read_with_http_info(hugging_face_hugging_face_content_href, opts = {}) if @api_client.config.debugging @api_client.config.logger.debug 'Calling API: ContentHuggingFaceApi.read ...' end # verify the required parameter 'hugging_face_hugging_face_content_href' is set if @api_client.config.client_side_validation && hugging_face_hugging_face_content_href.nil? fail ArgumentError, "Missing the required parameter 'hugging_face_hugging_face_content_href' when calling ContentHuggingFaceApi.read" end # resource path local_var_path = '{hugging_face_hugging_face_content_href}'.sub('{' + 'hugging_face_hugging_face_content_href' + '}', CGI.escape(hugging_face_hugging_face_content_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] || 'HuggingFaceHuggingFaceContentResponse' # auth_names auth_names = opts[:debug_auth_names] || ['basicAuth'] = opts.merge( :operation => :"ContentHuggingFaceApi.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, ) if @api_client.config.debugging @api_client.config.logger.debug "API called: ContentHuggingFaceApi#read\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}" end return data, status_code, headers end |
#set_label(hugging_face_hugging_face_content_href, set_label, opts = {}) ⇒ SetLabelResponse
Set a label Set a single pulp_label on the object to a specific value or null.
294 295 296 297 |
# File 'lib/pulp_hugging_face_client/api/content_hugging_face_api.rb', line 294 def set_label(hugging_face_hugging_face_content_href, set_label, opts = {}) data, _status_code, _headers = set_label_with_http_info(hugging_face_hugging_face_content_href, set_label, opts) data end |
#set_label_with_http_info(hugging_face_hugging_face_content_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.
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 355 356 357 358 359 360 361 362 |
# File 'lib/pulp_hugging_face_client/api/content_hugging_face_api.rb', line 306 def set_label_with_http_info(hugging_face_hugging_face_content_href, set_label, opts = {}) if @api_client.config.debugging @api_client.config.logger.debug 'Calling API: ContentHuggingFaceApi.set_label ...' end # verify the required parameter 'hugging_face_hugging_face_content_href' is set if @api_client.config.client_side_validation && hugging_face_hugging_face_content_href.nil? fail ArgumentError, "Missing the required parameter 'hugging_face_hugging_face_content_href' when calling ContentHuggingFaceApi.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 ContentHuggingFaceApi.set_label" end # resource path local_var_path = '{hugging_face_hugging_face_content_href}set_label/'.sub('{' + 'hugging_face_hugging_face_content_href' + '}', CGI.escape(hugging_face_hugging_face_content_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'] = opts.merge( :operation => :"ContentHuggingFaceApi.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, ) if @api_client.config.debugging @api_client.config.logger.debug "API called: ContentHuggingFaceApi#set_label\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}" end return data, status_code, headers end |
#unset_label(hugging_face_hugging_face_content_href, unset_label, opts = {}) ⇒ UnsetLabelResponse
Unset a label Unset a single pulp_label on the object.
371 372 373 374 |
# File 'lib/pulp_hugging_face_client/api/content_hugging_face_api.rb', line 371 def unset_label(hugging_face_hugging_face_content_href, unset_label, opts = {}) data, _status_code, _headers = unset_label_with_http_info(hugging_face_hugging_face_content_href, unset_label, opts) data end |
#unset_label_with_http_info(hugging_face_hugging_face_content_href, unset_label, opts = {}) ⇒ Array<(UnsetLabelResponse, Integer, Hash)>
Unset a label Unset a single pulp_label on the object.
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 413 414 415 416 417 418 419 420 421 422 423 424 425 426 427 428 429 430 431 432 433 434 435 436 437 438 439 |
# File 'lib/pulp_hugging_face_client/api/content_hugging_face_api.rb', line 383 def unset_label_with_http_info(hugging_face_hugging_face_content_href, unset_label, opts = {}) if @api_client.config.debugging @api_client.config.logger.debug 'Calling API: ContentHuggingFaceApi.unset_label ...' end # verify the required parameter 'hugging_face_hugging_face_content_href' is set if @api_client.config.client_side_validation && hugging_face_hugging_face_content_href.nil? fail ArgumentError, "Missing the required parameter 'hugging_face_hugging_face_content_href' when calling ContentHuggingFaceApi.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 ContentHuggingFaceApi.unset_label" end # resource path local_var_path = '{hugging_face_hugging_face_content_href}unset_label/'.sub('{' + 'hugging_face_hugging_face_content_href' + '}', CGI.escape(hugging_face_hugging_face_content_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'] = opts.merge( :operation => :"ContentHuggingFaceApi.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, ) if @api_client.config.debugging @api_client.config.logger.debug "API called: ContentHuggingFaceApi#unset_label\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}" end return data, status_code, headers end |