pulp_hugging_face_client 0.0.1

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (126) hide show
  1. checksums.yaml +7 -0
  2. data/Gemfile +9 -0
  3. data/README.md +176 -0
  4. data/Rakefile +10 -0
  5. data/docs/AsyncOperationResponse.md +18 -0
  6. data/docs/ContentHuggingFaceApi.md +424 -0
  7. data/docs/ContentSummaryResponse.md +22 -0
  8. data/docs/DistributionsHuggingFaceApi.md +671 -0
  9. data/docs/HuggingFaceHuggingFaceContent.md +36 -0
  10. data/docs/HuggingFaceHuggingFaceContentResponse.md +42 -0
  11. data/docs/HuggingFaceHuggingFaceDistribution.md +32 -0
  12. data/docs/HuggingFaceHuggingFaceDistributionResponse.md +44 -0
  13. data/docs/HuggingFaceHuggingFacePublication.md +20 -0
  14. data/docs/HuggingFaceHuggingFacePublicationResponse.md +28 -0
  15. data/docs/HuggingFaceHuggingFaceRemote.md +62 -0
  16. data/docs/HuggingFaceHuggingFaceRemoteResponse.md +62 -0
  17. data/docs/HuggingFaceHuggingFaceRemoteResponseHiddenFieldsInner.md +20 -0
  18. data/docs/HuggingFaceHuggingFaceRepository.md +26 -0
  19. data/docs/HuggingFaceHuggingFaceRepositoryResponse.md +38 -0
  20. data/docs/PaginatedRepositoryVersionResponseList.md +24 -0
  21. data/docs/PaginatedhuggingFaceHuggingFaceContentResponseList.md +24 -0
  22. data/docs/PaginatedhuggingFaceHuggingFaceDistributionResponseList.md +24 -0
  23. data/docs/PaginatedhuggingFaceHuggingFacePublicationResponseList.md +24 -0
  24. data/docs/PaginatedhuggingFaceHuggingFaceRemoteResponseList.md +24 -0
  25. data/docs/PaginatedhuggingFaceHuggingFaceRepositoryResponseList.md +24 -0
  26. data/docs/PatchedhuggingFaceHuggingFaceDistribution.md +32 -0
  27. data/docs/PatchedhuggingFaceHuggingFaceRemote.md +62 -0
  28. data/docs/PatchedhuggingFaceHuggingFaceRepository.md +26 -0
  29. data/docs/PolicyEnum.md +15 -0
  30. data/docs/PublicationsHuggingFaceApi.md +350 -0
  31. data/docs/RemotesHuggingFaceApi.md +669 -0
  32. data/docs/Repair.md +18 -0
  33. data/docs/RepoTypeEnum.md +15 -0
  34. data/docs/RepositoriesHuggingFaceApi.md +831 -0
  35. data/docs/RepositoriesHuggingFaceVersionsApi.md +359 -0
  36. data/docs/RepositoryAddRemoveContent.md +22 -0
  37. data/docs/RepositorySyncURL.md +20 -0
  38. data/docs/RepositoryVersionResponse.md +32 -0
  39. data/docs/SetLabel.md +20 -0
  40. data/docs/SetLabelResponse.md +20 -0
  41. data/docs/UnsetLabel.md +18 -0
  42. data/docs/UnsetLabelResponse.md +20 -0
  43. data/lib/pulp_hugging_face_client/api/content_hugging_face_api.rb +441 -0
  44. data/lib/pulp_hugging_face_client/api/distributions_hugging_face_api.rb +684 -0
  45. data/lib/pulp_hugging_face_client/api/publications_hugging_face_api.rb +356 -0
  46. data/lib/pulp_hugging_face_client/api/remotes_hugging_face_api.rb +681 -0
  47. data/lib/pulp_hugging_face_client/api/repositories_hugging_face_api.rb +847 -0
  48. data/lib/pulp_hugging_face_client/api/repositories_hugging_face_versions_api.rb +374 -0
  49. data/lib/pulp_hugging_face_client/api_client.rb +438 -0
  50. data/lib/pulp_hugging_face_client/api_error.rb +58 -0
  51. data/lib/pulp_hugging_face_client/configuration.rb +392 -0
  52. data/lib/pulp_hugging_face_client/models/async_operation_response.rb +223 -0
  53. data/lib/pulp_hugging_face_client/models/content_summary_response.rb +260 -0
  54. data/lib/pulp_hugging_face_client/models/hugging_face_hugging_face_content.rb +428 -0
  55. data/lib/pulp_hugging_face_client/models/hugging_face_hugging_face_content_response.rb +385 -0
  56. data/lib/pulp_hugging_face_client/models/hugging_face_hugging_face_distribution.rb +345 -0
  57. data/lib/pulp_hugging_face_client/models/hugging_face_hugging_face_distribution_response.rb +366 -0
  58. data/lib/pulp_hugging_face_client/models/hugging_face_hugging_face_publication.rb +225 -0
  59. data/lib/pulp_hugging_face_client/models/hugging_face_hugging_face_publication_response.rb +264 -0
  60. data/lib/pulp_hugging_face_client/models/hugging_face_hugging_face_remote.rb +745 -0
  61. data/lib/pulp_hugging_face_client/models/hugging_face_hugging_face_remote_response.rb +564 -0
  62. data/lib/pulp_hugging_face_client/models/hugging_face_hugging_face_remote_response_hidden_fields_inner.rb +237 -0
  63. data/lib/pulp_hugging_face_client/models/hugging_face_hugging_face_repository.rb +316 -0
  64. data/lib/pulp_hugging_face_client/models/hugging_face_hugging_face_repository_response.rb +339 -0
  65. data/lib/pulp_hugging_face_client/models/paginated_repository_version_response_list.rb +259 -0
  66. data/lib/pulp_hugging_face_client/models/paginatedhugging_face_hugging_face_content_response_list.rb +259 -0
  67. data/lib/pulp_hugging_face_client/models/paginatedhugging_face_hugging_face_distribution_response_list.rb +259 -0
  68. data/lib/pulp_hugging_face_client/models/paginatedhugging_face_hugging_face_publication_response_list.rb +259 -0
  69. data/lib/pulp_hugging_face_client/models/paginatedhugging_face_hugging_face_remote_response_list.rb +259 -0
  70. data/lib/pulp_hugging_face_client/models/paginatedhugging_face_hugging_face_repository_response_list.rb +259 -0
  71. data/lib/pulp_hugging_face_client/models/patchedhugging_face_hugging_face_distribution.rb +331 -0
  72. data/lib/pulp_hugging_face_client/models/patchedhugging_face_hugging_face_remote.rb +731 -0
  73. data/lib/pulp_hugging_face_client/models/patchedhugging_face_hugging_face_repository.rb +309 -0
  74. data/lib/pulp_hugging_face_client/models/policy_enum.rb +41 -0
  75. data/lib/pulp_hugging_face_client/models/repair.rb +217 -0
  76. data/lib/pulp_hugging_face_client/models/repo_type_enum.rb +41 -0
  77. data/lib/pulp_hugging_face_client/models/repository_add_remove_content.rb +240 -0
  78. data/lib/pulp_hugging_face_client/models/repository_sync_url.rb +228 -0
  79. data/lib/pulp_hugging_face_client/models/repository_version_response.rb +283 -0
  80. data/lib/pulp_hugging_face_client/models/set_label.rb +264 -0
  81. data/lib/pulp_hugging_face_client/models/set_label_response.rb +255 -0
  82. data/lib/pulp_hugging_face_client/models/unset_label.rb +252 -0
  83. data/lib/pulp_hugging_face_client/models/unset_label_response.rb +252 -0
  84. data/lib/pulp_hugging_face_client/version.rb +15 -0
  85. data/lib/pulp_hugging_face_client.rb +77 -0
  86. data/pulp_hugging_face_client.gemspec +41 -0
  87. data/spec/api/content_hugging_face_api_spec.rb +121 -0
  88. data/spec/api/distributions_hugging_face_api_spec.rb +171 -0
  89. data/spec/api/publications_hugging_face_api_spec.rb +109 -0
  90. data/spec/api/remotes_hugging_face_api_spec.rb +170 -0
  91. data/spec/api/repositories_hugging_face_api_spec.rb +202 -0
  92. data/spec/api/repositories_hugging_face_versions_api_spec.rb +112 -0
  93. data/spec/models/async_operation_response_spec.rb +36 -0
  94. data/spec/models/content_summary_response_spec.rb +48 -0
  95. data/spec/models/hugging_face_hugging_face_content_response_spec.rb +108 -0
  96. data/spec/models/hugging_face_hugging_face_content_spec.rb +90 -0
  97. data/spec/models/hugging_face_hugging_face_distribution_response_spec.rb +114 -0
  98. data/spec/models/hugging_face_hugging_face_distribution_spec.rb +78 -0
  99. data/spec/models/hugging_face_hugging_face_publication_response_spec.rb +66 -0
  100. data/spec/models/hugging_face_hugging_face_publication_spec.rb +42 -0
  101. data/spec/models/hugging_face_hugging_face_remote_response_hidden_fields_inner_spec.rb +42 -0
  102. data/spec/models/hugging_face_hugging_face_remote_response_spec.rb +168 -0
  103. data/spec/models/hugging_face_hugging_face_remote_spec.rb +168 -0
  104. data/spec/models/hugging_face_hugging_face_repository_response_spec.rb +96 -0
  105. data/spec/models/hugging_face_hugging_face_repository_spec.rb +60 -0
  106. data/spec/models/paginated_repository_version_response_list_spec.rb +54 -0
  107. data/spec/models/paginatedhugging_face_hugging_face_content_response_list_spec.rb +54 -0
  108. data/spec/models/paginatedhugging_face_hugging_face_distribution_response_list_spec.rb +54 -0
  109. data/spec/models/paginatedhugging_face_hugging_face_publication_response_list_spec.rb +54 -0
  110. data/spec/models/paginatedhugging_face_hugging_face_remote_response_list_spec.rb +54 -0
  111. data/spec/models/paginatedhugging_face_hugging_face_repository_response_list_spec.rb +54 -0
  112. data/spec/models/patchedhugging_face_hugging_face_distribution_spec.rb +78 -0
  113. data/spec/models/patchedhugging_face_hugging_face_remote_spec.rb +168 -0
  114. data/spec/models/patchedhugging_face_hugging_face_repository_spec.rb +60 -0
  115. data/spec/models/policy_enum_spec.rb +30 -0
  116. data/spec/models/repair_spec.rb +36 -0
  117. data/spec/models/repo_type_enum_spec.rb +30 -0
  118. data/spec/models/repository_add_remove_content_spec.rb +48 -0
  119. data/spec/models/repository_sync_url_spec.rb +42 -0
  120. data/spec/models/repository_version_response_spec.rb +78 -0
  121. data/spec/models/set_label_response_spec.rb +42 -0
  122. data/spec/models/set_label_spec.rb +42 -0
  123. data/spec/models/unset_label_response_spec.rb +42 -0
  124. data/spec/models/unset_label_spec.rb +36 -0
  125. data/spec/spec_helper.rb +111 -0
  126. metadata +274 -0
@@ -0,0 +1,669 @@
1
+ # PulpHuggingFaceClient::RemotesHuggingFaceApi
2
+
3
+ All URIs are relative to *http://localhost:24817*
4
+
5
+ | Method | HTTP request | Description |
6
+ | ------ | ------------ | ----------- |
7
+ | [**create**](RemotesHuggingFaceApi.md#create) | **POST** /pulp/api/v3/remotes/hugging_face/hugging-face/ | Create a hugging face remote |
8
+ | [**delete**](RemotesHuggingFaceApi.md#delete) | **DELETE** {hugging_face_hugging_face_remote_href} | Delete a hugging face remote |
9
+ | [**list**](RemotesHuggingFaceApi.md#list) | **GET** /pulp/api/v3/remotes/hugging_face/hugging-face/ | List hugging face remotes |
10
+ | [**partial_update**](RemotesHuggingFaceApi.md#partial_update) | **PATCH** {hugging_face_hugging_face_remote_href} | Update a hugging face remote |
11
+ | [**read**](RemotesHuggingFaceApi.md#read) | **GET** {hugging_face_hugging_face_remote_href} | Inspect a hugging face remote |
12
+ | [**set_label**](RemotesHuggingFaceApi.md#set_label) | **POST** {hugging_face_hugging_face_remote_href}set_label/ | Set a label |
13
+ | [**unset_label**](RemotesHuggingFaceApi.md#unset_label) | **POST** {hugging_face_hugging_face_remote_href}unset_label/ | Unset a label |
14
+ | [**update**](RemotesHuggingFaceApi.md#update) | **PUT** {hugging_face_hugging_face_remote_href} | Update a hugging face remote |
15
+
16
+
17
+ ## create
18
+
19
+ > <HuggingFaceHuggingFaceRemoteResponse> create(hugging_face_hugging_face_remote, opts)
20
+
21
+ Create a hugging face remote
22
+
23
+ A ViewSet for HuggingFaceRemote. Similar to the HuggingFaceContentViewSet above, define endpoint_name, queryset and serializer, at a minimum.
24
+
25
+ ### Examples
26
+
27
+ ```ruby
28
+ require 'time'
29
+ require 'pulp_hugging_face_client'
30
+ # setup authorization
31
+ PulpHuggingFaceClient.configure do |config|
32
+ # Configure HTTP basic authorization: basicAuth
33
+ config.username = 'YOUR USERNAME'
34
+ config.password = 'YOUR PASSWORD'
35
+ end
36
+
37
+ api_instance = PulpHuggingFaceClient::RemotesHuggingFaceApi.new
38
+ hugging_face_hugging_face_remote = PulpHuggingFaceClient::HuggingFaceHuggingFaceRemote.new({name: 'name_example', url: 'url_example'}) # HuggingFaceHuggingFaceRemote |
39
+ opts = {
40
+ x_task_diagnostics: ['inner_example'] # Array<String> | List of profilers to use on tasks.
41
+ }
42
+
43
+ begin
44
+ # Create a hugging face remote
45
+ result = api_instance.create(hugging_face_hugging_face_remote, opts)
46
+ p result
47
+ rescue PulpHuggingFaceClient::ApiError => e
48
+ puts "Error when calling RemotesHuggingFaceApi->create: #{e}"
49
+ end
50
+ ```
51
+
52
+ #### Using the create_with_http_info variant
53
+
54
+ This returns an Array which contains the response data, status code and headers.
55
+
56
+ > <Array(<HuggingFaceHuggingFaceRemoteResponse>, Integer, Hash)> create_with_http_info(hugging_face_hugging_face_remote, opts)
57
+
58
+ ```ruby
59
+ begin
60
+ # Create a hugging face remote
61
+ data, status_code, headers = api_instance.create_with_http_info(hugging_face_hugging_face_remote, opts)
62
+ p status_code # => 2xx
63
+ p headers # => { ... }
64
+ p data # => <HuggingFaceHuggingFaceRemoteResponse>
65
+ rescue PulpHuggingFaceClient::ApiError => e
66
+ puts "Error when calling RemotesHuggingFaceApi->create_with_http_info: #{e}"
67
+ end
68
+ ```
69
+
70
+ ### Parameters
71
+
72
+ | Name | Type | Description | Notes |
73
+ | ---- | ---- | ----------- | ----- |
74
+ | **hugging_face_hugging_face_remote** | [**HuggingFaceHuggingFaceRemote**](HuggingFaceHuggingFaceRemote.md) | | |
75
+ | **x_task_diagnostics** | [**Array&lt;String&gt;**](String.md) | List of profilers to use on tasks. | [optional] |
76
+
77
+ ### Return type
78
+
79
+ [**HuggingFaceHuggingFaceRemoteResponse**](HuggingFaceHuggingFaceRemoteResponse.md)
80
+
81
+ ### Authorization
82
+
83
+ [basicAuth](../README.md#basicAuth)
84
+
85
+ ### HTTP request headers
86
+
87
+ - **Content-Type**: application/json, application/x-www-form-urlencoded, multipart/form-data
88
+ - **Accept**: application/json
89
+
90
+
91
+ ## delete
92
+
93
+ > <AsyncOperationResponse> delete(hugging_face_hugging_face_remote_href, opts)
94
+
95
+ Delete a hugging face remote
96
+
97
+ Trigger an asynchronous delete task
98
+
99
+ ### Examples
100
+
101
+ ```ruby
102
+ require 'time'
103
+ require 'pulp_hugging_face_client'
104
+ # setup authorization
105
+ PulpHuggingFaceClient.configure do |config|
106
+ # Configure HTTP basic authorization: basicAuth
107
+ config.username = 'YOUR USERNAME'
108
+ config.password = 'YOUR PASSWORD'
109
+ end
110
+
111
+ api_instance = PulpHuggingFaceClient::RemotesHuggingFaceApi.new
112
+ hugging_face_hugging_face_remote_href = 'hugging_face_hugging_face_remote_href_example' # String |
113
+ opts = {
114
+ x_task_diagnostics: ['inner_example'] # Array<String> | List of profilers to use on tasks.
115
+ }
116
+
117
+ begin
118
+ # Delete a hugging face remote
119
+ result = api_instance.delete(hugging_face_hugging_face_remote_href, opts)
120
+ p result
121
+ rescue PulpHuggingFaceClient::ApiError => e
122
+ puts "Error when calling RemotesHuggingFaceApi->delete: #{e}"
123
+ end
124
+ ```
125
+
126
+ #### Using the delete_with_http_info variant
127
+
128
+ This returns an Array which contains the response data, status code and headers.
129
+
130
+ > <Array(<AsyncOperationResponse>, Integer, Hash)> delete_with_http_info(hugging_face_hugging_face_remote_href, opts)
131
+
132
+ ```ruby
133
+ begin
134
+ # Delete a hugging face remote
135
+ data, status_code, headers = api_instance.delete_with_http_info(hugging_face_hugging_face_remote_href, opts)
136
+ p status_code # => 2xx
137
+ p headers # => { ... }
138
+ p data # => <AsyncOperationResponse>
139
+ rescue PulpHuggingFaceClient::ApiError => e
140
+ puts "Error when calling RemotesHuggingFaceApi->delete_with_http_info: #{e}"
141
+ end
142
+ ```
143
+
144
+ ### Parameters
145
+
146
+ | Name | Type | Description | Notes |
147
+ | ---- | ---- | ----------- | ----- |
148
+ | **hugging_face_hugging_face_remote_href** | **String** | | |
149
+ | **x_task_diagnostics** | [**Array&lt;String&gt;**](String.md) | List of profilers to use on tasks. | [optional] |
150
+
151
+ ### Return type
152
+
153
+ [**AsyncOperationResponse**](AsyncOperationResponse.md)
154
+
155
+ ### Authorization
156
+
157
+ [basicAuth](../README.md#basicAuth)
158
+
159
+ ### HTTP request headers
160
+
161
+ - **Content-Type**: Not defined
162
+ - **Accept**: application/json
163
+
164
+
165
+ ## list
166
+
167
+ > <PaginatedhuggingFaceHuggingFaceRemoteResponseList> list(opts)
168
+
169
+ List hugging face remotes
170
+
171
+ A ViewSet for HuggingFaceRemote. Similar to the HuggingFaceContentViewSet above, define endpoint_name, queryset and serializer, at a minimum.
172
+
173
+ ### Examples
174
+
175
+ ```ruby
176
+ require 'time'
177
+ require 'pulp_hugging_face_client'
178
+ # setup authorization
179
+ PulpHuggingFaceClient.configure do |config|
180
+ # Configure HTTP basic authorization: basicAuth
181
+ config.username = 'YOUR USERNAME'
182
+ config.password = 'YOUR PASSWORD'
183
+ end
184
+
185
+ api_instance = PulpHuggingFaceClient::RemotesHuggingFaceApi.new
186
+ opts = {
187
+ x_task_diagnostics: ['inner_example'], # Array<String> | List of profilers to use on tasks.
188
+ limit: 56, # Integer | Number of results to return per page.
189
+ name: 'name_example', # String | Filter results where name matches value
190
+ name__contains: 'name__contains_example', # String | Filter results where name contains value
191
+ name__icontains: 'name__icontains_example', # String | Filter results where name contains value
192
+ name__iexact: 'name__iexact_example', # String | Filter results where name matches value
193
+ name__in: ['inner_example'], # Array<String> | Filter results where name is in a comma-separated list of values
194
+ name__iregex: 'name__iregex_example', # String | Filter results where name matches regex value
195
+ name__istartswith: 'name__istartswith_example', # String | Filter results where name starts with value
196
+ name__regex: 'name__regex_example', # String | Filter results where name matches regex value
197
+ name__startswith: 'name__startswith_example', # String | Filter results where name starts with value
198
+ offset: 56, # Integer | The initial index from which to return the results.
199
+ ordering: ['-ca_cert'], # Array<String> | Ordering * `pulp_id` - Pulp id * `-pulp_id` - Pulp id (descending) * `pulp_created` - Pulp created * `-pulp_created` - Pulp created (descending) * `pulp_last_updated` - Pulp last updated * `-pulp_last_updated` - Pulp last updated (descending) * `pulp_type` - Pulp type * `-pulp_type` - Pulp type (descending) * `name` - Name * `-name` - Name (descending) * `pulp_labels` - Pulp labels * `-pulp_labels` - Pulp labels (descending) * `url` - Url * `-url` - Url (descending) * `ca_cert` - Ca cert * `-ca_cert` - Ca cert (descending) * `client_cert` - Client cert * `-client_cert` - Client cert (descending) * `client_key` - Client key * `-client_key` - Client key (descending) * `tls_validation` - Tls validation * `-tls_validation` - Tls validation (descending) * `username` - Username * `-username` - Username (descending) * `password` - Password * `-password` - Password (descending) * `proxy_url` - Proxy url * `-proxy_url` - Proxy url (descending) * `proxy_username` - Proxy username * `-proxy_username` - Proxy username (descending) * `proxy_password` - Proxy password * `-proxy_password` - Proxy password (descending) * `download_concurrency` - Download concurrency * `-download_concurrency` - Download concurrency (descending) * `max_retries` - Max retries * `-max_retries` - Max retries (descending) * `policy` - Policy * `-policy` - Policy (descending) * `total_timeout` - Total timeout * `-total_timeout` - Total timeout (descending) * `connect_timeout` - Connect timeout * `-connect_timeout` - Connect timeout (descending) * `sock_connect_timeout` - Sock connect timeout * `-sock_connect_timeout` - Sock connect timeout (descending) * `sock_read_timeout` - Sock read timeout * `-sock_read_timeout` - Sock read timeout (descending) * `headers` - Headers * `-headers` - Headers (descending) * `rate_limit` - Rate limit * `-rate_limit` - Rate limit (descending) * `pk` - Pk * `-pk` - Pk (descending)
200
+ prn__in: ['inner_example'], # Array<String> | Multiple values may be separated by commas.
201
+ pulp_href__in: ['inner_example'], # Array<String> | Multiple values may be separated by commas.
202
+ pulp_id__in: ['inner_example'], # Array<String> | Multiple values may be separated by commas.
203
+ pulp_label_select: 'pulp_label_select_example', # String | Filter labels by search string
204
+ pulp_last_updated: Time.parse('2013-10-20T19:20:30+01:00'), # Time | Filter results where pulp_last_updated matches value
205
+ pulp_last_updated__gt: Time.parse('2013-10-20T19:20:30+01:00'), # Time | Filter results where pulp_last_updated is greater than value
206
+ pulp_last_updated__gte: Time.parse('2013-10-20T19:20:30+01:00'), # Time | Filter results where pulp_last_updated is greater than or equal to value
207
+ pulp_last_updated__isnull: true, # Boolean | Filter results where pulp_last_updated has a null value
208
+ pulp_last_updated__lt: Time.parse('2013-10-20T19:20:30+01:00'), # Time | Filter results where pulp_last_updated is less than value
209
+ pulp_last_updated__lte: Time.parse('2013-10-20T19:20:30+01:00'), # Time | Filter results where pulp_last_updated is less than or equal to value
210
+ pulp_last_updated__range: [Time.now], # Array<Time> | Filter results where pulp_last_updated is between two comma separated values
211
+ q: 'q_example', # String | Filter results by using NOT, AND and OR operations on other filters
212
+ fields: ['inner_example'], # Array<String> | A list of fields to include in the response.
213
+ exclude_fields: ['inner_example'] # Array<String> | A list of fields to exclude from the response.
214
+ }
215
+
216
+ begin
217
+ # List hugging face remotes
218
+ result = api_instance.list(opts)
219
+ p result
220
+ rescue PulpHuggingFaceClient::ApiError => e
221
+ puts "Error when calling RemotesHuggingFaceApi->list: #{e}"
222
+ end
223
+ ```
224
+
225
+ #### Using the list_with_http_info variant
226
+
227
+ This returns an Array which contains the response data, status code and headers.
228
+
229
+ > <Array(<PaginatedhuggingFaceHuggingFaceRemoteResponseList>, Integer, Hash)> list_with_http_info(opts)
230
+
231
+ ```ruby
232
+ begin
233
+ # List hugging face remotes
234
+ data, status_code, headers = api_instance.list_with_http_info(opts)
235
+ p status_code # => 2xx
236
+ p headers # => { ... }
237
+ p data # => <PaginatedhuggingFaceHuggingFaceRemoteResponseList>
238
+ rescue PulpHuggingFaceClient::ApiError => e
239
+ puts "Error when calling RemotesHuggingFaceApi->list_with_http_info: #{e}"
240
+ end
241
+ ```
242
+
243
+ ### Parameters
244
+
245
+ | Name | Type | Description | Notes |
246
+ | ---- | ---- | ----------- | ----- |
247
+ | **x_task_diagnostics** | [**Array&lt;String&gt;**](String.md) | List of profilers to use on tasks. | [optional] |
248
+ | **limit** | **Integer** | Number of results to return per page. | [optional] |
249
+ | **name** | **String** | Filter results where name matches value | [optional] |
250
+ | **name__contains** | **String** | Filter results where name contains value | [optional] |
251
+ | **name__icontains** | **String** | Filter results where name contains value | [optional] |
252
+ | **name__iexact** | **String** | Filter results where name matches value | [optional] |
253
+ | **name__in** | [**Array&lt;String&gt;**](String.md) | Filter results where name is in a comma-separated list of values | [optional] |
254
+ | **name__iregex** | **String** | Filter results where name matches regex value | [optional] |
255
+ | **name__istartswith** | **String** | Filter results where name starts with value | [optional] |
256
+ | **name__regex** | **String** | Filter results where name matches regex value | [optional] |
257
+ | **name__startswith** | **String** | Filter results where name starts with value | [optional] |
258
+ | **offset** | **Integer** | The initial index from which to return the results. | [optional] |
259
+ | **ordering** | [**Array&lt;String&gt;**](String.md) | 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;name&#x60; - Name * &#x60;-name&#x60; - Name (descending) * &#x60;pulp_labels&#x60; - Pulp labels * &#x60;-pulp_labels&#x60; - Pulp labels (descending) * &#x60;url&#x60; - Url * &#x60;-url&#x60; - Url (descending) * &#x60;ca_cert&#x60; - Ca cert * &#x60;-ca_cert&#x60; - Ca cert (descending) * &#x60;client_cert&#x60; - Client cert * &#x60;-client_cert&#x60; - Client cert (descending) * &#x60;client_key&#x60; - Client key * &#x60;-client_key&#x60; - Client key (descending) * &#x60;tls_validation&#x60; - Tls validation * &#x60;-tls_validation&#x60; - Tls validation (descending) * &#x60;username&#x60; - Username * &#x60;-username&#x60; - Username (descending) * &#x60;password&#x60; - Password * &#x60;-password&#x60; - Password (descending) * &#x60;proxy_url&#x60; - Proxy url * &#x60;-proxy_url&#x60; - Proxy url (descending) * &#x60;proxy_username&#x60; - Proxy username * &#x60;-proxy_username&#x60; - Proxy username (descending) * &#x60;proxy_password&#x60; - Proxy password * &#x60;-proxy_password&#x60; - Proxy password (descending) * &#x60;download_concurrency&#x60; - Download concurrency * &#x60;-download_concurrency&#x60; - Download concurrency (descending) * &#x60;max_retries&#x60; - Max retries * &#x60;-max_retries&#x60; - Max retries (descending) * &#x60;policy&#x60; - Policy * &#x60;-policy&#x60; - Policy (descending) * &#x60;total_timeout&#x60; - Total timeout * &#x60;-total_timeout&#x60; - Total timeout (descending) * &#x60;connect_timeout&#x60; - Connect timeout * &#x60;-connect_timeout&#x60; - Connect timeout (descending) * &#x60;sock_connect_timeout&#x60; - Sock connect timeout * &#x60;-sock_connect_timeout&#x60; - Sock connect timeout (descending) * &#x60;sock_read_timeout&#x60; - Sock read timeout * &#x60;-sock_read_timeout&#x60; - Sock read timeout (descending) * &#x60;headers&#x60; - Headers * &#x60;-headers&#x60; - Headers (descending) * &#x60;rate_limit&#x60; - Rate limit * &#x60;-rate_limit&#x60; - Rate limit (descending) * &#x60;pk&#x60; - Pk * &#x60;-pk&#x60; - Pk (descending) | [optional] |
260
+ | **prn__in** | [**Array&lt;String&gt;**](String.md) | Multiple values may be separated by commas. | [optional] |
261
+ | **pulp_href__in** | [**Array&lt;String&gt;**](String.md) | Multiple values may be separated by commas. | [optional] |
262
+ | **pulp_id__in** | [**Array&lt;String&gt;**](String.md) | Multiple values may be separated by commas. | [optional] |
263
+ | **pulp_label_select** | **String** | Filter labels by search string | [optional] |
264
+ | **pulp_last_updated** | **Time** | Filter results where pulp_last_updated matches value | [optional] |
265
+ | **pulp_last_updated__gt** | **Time** | Filter results where pulp_last_updated is greater than value | [optional] |
266
+ | **pulp_last_updated__gte** | **Time** | Filter results where pulp_last_updated is greater than or equal to value | [optional] |
267
+ | **pulp_last_updated__isnull** | **Boolean** | Filter results where pulp_last_updated has a null value | [optional] |
268
+ | **pulp_last_updated__lt** | **Time** | Filter results where pulp_last_updated is less than value | [optional] |
269
+ | **pulp_last_updated__lte** | **Time** | Filter results where pulp_last_updated is less than or equal to value | [optional] |
270
+ | **pulp_last_updated__range** | [**Array&lt;Time&gt;**](Time.md) | Filter results where pulp_last_updated is between two comma separated values | [optional] |
271
+ | **q** | **String** | Filter results by using NOT, AND and OR operations on other filters | [optional] |
272
+ | **fields** | [**Array&lt;String&gt;**](String.md) | A list of fields to include in the response. | [optional] |
273
+ | **exclude_fields** | [**Array&lt;String&gt;**](String.md) | A list of fields to exclude from the response. | [optional] |
274
+
275
+ ### Return type
276
+
277
+ [**PaginatedhuggingFaceHuggingFaceRemoteResponseList**](PaginatedhuggingFaceHuggingFaceRemoteResponseList.md)
278
+
279
+ ### Authorization
280
+
281
+ [basicAuth](../README.md#basicAuth)
282
+
283
+ ### HTTP request headers
284
+
285
+ - **Content-Type**: Not defined
286
+ - **Accept**: application/json
287
+
288
+
289
+ ## partial_update
290
+
291
+ > <AsyncOperationResponse> partial_update(hugging_face_hugging_face_remote_href, patchedhugging_face_hugging_face_remote, opts)
292
+
293
+ Update a hugging face remote
294
+
295
+ Trigger an asynchronous partial update task
296
+
297
+ ### Examples
298
+
299
+ ```ruby
300
+ require 'time'
301
+ require 'pulp_hugging_face_client'
302
+ # setup authorization
303
+ PulpHuggingFaceClient.configure do |config|
304
+ # Configure HTTP basic authorization: basicAuth
305
+ config.username = 'YOUR USERNAME'
306
+ config.password = 'YOUR PASSWORD'
307
+ end
308
+
309
+ api_instance = PulpHuggingFaceClient::RemotesHuggingFaceApi.new
310
+ hugging_face_hugging_face_remote_href = 'hugging_face_hugging_face_remote_href_example' # String |
311
+ patchedhugging_face_hugging_face_remote = PulpHuggingFaceClient::PatchedhuggingFaceHuggingFaceRemote.new # PatchedhuggingFaceHuggingFaceRemote |
312
+ opts = {
313
+ x_task_diagnostics: ['inner_example'] # Array<String> | List of profilers to use on tasks.
314
+ }
315
+
316
+ begin
317
+ # Update a hugging face remote
318
+ result = api_instance.partial_update(hugging_face_hugging_face_remote_href, patchedhugging_face_hugging_face_remote, opts)
319
+ p result
320
+ rescue PulpHuggingFaceClient::ApiError => e
321
+ puts "Error when calling RemotesHuggingFaceApi->partial_update: #{e}"
322
+ end
323
+ ```
324
+
325
+ #### Using the partial_update_with_http_info variant
326
+
327
+ This returns an Array which contains the response data, status code and headers.
328
+
329
+ > <Array(<AsyncOperationResponse>, Integer, Hash)> partial_update_with_http_info(hugging_face_hugging_face_remote_href, patchedhugging_face_hugging_face_remote, opts)
330
+
331
+ ```ruby
332
+ begin
333
+ # Update a hugging face remote
334
+ data, status_code, headers = api_instance.partial_update_with_http_info(hugging_face_hugging_face_remote_href, patchedhugging_face_hugging_face_remote, opts)
335
+ p status_code # => 2xx
336
+ p headers # => { ... }
337
+ p data # => <AsyncOperationResponse>
338
+ rescue PulpHuggingFaceClient::ApiError => e
339
+ puts "Error when calling RemotesHuggingFaceApi->partial_update_with_http_info: #{e}"
340
+ end
341
+ ```
342
+
343
+ ### Parameters
344
+
345
+ | Name | Type | Description | Notes |
346
+ | ---- | ---- | ----------- | ----- |
347
+ | **hugging_face_hugging_face_remote_href** | **String** | | |
348
+ | **patchedhugging_face_hugging_face_remote** | [**PatchedhuggingFaceHuggingFaceRemote**](PatchedhuggingFaceHuggingFaceRemote.md) | | |
349
+ | **x_task_diagnostics** | [**Array&lt;String&gt;**](String.md) | List of profilers to use on tasks. | [optional] |
350
+
351
+ ### Return type
352
+
353
+ [**AsyncOperationResponse**](AsyncOperationResponse.md)
354
+
355
+ ### Authorization
356
+
357
+ [basicAuth](../README.md#basicAuth)
358
+
359
+ ### HTTP request headers
360
+
361
+ - **Content-Type**: application/json, application/x-www-form-urlencoded, multipart/form-data
362
+ - **Accept**: application/json
363
+
364
+
365
+ ## read
366
+
367
+ > <HuggingFaceHuggingFaceRemoteResponse> read(hugging_face_hugging_face_remote_href, opts)
368
+
369
+ Inspect a hugging face remote
370
+
371
+ A ViewSet for HuggingFaceRemote. Similar to the HuggingFaceContentViewSet above, define endpoint_name, queryset and serializer, at a minimum.
372
+
373
+ ### Examples
374
+
375
+ ```ruby
376
+ require 'time'
377
+ require 'pulp_hugging_face_client'
378
+ # setup authorization
379
+ PulpHuggingFaceClient.configure do |config|
380
+ # Configure HTTP basic authorization: basicAuth
381
+ config.username = 'YOUR USERNAME'
382
+ config.password = 'YOUR PASSWORD'
383
+ end
384
+
385
+ api_instance = PulpHuggingFaceClient::RemotesHuggingFaceApi.new
386
+ hugging_face_hugging_face_remote_href = 'hugging_face_hugging_face_remote_href_example' # String |
387
+ opts = {
388
+ x_task_diagnostics: ['inner_example'], # Array<String> | List of profilers to use on tasks.
389
+ fields: ['inner_example'], # Array<String> | A list of fields to include in the response.
390
+ exclude_fields: ['inner_example'] # Array<String> | A list of fields to exclude from the response.
391
+ }
392
+
393
+ begin
394
+ # Inspect a hugging face remote
395
+ result = api_instance.read(hugging_face_hugging_face_remote_href, opts)
396
+ p result
397
+ rescue PulpHuggingFaceClient::ApiError => e
398
+ puts "Error when calling RemotesHuggingFaceApi->read: #{e}"
399
+ end
400
+ ```
401
+
402
+ #### Using the read_with_http_info variant
403
+
404
+ This returns an Array which contains the response data, status code and headers.
405
+
406
+ > <Array(<HuggingFaceHuggingFaceRemoteResponse>, Integer, Hash)> read_with_http_info(hugging_face_hugging_face_remote_href, opts)
407
+
408
+ ```ruby
409
+ begin
410
+ # Inspect a hugging face remote
411
+ data, status_code, headers = api_instance.read_with_http_info(hugging_face_hugging_face_remote_href, opts)
412
+ p status_code # => 2xx
413
+ p headers # => { ... }
414
+ p data # => <HuggingFaceHuggingFaceRemoteResponse>
415
+ rescue PulpHuggingFaceClient::ApiError => e
416
+ puts "Error when calling RemotesHuggingFaceApi->read_with_http_info: #{e}"
417
+ end
418
+ ```
419
+
420
+ ### Parameters
421
+
422
+ | Name | Type | Description | Notes |
423
+ | ---- | ---- | ----------- | ----- |
424
+ | **hugging_face_hugging_face_remote_href** | **String** | | |
425
+ | **x_task_diagnostics** | [**Array&lt;String&gt;**](String.md) | List of profilers to use on tasks. | [optional] |
426
+ | **fields** | [**Array&lt;String&gt;**](String.md) | A list of fields to include in the response. | [optional] |
427
+ | **exclude_fields** | [**Array&lt;String&gt;**](String.md) | A list of fields to exclude from the response. | [optional] |
428
+
429
+ ### Return type
430
+
431
+ [**HuggingFaceHuggingFaceRemoteResponse**](HuggingFaceHuggingFaceRemoteResponse.md)
432
+
433
+ ### Authorization
434
+
435
+ [basicAuth](../README.md#basicAuth)
436
+
437
+ ### HTTP request headers
438
+
439
+ - **Content-Type**: Not defined
440
+ - **Accept**: application/json
441
+
442
+
443
+ ## set_label
444
+
445
+ > <SetLabelResponse> set_label(hugging_face_hugging_face_remote_href, set_label, opts)
446
+
447
+ Set a label
448
+
449
+ Set a single pulp_label on the object to a specific value or null.
450
+
451
+ ### Examples
452
+
453
+ ```ruby
454
+ require 'time'
455
+ require 'pulp_hugging_face_client'
456
+ # setup authorization
457
+ PulpHuggingFaceClient.configure do |config|
458
+ # Configure HTTP basic authorization: basicAuth
459
+ config.username = 'YOUR USERNAME'
460
+ config.password = 'YOUR PASSWORD'
461
+ end
462
+
463
+ api_instance = PulpHuggingFaceClient::RemotesHuggingFaceApi.new
464
+ hugging_face_hugging_face_remote_href = 'hugging_face_hugging_face_remote_href_example' # String |
465
+ set_label = PulpHuggingFaceClient::SetLabel.new({key: 'key_example', value: 'value_example'}) # SetLabel |
466
+ opts = {
467
+ x_task_diagnostics: ['inner_example'] # Array<String> | List of profilers to use on tasks.
468
+ }
469
+
470
+ begin
471
+ # Set a label
472
+ result = api_instance.set_label(hugging_face_hugging_face_remote_href, set_label, opts)
473
+ p result
474
+ rescue PulpHuggingFaceClient::ApiError => e
475
+ puts "Error when calling RemotesHuggingFaceApi->set_label: #{e}"
476
+ end
477
+ ```
478
+
479
+ #### Using the set_label_with_http_info variant
480
+
481
+ This returns an Array which contains the response data, status code and headers.
482
+
483
+ > <Array(<SetLabelResponse>, Integer, Hash)> set_label_with_http_info(hugging_face_hugging_face_remote_href, set_label, opts)
484
+
485
+ ```ruby
486
+ begin
487
+ # Set a label
488
+ data, status_code, headers = api_instance.set_label_with_http_info(hugging_face_hugging_face_remote_href, set_label, opts)
489
+ p status_code # => 2xx
490
+ p headers # => { ... }
491
+ p data # => <SetLabelResponse>
492
+ rescue PulpHuggingFaceClient::ApiError => e
493
+ puts "Error when calling RemotesHuggingFaceApi->set_label_with_http_info: #{e}"
494
+ end
495
+ ```
496
+
497
+ ### Parameters
498
+
499
+ | Name | Type | Description | Notes |
500
+ | ---- | ---- | ----------- | ----- |
501
+ | **hugging_face_hugging_face_remote_href** | **String** | | |
502
+ | **set_label** | [**SetLabel**](SetLabel.md) | | |
503
+ | **x_task_diagnostics** | [**Array&lt;String&gt;**](String.md) | List of profilers to use on tasks. | [optional] |
504
+
505
+ ### Return type
506
+
507
+ [**SetLabelResponse**](SetLabelResponse.md)
508
+
509
+ ### Authorization
510
+
511
+ [basicAuth](../README.md#basicAuth)
512
+
513
+ ### HTTP request headers
514
+
515
+ - **Content-Type**: application/json, application/x-www-form-urlencoded, multipart/form-data
516
+ - **Accept**: application/json
517
+
518
+
519
+ ## unset_label
520
+
521
+ > <UnsetLabelResponse> unset_label(hugging_face_hugging_face_remote_href, unset_label, opts)
522
+
523
+ Unset a label
524
+
525
+ Unset a single pulp_label on the object.
526
+
527
+ ### Examples
528
+
529
+ ```ruby
530
+ require 'time'
531
+ require 'pulp_hugging_face_client'
532
+ # setup authorization
533
+ PulpHuggingFaceClient.configure do |config|
534
+ # Configure HTTP basic authorization: basicAuth
535
+ config.username = 'YOUR USERNAME'
536
+ config.password = 'YOUR PASSWORD'
537
+ end
538
+
539
+ api_instance = PulpHuggingFaceClient::RemotesHuggingFaceApi.new
540
+ hugging_face_hugging_face_remote_href = 'hugging_face_hugging_face_remote_href_example' # String |
541
+ unset_label = PulpHuggingFaceClient::UnsetLabel.new({key: 'key_example'}) # UnsetLabel |
542
+ opts = {
543
+ x_task_diagnostics: ['inner_example'] # Array<String> | List of profilers to use on tasks.
544
+ }
545
+
546
+ begin
547
+ # Unset a label
548
+ result = api_instance.unset_label(hugging_face_hugging_face_remote_href, unset_label, opts)
549
+ p result
550
+ rescue PulpHuggingFaceClient::ApiError => e
551
+ puts "Error when calling RemotesHuggingFaceApi->unset_label: #{e}"
552
+ end
553
+ ```
554
+
555
+ #### Using the unset_label_with_http_info variant
556
+
557
+ This returns an Array which contains the response data, status code and headers.
558
+
559
+ > <Array(<UnsetLabelResponse>, Integer, Hash)> unset_label_with_http_info(hugging_face_hugging_face_remote_href, unset_label, opts)
560
+
561
+ ```ruby
562
+ begin
563
+ # Unset a label
564
+ data, status_code, headers = api_instance.unset_label_with_http_info(hugging_face_hugging_face_remote_href, unset_label, opts)
565
+ p status_code # => 2xx
566
+ p headers # => { ... }
567
+ p data # => <UnsetLabelResponse>
568
+ rescue PulpHuggingFaceClient::ApiError => e
569
+ puts "Error when calling RemotesHuggingFaceApi->unset_label_with_http_info: #{e}"
570
+ end
571
+ ```
572
+
573
+ ### Parameters
574
+
575
+ | Name | Type | Description | Notes |
576
+ | ---- | ---- | ----------- | ----- |
577
+ | **hugging_face_hugging_face_remote_href** | **String** | | |
578
+ | **unset_label** | [**UnsetLabel**](UnsetLabel.md) | | |
579
+ | **x_task_diagnostics** | [**Array&lt;String&gt;**](String.md) | List of profilers to use on tasks. | [optional] |
580
+
581
+ ### Return type
582
+
583
+ [**UnsetLabelResponse**](UnsetLabelResponse.md)
584
+
585
+ ### Authorization
586
+
587
+ [basicAuth](../README.md#basicAuth)
588
+
589
+ ### HTTP request headers
590
+
591
+ - **Content-Type**: application/json, application/x-www-form-urlencoded, multipart/form-data
592
+ - **Accept**: application/json
593
+
594
+
595
+ ## update
596
+
597
+ > <AsyncOperationResponse> update(hugging_face_hugging_face_remote_href, hugging_face_hugging_face_remote, opts)
598
+
599
+ Update a hugging face remote
600
+
601
+ Trigger an asynchronous update task
602
+
603
+ ### Examples
604
+
605
+ ```ruby
606
+ require 'time'
607
+ require 'pulp_hugging_face_client'
608
+ # setup authorization
609
+ PulpHuggingFaceClient.configure do |config|
610
+ # Configure HTTP basic authorization: basicAuth
611
+ config.username = 'YOUR USERNAME'
612
+ config.password = 'YOUR PASSWORD'
613
+ end
614
+
615
+ api_instance = PulpHuggingFaceClient::RemotesHuggingFaceApi.new
616
+ hugging_face_hugging_face_remote_href = 'hugging_face_hugging_face_remote_href_example' # String |
617
+ hugging_face_hugging_face_remote = PulpHuggingFaceClient::HuggingFaceHuggingFaceRemote.new({name: 'name_example', url: 'url_example'}) # HuggingFaceHuggingFaceRemote |
618
+ opts = {
619
+ x_task_diagnostics: ['inner_example'] # Array<String> | List of profilers to use on tasks.
620
+ }
621
+
622
+ begin
623
+ # Update a hugging face remote
624
+ result = api_instance.update(hugging_face_hugging_face_remote_href, hugging_face_hugging_face_remote, opts)
625
+ p result
626
+ rescue PulpHuggingFaceClient::ApiError => e
627
+ puts "Error when calling RemotesHuggingFaceApi->update: #{e}"
628
+ end
629
+ ```
630
+
631
+ #### Using the update_with_http_info variant
632
+
633
+ This returns an Array which contains the response data, status code and headers.
634
+
635
+ > <Array(<AsyncOperationResponse>, Integer, Hash)> update_with_http_info(hugging_face_hugging_face_remote_href, hugging_face_hugging_face_remote, opts)
636
+
637
+ ```ruby
638
+ begin
639
+ # Update a hugging face remote
640
+ data, status_code, headers = api_instance.update_with_http_info(hugging_face_hugging_face_remote_href, hugging_face_hugging_face_remote, opts)
641
+ p status_code # => 2xx
642
+ p headers # => { ... }
643
+ p data # => <AsyncOperationResponse>
644
+ rescue PulpHuggingFaceClient::ApiError => e
645
+ puts "Error when calling RemotesHuggingFaceApi->update_with_http_info: #{e}"
646
+ end
647
+ ```
648
+
649
+ ### Parameters
650
+
651
+ | Name | Type | Description | Notes |
652
+ | ---- | ---- | ----------- | ----- |
653
+ | **hugging_face_hugging_face_remote_href** | **String** | | |
654
+ | **hugging_face_hugging_face_remote** | [**HuggingFaceHuggingFaceRemote**](HuggingFaceHuggingFaceRemote.md) | | |
655
+ | **x_task_diagnostics** | [**Array&lt;String&gt;**](String.md) | List of profilers to use on tasks. | [optional] |
656
+
657
+ ### Return type
658
+
659
+ [**AsyncOperationResponse**](AsyncOperationResponse.md)
660
+
661
+ ### Authorization
662
+
663
+ [basicAuth](../README.md#basicAuth)
664
+
665
+ ### HTTP request headers
666
+
667
+ - **Content-Type**: application/json, application/x-www-form-urlencoded, multipart/form-data
668
+ - **Accept**: application/json
669
+
data/docs/Repair.md ADDED
@@ -0,0 +1,18 @@
1
+ # PulpHuggingFaceClient::Repair
2
+
3
+ ## Properties
4
+
5
+ | Name | Type | Description | Notes |
6
+ | ---- | ---- | ----------- | ----- |
7
+ | **verify_checksums** | **Boolean** | Will verify that the checksum of all stored files matches what saved in the database. Otherwise only the existence of the files will be checked. Enabled by default | [optional][default to true] |
8
+
9
+ ## Example
10
+
11
+ ```ruby
12
+ require 'pulp_hugging_face_client'
13
+
14
+ instance = PulpHuggingFaceClient::Repair.new(
15
+ verify_checksums: null
16
+ )
17
+ ```
18
+