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,22 @@
1
+ # PulpHuggingFaceClient::ContentSummaryResponse
2
+
3
+ ## Properties
4
+
5
+ | Name | Type | Description | Notes |
6
+ | ---- | ---- | ----------- | ----- |
7
+ | **added** | **Hash<String, Object>** | | |
8
+ | **removed** | **Hash<String, Object>** | | |
9
+ | **present** | **Hash<String, Object>** | | |
10
+
11
+ ## Example
12
+
13
+ ```ruby
14
+ require 'pulp_hugging_face_client'
15
+
16
+ instance = PulpHuggingFaceClient::ContentSummaryResponse.new(
17
+ added: null,
18
+ removed: null,
19
+ present: null
20
+ )
21
+ ```
22
+
@@ -0,0 +1,671 @@
1
+ # PulpHuggingFaceClient::DistributionsHuggingFaceApi
2
+
3
+ All URIs are relative to *http://localhost:24817*
4
+
5
+ | Method | HTTP request | Description |
6
+ | ------ | ------------ | ----------- |
7
+ | [**create**](DistributionsHuggingFaceApi.md#create) | **POST** /pulp/api/v3/distributions/hugging_face/hugging-face/ | Create a hugging face distribution |
8
+ | [**delete**](DistributionsHuggingFaceApi.md#delete) | **DELETE** {hugging_face_hugging_face_distribution_href} | Delete a hugging face distribution |
9
+ | [**list**](DistributionsHuggingFaceApi.md#list) | **GET** /pulp/api/v3/distributions/hugging_face/hugging-face/ | List hugging face distributions |
10
+ | [**partial_update**](DistributionsHuggingFaceApi.md#partial_update) | **PATCH** {hugging_face_hugging_face_distribution_href} | Update a hugging face distribution |
11
+ | [**read**](DistributionsHuggingFaceApi.md#read) | **GET** {hugging_face_hugging_face_distribution_href} | Inspect a hugging face distribution |
12
+ | [**set_label**](DistributionsHuggingFaceApi.md#set_label) | **POST** {hugging_face_hugging_face_distribution_href}set_label/ | Set a label |
13
+ | [**unset_label**](DistributionsHuggingFaceApi.md#unset_label) | **POST** {hugging_face_hugging_face_distribution_href}unset_label/ | Unset a label |
14
+ | [**update**](DistributionsHuggingFaceApi.md#update) | **PUT** {hugging_face_hugging_face_distribution_href} | Update a hugging face distribution |
15
+
16
+
17
+ ## create
18
+
19
+ > <AsyncOperationResponse> create(hugging_face_hugging_face_distribution, opts)
20
+
21
+ Create a hugging face distribution
22
+
23
+ Trigger an asynchronous create task
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::DistributionsHuggingFaceApi.new
38
+ hugging_face_hugging_face_distribution = PulpHuggingFaceClient::HuggingFaceHuggingFaceDistribution.new({base_path: 'base_path_example', name: 'name_example'}) # HuggingFaceHuggingFaceDistribution |
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 distribution
45
+ result = api_instance.create(hugging_face_hugging_face_distribution, opts)
46
+ p result
47
+ rescue PulpHuggingFaceClient::ApiError => e
48
+ puts "Error when calling DistributionsHuggingFaceApi->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(<AsyncOperationResponse>, Integer, Hash)> create_with_http_info(hugging_face_hugging_face_distribution, opts)
57
+
58
+ ```ruby
59
+ begin
60
+ # Create a hugging face distribution
61
+ data, status_code, headers = api_instance.create_with_http_info(hugging_face_hugging_face_distribution, opts)
62
+ p status_code # => 2xx
63
+ p headers # => { ... }
64
+ p data # => <AsyncOperationResponse>
65
+ rescue PulpHuggingFaceClient::ApiError => e
66
+ puts "Error when calling DistributionsHuggingFaceApi->create_with_http_info: #{e}"
67
+ end
68
+ ```
69
+
70
+ ### Parameters
71
+
72
+ | Name | Type | Description | Notes |
73
+ | ---- | ---- | ----------- | ----- |
74
+ | **hugging_face_hugging_face_distribution** | [**HuggingFaceHuggingFaceDistribution**](HuggingFaceHuggingFaceDistribution.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
+ [**AsyncOperationResponse**](AsyncOperationResponse.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_distribution_href, opts)
94
+
95
+ Delete a hugging face distribution
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::DistributionsHuggingFaceApi.new
112
+ hugging_face_hugging_face_distribution_href = 'hugging_face_hugging_face_distribution_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 distribution
119
+ result = api_instance.delete(hugging_face_hugging_face_distribution_href, opts)
120
+ p result
121
+ rescue PulpHuggingFaceClient::ApiError => e
122
+ puts "Error when calling DistributionsHuggingFaceApi->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_distribution_href, opts)
131
+
132
+ ```ruby
133
+ begin
134
+ # Delete a hugging face distribution
135
+ data, status_code, headers = api_instance.delete_with_http_info(hugging_face_hugging_face_distribution_href, opts)
136
+ p status_code # => 2xx
137
+ p headers # => { ... }
138
+ p data # => <AsyncOperationResponse>
139
+ rescue PulpHuggingFaceClient::ApiError => e
140
+ puts "Error when calling DistributionsHuggingFaceApi->delete_with_http_info: #{e}"
141
+ end
142
+ ```
143
+
144
+ ### Parameters
145
+
146
+ | Name | Type | Description | Notes |
147
+ | ---- | ---- | ----------- | ----- |
148
+ | **hugging_face_hugging_face_distribution_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
+ > <PaginatedhuggingFaceHuggingFaceDistributionResponseList> list(opts)
168
+
169
+ List hugging face distributions
170
+
171
+ A ViewSet for HuggingFaceDistribution. 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::DistributionsHuggingFaceApi.new
186
+ opts = {
187
+ x_task_diagnostics: ['inner_example'], # Array<String> | List of profilers to use on tasks.
188
+ base_path: 'base_path_example', # String | Filter results where base_path matches value
189
+ base_path__contains: 'base_path__contains_example', # String | Filter results where base_path contains value
190
+ base_path__icontains: 'base_path__icontains_example', # String | Filter results where base_path contains value
191
+ base_path__in: ['inner_example'], # Array<String> | Filter results where base_path is in a comma-separated list of values
192
+ checkpoint: true, # Boolean | Filter results where checkpoint matches value
193
+ limit: 56, # Integer | Number of results to return per page.
194
+ name: 'name_example', # String | Filter results where name matches value
195
+ name__contains: 'name__contains_example', # String | Filter results where name contains value
196
+ name__icontains: 'name__icontains_example', # String | Filter results where name contains value
197
+ name__iexact: 'name__iexact_example', # String | Filter results where name matches value
198
+ name__in: ['inner_example'], # Array<String> | Filter results where name is in a comma-separated list of values
199
+ name__iregex: 'name__iregex_example', # String | Filter results where name matches regex value
200
+ name__istartswith: 'name__istartswith_example', # String | Filter results where name starts with value
201
+ name__regex: 'name__regex_example', # String | Filter results where name matches regex value
202
+ name__startswith: 'name__startswith_example', # String | Filter results where name starts with value
203
+ offset: 56, # Integer | The initial index from which to return the results.
204
+ ordering: ['-base_path'], # 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) * `base_path` - Base path * `-base_path` - Base path (descending) * `hidden` - Hidden * `-hidden` - Hidden (descending) * `checkpoint` - Checkpoint * `-checkpoint` - Checkpoint (descending) * `pk` - Pk * `-pk` - Pk (descending)
205
+ prn__in: ['inner_example'], # Array<String> | Multiple values may be separated by commas.
206
+ pulp_href__in: ['inner_example'], # Array<String> | Multiple values may be separated by commas.
207
+ pulp_id__in: ['inner_example'], # Array<String> | Multiple values may be separated by commas.
208
+ pulp_label_select: 'pulp_label_select_example', # String | Filter labels by search string
209
+ q: 'q_example', # String | Filter results by using NOT, AND and OR operations on other filters
210
+ repository: '38400000-8cf0-11bd-b23e-10b96e4ef00d', # String | Filter results where repository matches value
211
+ repository__in: ['inner_example'], # Array<String> | Filter results where repository is in a comma-separated list of values
212
+ with_content: 'with_content_example', # String | Filter distributions based on the content served by them
213
+ fields: ['inner_example'], # Array<String> | A list of fields to include in the response.
214
+ exclude_fields: ['inner_example'] # Array<String> | A list of fields to exclude from the response.
215
+ }
216
+
217
+ begin
218
+ # List hugging face distributions
219
+ result = api_instance.list(opts)
220
+ p result
221
+ rescue PulpHuggingFaceClient::ApiError => e
222
+ puts "Error when calling DistributionsHuggingFaceApi->list: #{e}"
223
+ end
224
+ ```
225
+
226
+ #### Using the list_with_http_info variant
227
+
228
+ This returns an Array which contains the response data, status code and headers.
229
+
230
+ > <Array(<PaginatedhuggingFaceHuggingFaceDistributionResponseList>, Integer, Hash)> list_with_http_info(opts)
231
+
232
+ ```ruby
233
+ begin
234
+ # List hugging face distributions
235
+ data, status_code, headers = api_instance.list_with_http_info(opts)
236
+ p status_code # => 2xx
237
+ p headers # => { ... }
238
+ p data # => <PaginatedhuggingFaceHuggingFaceDistributionResponseList>
239
+ rescue PulpHuggingFaceClient::ApiError => e
240
+ puts "Error when calling DistributionsHuggingFaceApi->list_with_http_info: #{e}"
241
+ end
242
+ ```
243
+
244
+ ### Parameters
245
+
246
+ | Name | Type | Description | Notes |
247
+ | ---- | ---- | ----------- | ----- |
248
+ | **x_task_diagnostics** | [**Array&lt;String&gt;**](String.md) | List of profilers to use on tasks. | [optional] |
249
+ | **base_path** | **String** | Filter results where base_path matches value | [optional] |
250
+ | **base_path__contains** | **String** | Filter results where base_path contains value | [optional] |
251
+ | **base_path__icontains** | **String** | Filter results where base_path contains value | [optional] |
252
+ | **base_path__in** | [**Array&lt;String&gt;**](String.md) | Filter results where base_path is in a comma-separated list of values | [optional] |
253
+ | **checkpoint** | **Boolean** | Filter results where checkpoint matches value | [optional] |
254
+ | **limit** | **Integer** | Number of results to return per page. | [optional] |
255
+ | **name** | **String** | Filter results where name matches value | [optional] |
256
+ | **name__contains** | **String** | Filter results where name contains value | [optional] |
257
+ | **name__icontains** | **String** | Filter results where name contains value | [optional] |
258
+ | **name__iexact** | **String** | Filter results where name matches value | [optional] |
259
+ | **name__in** | [**Array&lt;String&gt;**](String.md) | Filter results where name is in a comma-separated list of values | [optional] |
260
+ | **name__iregex** | **String** | Filter results where name matches regex value | [optional] |
261
+ | **name__istartswith** | **String** | Filter results where name starts with value | [optional] |
262
+ | **name__regex** | **String** | Filter results where name matches regex value | [optional] |
263
+ | **name__startswith** | **String** | Filter results where name starts with value | [optional] |
264
+ | **offset** | **Integer** | The initial index from which to return the results. | [optional] |
265
+ | **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;base_path&#x60; - Base path * &#x60;-base_path&#x60; - Base path (descending) * &#x60;hidden&#x60; - Hidden * &#x60;-hidden&#x60; - Hidden (descending) * &#x60;checkpoint&#x60; - Checkpoint * &#x60;-checkpoint&#x60; - Checkpoint (descending) * &#x60;pk&#x60; - Pk * &#x60;-pk&#x60; - Pk (descending) | [optional] |
266
+ | **prn__in** | [**Array&lt;String&gt;**](String.md) | Multiple values may be separated by commas. | [optional] |
267
+ | **pulp_href__in** | [**Array&lt;String&gt;**](String.md) | Multiple values may be separated by commas. | [optional] |
268
+ | **pulp_id__in** | [**Array&lt;String&gt;**](String.md) | Multiple values may be separated by commas. | [optional] |
269
+ | **pulp_label_select** | **String** | Filter labels by search string | [optional] |
270
+ | **q** | **String** | Filter results by using NOT, AND and OR operations on other filters | [optional] |
271
+ | **repository** | **String** | Filter results where repository matches value | [optional] |
272
+ | **repository__in** | [**Array&lt;String&gt;**](String.md) | Filter results where repository is in a comma-separated list of values | [optional] |
273
+ | **with_content** | **String** | Filter distributions based on the content served by them | [optional] |
274
+ | **fields** | [**Array&lt;String&gt;**](String.md) | A list of fields to include in the response. | [optional] |
275
+ | **exclude_fields** | [**Array&lt;String&gt;**](String.md) | A list of fields to exclude from the response. | [optional] |
276
+
277
+ ### Return type
278
+
279
+ [**PaginatedhuggingFaceHuggingFaceDistributionResponseList**](PaginatedhuggingFaceHuggingFaceDistributionResponseList.md)
280
+
281
+ ### Authorization
282
+
283
+ [basicAuth](../README.md#basicAuth)
284
+
285
+ ### HTTP request headers
286
+
287
+ - **Content-Type**: Not defined
288
+ - **Accept**: application/json
289
+
290
+
291
+ ## partial_update
292
+
293
+ > <AsyncOperationResponse> partial_update(hugging_face_hugging_face_distribution_href, patchedhugging_face_hugging_face_distribution, opts)
294
+
295
+ Update a hugging face distribution
296
+
297
+ Trigger an asynchronous partial update task
298
+
299
+ ### Examples
300
+
301
+ ```ruby
302
+ require 'time'
303
+ require 'pulp_hugging_face_client'
304
+ # setup authorization
305
+ PulpHuggingFaceClient.configure do |config|
306
+ # Configure HTTP basic authorization: basicAuth
307
+ config.username = 'YOUR USERNAME'
308
+ config.password = 'YOUR PASSWORD'
309
+ end
310
+
311
+ api_instance = PulpHuggingFaceClient::DistributionsHuggingFaceApi.new
312
+ hugging_face_hugging_face_distribution_href = 'hugging_face_hugging_face_distribution_href_example' # String |
313
+ patchedhugging_face_hugging_face_distribution = PulpHuggingFaceClient::PatchedhuggingFaceHuggingFaceDistribution.new # PatchedhuggingFaceHuggingFaceDistribution |
314
+ opts = {
315
+ x_task_diagnostics: ['inner_example'] # Array<String> | List of profilers to use on tasks.
316
+ }
317
+
318
+ begin
319
+ # Update a hugging face distribution
320
+ result = api_instance.partial_update(hugging_face_hugging_face_distribution_href, patchedhugging_face_hugging_face_distribution, opts)
321
+ p result
322
+ rescue PulpHuggingFaceClient::ApiError => e
323
+ puts "Error when calling DistributionsHuggingFaceApi->partial_update: #{e}"
324
+ end
325
+ ```
326
+
327
+ #### Using the partial_update_with_http_info variant
328
+
329
+ This returns an Array which contains the response data, status code and headers.
330
+
331
+ > <Array(<AsyncOperationResponse>, Integer, Hash)> partial_update_with_http_info(hugging_face_hugging_face_distribution_href, patchedhugging_face_hugging_face_distribution, opts)
332
+
333
+ ```ruby
334
+ begin
335
+ # Update a hugging face distribution
336
+ data, status_code, headers = api_instance.partial_update_with_http_info(hugging_face_hugging_face_distribution_href, patchedhugging_face_hugging_face_distribution, opts)
337
+ p status_code # => 2xx
338
+ p headers # => { ... }
339
+ p data # => <AsyncOperationResponse>
340
+ rescue PulpHuggingFaceClient::ApiError => e
341
+ puts "Error when calling DistributionsHuggingFaceApi->partial_update_with_http_info: #{e}"
342
+ end
343
+ ```
344
+
345
+ ### Parameters
346
+
347
+ | Name | Type | Description | Notes |
348
+ | ---- | ---- | ----------- | ----- |
349
+ | **hugging_face_hugging_face_distribution_href** | **String** | | |
350
+ | **patchedhugging_face_hugging_face_distribution** | [**PatchedhuggingFaceHuggingFaceDistribution**](PatchedhuggingFaceHuggingFaceDistribution.md) | | |
351
+ | **x_task_diagnostics** | [**Array&lt;String&gt;**](String.md) | List of profilers to use on tasks. | [optional] |
352
+
353
+ ### Return type
354
+
355
+ [**AsyncOperationResponse**](AsyncOperationResponse.md)
356
+
357
+ ### Authorization
358
+
359
+ [basicAuth](../README.md#basicAuth)
360
+
361
+ ### HTTP request headers
362
+
363
+ - **Content-Type**: application/json, application/x-www-form-urlencoded, multipart/form-data
364
+ - **Accept**: application/json
365
+
366
+
367
+ ## read
368
+
369
+ > <HuggingFaceHuggingFaceDistributionResponse> read(hugging_face_hugging_face_distribution_href, opts)
370
+
371
+ Inspect a hugging face distribution
372
+
373
+ A ViewSet for HuggingFaceDistribution. Similar to the HuggingFaceContentViewSet above, define endpoint_name, queryset and serializer, at a minimum.
374
+
375
+ ### Examples
376
+
377
+ ```ruby
378
+ require 'time'
379
+ require 'pulp_hugging_face_client'
380
+ # setup authorization
381
+ PulpHuggingFaceClient.configure do |config|
382
+ # Configure HTTP basic authorization: basicAuth
383
+ config.username = 'YOUR USERNAME'
384
+ config.password = 'YOUR PASSWORD'
385
+ end
386
+
387
+ api_instance = PulpHuggingFaceClient::DistributionsHuggingFaceApi.new
388
+ hugging_face_hugging_face_distribution_href = 'hugging_face_hugging_face_distribution_href_example' # String |
389
+ opts = {
390
+ x_task_diagnostics: ['inner_example'], # Array<String> | List of profilers to use on tasks.
391
+ fields: ['inner_example'], # Array<String> | A list of fields to include in the response.
392
+ exclude_fields: ['inner_example'] # Array<String> | A list of fields to exclude from the response.
393
+ }
394
+
395
+ begin
396
+ # Inspect a hugging face distribution
397
+ result = api_instance.read(hugging_face_hugging_face_distribution_href, opts)
398
+ p result
399
+ rescue PulpHuggingFaceClient::ApiError => e
400
+ puts "Error when calling DistributionsHuggingFaceApi->read: #{e}"
401
+ end
402
+ ```
403
+
404
+ #### Using the read_with_http_info variant
405
+
406
+ This returns an Array which contains the response data, status code and headers.
407
+
408
+ > <Array(<HuggingFaceHuggingFaceDistributionResponse>, Integer, Hash)> read_with_http_info(hugging_face_hugging_face_distribution_href, opts)
409
+
410
+ ```ruby
411
+ begin
412
+ # Inspect a hugging face distribution
413
+ data, status_code, headers = api_instance.read_with_http_info(hugging_face_hugging_face_distribution_href, opts)
414
+ p status_code # => 2xx
415
+ p headers # => { ... }
416
+ p data # => <HuggingFaceHuggingFaceDistributionResponse>
417
+ rescue PulpHuggingFaceClient::ApiError => e
418
+ puts "Error when calling DistributionsHuggingFaceApi->read_with_http_info: #{e}"
419
+ end
420
+ ```
421
+
422
+ ### Parameters
423
+
424
+ | Name | Type | Description | Notes |
425
+ | ---- | ---- | ----------- | ----- |
426
+ | **hugging_face_hugging_face_distribution_href** | **String** | | |
427
+ | **x_task_diagnostics** | [**Array&lt;String&gt;**](String.md) | List of profilers to use on tasks. | [optional] |
428
+ | **fields** | [**Array&lt;String&gt;**](String.md) | A list of fields to include in the response. | [optional] |
429
+ | **exclude_fields** | [**Array&lt;String&gt;**](String.md) | A list of fields to exclude from the response. | [optional] |
430
+
431
+ ### Return type
432
+
433
+ [**HuggingFaceHuggingFaceDistributionResponse**](HuggingFaceHuggingFaceDistributionResponse.md)
434
+
435
+ ### Authorization
436
+
437
+ [basicAuth](../README.md#basicAuth)
438
+
439
+ ### HTTP request headers
440
+
441
+ - **Content-Type**: Not defined
442
+ - **Accept**: application/json
443
+
444
+
445
+ ## set_label
446
+
447
+ > <SetLabelResponse> set_label(hugging_face_hugging_face_distribution_href, set_label, opts)
448
+
449
+ Set a label
450
+
451
+ Set a single pulp_label on the object to a specific value or null.
452
+
453
+ ### Examples
454
+
455
+ ```ruby
456
+ require 'time'
457
+ require 'pulp_hugging_face_client'
458
+ # setup authorization
459
+ PulpHuggingFaceClient.configure do |config|
460
+ # Configure HTTP basic authorization: basicAuth
461
+ config.username = 'YOUR USERNAME'
462
+ config.password = 'YOUR PASSWORD'
463
+ end
464
+
465
+ api_instance = PulpHuggingFaceClient::DistributionsHuggingFaceApi.new
466
+ hugging_face_hugging_face_distribution_href = 'hugging_face_hugging_face_distribution_href_example' # String |
467
+ set_label = PulpHuggingFaceClient::SetLabel.new({key: 'key_example', value: 'value_example'}) # SetLabel |
468
+ opts = {
469
+ x_task_diagnostics: ['inner_example'] # Array<String> | List of profilers to use on tasks.
470
+ }
471
+
472
+ begin
473
+ # Set a label
474
+ result = api_instance.set_label(hugging_face_hugging_face_distribution_href, set_label, opts)
475
+ p result
476
+ rescue PulpHuggingFaceClient::ApiError => e
477
+ puts "Error when calling DistributionsHuggingFaceApi->set_label: #{e}"
478
+ end
479
+ ```
480
+
481
+ #### Using the set_label_with_http_info variant
482
+
483
+ This returns an Array which contains the response data, status code and headers.
484
+
485
+ > <Array(<SetLabelResponse>, Integer, Hash)> set_label_with_http_info(hugging_face_hugging_face_distribution_href, set_label, opts)
486
+
487
+ ```ruby
488
+ begin
489
+ # Set a label
490
+ data, status_code, headers = api_instance.set_label_with_http_info(hugging_face_hugging_face_distribution_href, set_label, opts)
491
+ p status_code # => 2xx
492
+ p headers # => { ... }
493
+ p data # => <SetLabelResponse>
494
+ rescue PulpHuggingFaceClient::ApiError => e
495
+ puts "Error when calling DistributionsHuggingFaceApi->set_label_with_http_info: #{e}"
496
+ end
497
+ ```
498
+
499
+ ### Parameters
500
+
501
+ | Name | Type | Description | Notes |
502
+ | ---- | ---- | ----------- | ----- |
503
+ | **hugging_face_hugging_face_distribution_href** | **String** | | |
504
+ | **set_label** | [**SetLabel**](SetLabel.md) | | |
505
+ | **x_task_diagnostics** | [**Array&lt;String&gt;**](String.md) | List of profilers to use on tasks. | [optional] |
506
+
507
+ ### Return type
508
+
509
+ [**SetLabelResponse**](SetLabelResponse.md)
510
+
511
+ ### Authorization
512
+
513
+ [basicAuth](../README.md#basicAuth)
514
+
515
+ ### HTTP request headers
516
+
517
+ - **Content-Type**: application/json, application/x-www-form-urlencoded, multipart/form-data
518
+ - **Accept**: application/json
519
+
520
+
521
+ ## unset_label
522
+
523
+ > <UnsetLabelResponse> unset_label(hugging_face_hugging_face_distribution_href, unset_label, opts)
524
+
525
+ Unset a label
526
+
527
+ Unset a single pulp_label on the object.
528
+
529
+ ### Examples
530
+
531
+ ```ruby
532
+ require 'time'
533
+ require 'pulp_hugging_face_client'
534
+ # setup authorization
535
+ PulpHuggingFaceClient.configure do |config|
536
+ # Configure HTTP basic authorization: basicAuth
537
+ config.username = 'YOUR USERNAME'
538
+ config.password = 'YOUR PASSWORD'
539
+ end
540
+
541
+ api_instance = PulpHuggingFaceClient::DistributionsHuggingFaceApi.new
542
+ hugging_face_hugging_face_distribution_href = 'hugging_face_hugging_face_distribution_href_example' # String |
543
+ unset_label = PulpHuggingFaceClient::UnsetLabel.new({key: 'key_example'}) # UnsetLabel |
544
+ opts = {
545
+ x_task_diagnostics: ['inner_example'] # Array<String> | List of profilers to use on tasks.
546
+ }
547
+
548
+ begin
549
+ # Unset a label
550
+ result = api_instance.unset_label(hugging_face_hugging_face_distribution_href, unset_label, opts)
551
+ p result
552
+ rescue PulpHuggingFaceClient::ApiError => e
553
+ puts "Error when calling DistributionsHuggingFaceApi->unset_label: #{e}"
554
+ end
555
+ ```
556
+
557
+ #### Using the unset_label_with_http_info variant
558
+
559
+ This returns an Array which contains the response data, status code and headers.
560
+
561
+ > <Array(<UnsetLabelResponse>, Integer, Hash)> unset_label_with_http_info(hugging_face_hugging_face_distribution_href, unset_label, opts)
562
+
563
+ ```ruby
564
+ begin
565
+ # Unset a label
566
+ data, status_code, headers = api_instance.unset_label_with_http_info(hugging_face_hugging_face_distribution_href, unset_label, opts)
567
+ p status_code # => 2xx
568
+ p headers # => { ... }
569
+ p data # => <UnsetLabelResponse>
570
+ rescue PulpHuggingFaceClient::ApiError => e
571
+ puts "Error when calling DistributionsHuggingFaceApi->unset_label_with_http_info: #{e}"
572
+ end
573
+ ```
574
+
575
+ ### Parameters
576
+
577
+ | Name | Type | Description | Notes |
578
+ | ---- | ---- | ----------- | ----- |
579
+ | **hugging_face_hugging_face_distribution_href** | **String** | | |
580
+ | **unset_label** | [**UnsetLabel**](UnsetLabel.md) | | |
581
+ | **x_task_diagnostics** | [**Array&lt;String&gt;**](String.md) | List of profilers to use on tasks. | [optional] |
582
+
583
+ ### Return type
584
+
585
+ [**UnsetLabelResponse**](UnsetLabelResponse.md)
586
+
587
+ ### Authorization
588
+
589
+ [basicAuth](../README.md#basicAuth)
590
+
591
+ ### HTTP request headers
592
+
593
+ - **Content-Type**: application/json, application/x-www-form-urlencoded, multipart/form-data
594
+ - **Accept**: application/json
595
+
596
+
597
+ ## update
598
+
599
+ > <AsyncOperationResponse> update(hugging_face_hugging_face_distribution_href, hugging_face_hugging_face_distribution, opts)
600
+
601
+ Update a hugging face distribution
602
+
603
+ Trigger an asynchronous update task
604
+
605
+ ### Examples
606
+
607
+ ```ruby
608
+ require 'time'
609
+ require 'pulp_hugging_face_client'
610
+ # setup authorization
611
+ PulpHuggingFaceClient.configure do |config|
612
+ # Configure HTTP basic authorization: basicAuth
613
+ config.username = 'YOUR USERNAME'
614
+ config.password = 'YOUR PASSWORD'
615
+ end
616
+
617
+ api_instance = PulpHuggingFaceClient::DistributionsHuggingFaceApi.new
618
+ hugging_face_hugging_face_distribution_href = 'hugging_face_hugging_face_distribution_href_example' # String |
619
+ hugging_face_hugging_face_distribution = PulpHuggingFaceClient::HuggingFaceHuggingFaceDistribution.new({base_path: 'base_path_example', name: 'name_example'}) # HuggingFaceHuggingFaceDistribution |
620
+ opts = {
621
+ x_task_diagnostics: ['inner_example'] # Array<String> | List of profilers to use on tasks.
622
+ }
623
+
624
+ begin
625
+ # Update a hugging face distribution
626
+ result = api_instance.update(hugging_face_hugging_face_distribution_href, hugging_face_hugging_face_distribution, opts)
627
+ p result
628
+ rescue PulpHuggingFaceClient::ApiError => e
629
+ puts "Error when calling DistributionsHuggingFaceApi->update: #{e}"
630
+ end
631
+ ```
632
+
633
+ #### Using the update_with_http_info variant
634
+
635
+ This returns an Array which contains the response data, status code and headers.
636
+
637
+ > <Array(<AsyncOperationResponse>, Integer, Hash)> update_with_http_info(hugging_face_hugging_face_distribution_href, hugging_face_hugging_face_distribution, opts)
638
+
639
+ ```ruby
640
+ begin
641
+ # Update a hugging face distribution
642
+ data, status_code, headers = api_instance.update_with_http_info(hugging_face_hugging_face_distribution_href, hugging_face_hugging_face_distribution, opts)
643
+ p status_code # => 2xx
644
+ p headers # => { ... }
645
+ p data # => <AsyncOperationResponse>
646
+ rescue PulpHuggingFaceClient::ApiError => e
647
+ puts "Error when calling DistributionsHuggingFaceApi->update_with_http_info: #{e}"
648
+ end
649
+ ```
650
+
651
+ ### Parameters
652
+
653
+ | Name | Type | Description | Notes |
654
+ | ---- | ---- | ----------- | ----- |
655
+ | **hugging_face_hugging_face_distribution_href** | **String** | | |
656
+ | **hugging_face_hugging_face_distribution** | [**HuggingFaceHuggingFaceDistribution**](HuggingFaceHuggingFaceDistribution.md) | | |
657
+ | **x_task_diagnostics** | [**Array&lt;String&gt;**](String.md) | List of profilers to use on tasks. | [optional] |
658
+
659
+ ### Return type
660
+
661
+ [**AsyncOperationResponse**](AsyncOperationResponse.md)
662
+
663
+ ### Authorization
664
+
665
+ [basicAuth](../README.md#basicAuth)
666
+
667
+ ### HTTP request headers
668
+
669
+ - **Content-Type**: application/json, application/x-www-form-urlencoded, multipart/form-data
670
+ - **Accept**: application/json
671
+