Class: PulpFileClient::PublicationsFileApi

Inherits:
Object
  • Object
show all
Defined in:
lib/pulp_file_client/api/publications_file_api.rb

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(api_client = ApiClient.default) ⇒ PublicationsFileApi

Returns a new instance of PublicationsFileApi.



19
20
21
 
# File 'lib/pulp_file_client/api/publications_file_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_file_client/api/publications_file_api.rb', line 17

def api_client
  @api_client
end

Instance Method Details

#add_role(file_file_publication_href, nested_role, opts = {}) ⇒ NestedRoleResponse

Add a role for this object to users/groups.

Parameters:

  • file_file_publication_href (String)
  • nested_role (NestedRole)
  • opts (Hash) (defaults to: {}) —

    the optional parameters

Returns:



27
28
29
30
 
# File 'lib/pulp_file_client/api/publications_file_api.rb', line 27

def add_role(file_file_publication_href, nested_role, opts = {})
  data, _status_code, _headers = add_role_with_http_info(file_file_publication_href, nested_role, opts)
  data
end

#add_role_with_http_info(file_file_publication_href, nested_role, opts = {}) ⇒ Array<(NestedRoleResponse, Integer, Hash)>

Add a role for this object to users/groups.

Parameters:

  • file_file_publication_href (String)
  • nested_role (NestedRole)
  • opts (Hash) (defaults to: {}) —

    the optional parameters

Returns:

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

    NestedRoleResponse data, response status code and response headers



37
38
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
 
# File 'lib/pulp_file_client/api/publications_file_api.rb', line 37

def add_role_with_http_info(file_file_publication_href, nested_role, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: PublicationsFileApi.add_role ...'
  end
  # verify the required parameter 'file_file_publication_href' is set
  if @api_client.config.client_side_validation && file_file_publication_href.nil?
    fail ArgumentError, "Missing the required parameter 'file_file_publication_href' when calling PublicationsFileApi.add_role"
  end
  # verify the required parameter 'nested_role' is set
  if @api_client.config.client_side_validation && nested_role.nil?
    fail ArgumentError, "Missing the required parameter 'nested_role' when calling PublicationsFileApi.add_role"
  end
  # resource path
  local_var_path = '{file_file_publication_href}add_role/'.sub('{' + 'file_file_publication_href' + '}', CGI.escape(file_file_publication_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'])
  # HTTP header 'Content-Type'
  header_params['Content-Type'] = @api_client.select_header_content_type(['application/json', 'application/x-www-form-urlencoded', 'multipart/form-data'])

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

  # http body (model)
  post_body = opts[:body] || @api_client.object_to_http_body(nested_role) 

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

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

  new_options = opts.merge(
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => return_type
  )

  data, status_code, headers = @api_client.call_api(:POST, local_var_path, new_options)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: PublicationsFileApi#add_role\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

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

Create a file publication Trigger an asynchronous task to publish file content.

Parameters:

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

    the optional parameters

Returns:



95
96
97
98
 
# File 'lib/pulp_file_client/api/publications_file_api.rb', line 95

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

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

Create a file publication Trigger an asynchronous task to publish file content.

Parameters:

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

    the optional parameters

Returns:

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

    AsyncOperationResponse data, response status code and response headers



105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
 
# File 'lib/pulp_file_client/api/publications_file_api.rb', line 105

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

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

  # header parameters
  header_params = opts[:header_params] || {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json'])
  # HTTP header 'Content-Type'
  header_params['Content-Type'] = @api_client.select_header_content_type(['application/json', 'application/x-www-form-urlencoded', 'multipart/form-data'])

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

  # http body (model)
  post_body = opts[:body] || @api_client.object_to_http_body(file_file_publication) 

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

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

  new_options = opts.merge(
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => return_type
  )

  data, status_code, headers = @api_client.call_api(:POST, local_var_path, new_options)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: PublicationsFileApi#create\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

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

Delete a file publication

A FilePublication contains metadata about all the File Content in a particular File Repository Version. Once a FilePublication has been created, it can be hosted using the File Distribution API.

Parameters:

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

    the optional parameters

Returns:

  • (nil) 


159
160
161
162
 
# File 'lib/pulp_file_client/api/publications_file_api.rb', line 159

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

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

Delete a file publication

A FilePublication contains metadata about all the File Content in a particular File Repository Version. Once a FilePublication has been created, it can be hosted using the File Distribution API.

Parameters:

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

    the optional parameters

Returns:

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

    nil, response status code and response headers



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
 
# File 'lib/pulp_file_client/api/publications_file_api.rb', line 169

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

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

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

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

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

  # return_type
  return_type = opts[:return_type] 

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

  new_options = opts.merge(
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => return_type
  )

  data, status_code, headers = @api_client.call_api(:DELETE, local_var_path, new_options)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: PublicationsFileApi#delete\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#list(opts = {}) ⇒ PaginatedfileFilePublicationResponseList

List file publications

A FilePublication contains metadata about all the File Content in a particular File Repository Version. Once a FilePublication has been created, it can be hosted using the File Distribution API.

Parameters:

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

    the optional parameters

Options Hash (opts):

  • :content (String) —

    Content Unit referenced by HREF

  • :content__in (String) —

    Content Unit referenced by HREF

  • :limit (Integer) —

    Number of results to return per page.

  • :offset (Integer) —

    The initial index from which to return the results.

  • :ordering (Array<String>) —

    Ordering

  • :pulp_created (DateTime) —

    ISO 8601 formatted dates are supported

  • :pulp_created__gt (DateTime) —

    Filter results where pulp_created is greater than value

  • :pulp_created__gte (DateTime) —

    Filter results where pulp_created is greater than or equal to value

  • :pulp_created__lt (DateTime) —

    Filter results where pulp_created is less than value

  • :pulp_created__lte (DateTime) —

    Filter results where pulp_created is less than or equal to value

  • :pulp_created__range (Array<DateTime>) —

    Filter results where pulp_created is between two comma separated values

  • :repository (String) —

    Repository referenced by HREF

  • :repository_version (String) —

    Repository Version referenced by HREF

  • :fields (String) —

    A list of fields to include in the response.

  • :exclude_fields (String) —

    A list of fields to exclude from the response.

Returns:



233
234
235
236
 
# File 'lib/pulp_file_client/api/publications_file_api.rb', line 233

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

#list_roles(file_file_publication_href, opts = {}) ⇒ ObjectRolesResponse

List roles assigned to this object.

Parameters:

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

    the optional parameters

Options Hash (opts):

  • :fields (String) —

    A list of fields to include in the response.

  • :exclude_fields (String) —

    A list of fields to exclude from the response.

Returns:



325
326
327
328
 
# File 'lib/pulp_file_client/api/publications_file_api.rb', line 325

def list_roles(file_file_publication_href, opts = {})
  data, _status_code, _headers = list_roles_with_http_info(file_file_publication_href, opts)
  data
end

#list_roles_with_http_info(file_file_publication_href, opts = {}) ⇒ Array<(ObjectRolesResponse, Integer, Hash)>

List roles assigned to this object.

Parameters:

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

    the optional parameters

Options Hash (opts):

  • :fields (String) —

    A list of fields to include in the response.

  • :exclude_fields (String) —

    A list of fields to exclude from the response.

Returns:

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

    ObjectRolesResponse data, response status code and response headers



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
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
 
# File 'lib/pulp_file_client/api/publications_file_api.rb', line 336

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

  # query parameters
  query_params = opts[:query_params] || {}
  query_params[:'fields'] = opts[:'fields'] if !opts[:'fields'].nil?
  query_params[:'exclude_fields'] = opts[:'exclude_fields'] if !opts[:'exclude_fields'].nil?

  # header parameters
  header_params = opts[:header_params] || {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json'])

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

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

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

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

  new_options = opts.merge(
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => return_type
  )

  data, status_code, headers = @api_client.call_api(:GET, local_var_path, new_options)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: PublicationsFileApi#list_roles\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

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

List file publications

A FilePublication contains metadata about all the File Content in a particular File Repository Version. Once a FilePublication has been created, it can be hosted using the File Distribution API.

Parameters:

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

    the optional parameters

Options Hash (opts):

  • :content (String) —

    Content Unit referenced by HREF

  • :content__in (String) —

    Content Unit referenced by HREF

  • :limit (Integer) —

    Number of results to return per page.

  • :offset (Integer) —

    The initial index from which to return the results.

  • :ordering (Array<String>) —

    Ordering

  • :pulp_created (DateTime) —

    ISO 8601 formatted dates are supported

  • :pulp_created__gt (DateTime) —

    Filter results where pulp_created is greater than value

  • :pulp_created__gte (DateTime) —

    Filter results where pulp_created is greater than or equal to value

  • :pulp_created__lt (DateTime) —

    Filter results where pulp_created is less than value

  • :pulp_created__lte (DateTime) —

    Filter results where pulp_created is less than or equal to value

  • :pulp_created__range (Array<DateTime>) —

    Filter results where pulp_created is between two comma separated values

  • :repository (String) —

    Repository referenced by HREF

  • :repository_version (String) —

    Repository Version referenced by HREF

  • :fields (String) —

    A list of fields to include in the response.

  • :exclude_fields (String) —

    A list of fields to exclude from the response.

Returns:



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
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
 
# File 'lib/pulp_file_client/api/publications_file_api.rb', line 257

def list_with_http_info(opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: PublicationsFileApi.list ...'
  end
  allowable_values = ["-complete", "-distribution", "-file_filepublication", "-group_roles", "-pass_through", "-pk", "-published_artifact", "-published_metadata", "-pulp_created", "-pulp_id", "-pulp_labels", "-pulp_last_updated", "-pulp_type", "-repository_version", "-user_roles", "complete", "distribution", "file_filepublication", "group_roles", "pass_through", "pk", "published_artifact", "published_metadata", "pulp_created", "pulp_id", "pulp_labels", "pulp_last_updated", "pulp_type", "repository_version", "user_roles"]
  if @api_client.config.client_side_validation && opts[:'ordering'] && !opts[:'ordering'].all? { |item| allowable_values.include?(item) }
    fail ArgumentError, "invalid value for \"ordering\", must include one of #{allowable_values}"
  end
  # resource path
  local_var_path = '/pulp/api/v3/publications/file/file/'

  # query parameters
  query_params = opts[:query_params] || {}
  query_params[:'content'] = opts[:'content'] if !opts[:'content'].nil?
  query_params[:'content__in'] = opts[:'content__in'] if !opts[:'content__in'].nil?
  query_params[:'limit'] = opts[:'limit'] if !opts[:'limit'].nil?
  query_params[:'offset'] = opts[:'offset'] if !opts[:'offset'].nil?
  query_params[:'ordering'] = @api_client.build_collection_param(opts[:'ordering'], :csv) if !opts[:'ordering'].nil?
  query_params[:'pulp_created'] = opts[:'pulp_created'] if !opts[:'pulp_created'].nil?
  query_params[:'pulp_created__gt'] = opts[:'pulp_created__gt'] if !opts[:'pulp_created__gt'].nil?
  query_params[:'pulp_created__gte'] = opts[:'pulp_created__gte'] if !opts[:'pulp_created__gte'].nil?
  query_params[:'pulp_created__lt'] = opts[:'pulp_created__lt'] if !opts[:'pulp_created__lt'].nil?
  query_params[:'pulp_created__lte'] = opts[:'pulp_created__lte'] if !opts[:'pulp_created__lte'].nil?
  query_params[:'pulp_created__range'] = @api_client.build_collection_param(opts[:'pulp_created__range'], :csv) if !opts[:'pulp_created__range'].nil?
  query_params[:'repository'] = opts[:'repository'] if !opts[:'repository'].nil?
  query_params[:'repository_version'] = opts[:'repository_version'] if !opts[:'repository_version'].nil?
  query_params[:'fields'] = opts[:'fields'] if !opts[:'fields'].nil?
  query_params[:'exclude_fields'] = opts[:'exclude_fields'] if !opts[:'exclude_fields'].nil?

  # header parameters
  header_params = opts[:header_params] || {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json'])

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

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

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

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

  new_options = opts.merge(
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => return_type
  )

  data, status_code, headers = @api_client.call_api(:GET, local_var_path, new_options)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: PublicationsFileApi#list\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#my_permissions(file_file_publication_href, opts = {}) ⇒ MyPermissionsResponse

List permissions available to the current user on this object.

Parameters:

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

    the optional parameters

Options Hash (opts):

  • :fields (String) —

    A list of fields to include in the response.

  • :exclude_fields (String) —

    A list of fields to exclude from the response.

Returns:



391
392
393
394
 
# File 'lib/pulp_file_client/api/publications_file_api.rb', line 391

def my_permissions(file_file_publication_href, opts = {})
  data, _status_code, _headers = my_permissions_with_http_info(file_file_publication_href, opts)
  data
end

#my_permissions_with_http_info(file_file_publication_href, opts = {}) ⇒ Array<(MyPermissionsResponse, Integer, Hash)>

List permissions available to the current user on this object.

Parameters:

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

    the optional parameters

Options Hash (opts):

  • :fields (String) —

    A list of fields to include in the response.

  • :exclude_fields (String) —

    A list of fields to exclude from the response.

Returns:

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

    MyPermissionsResponse data, response status code and response headers



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
440
441
442
443
444
445
446
447
448
449
 
# File 'lib/pulp_file_client/api/publications_file_api.rb', line 402

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

  # query parameters
  query_params = opts[:query_params] || {}
  query_params[:'fields'] = opts[:'fields'] if !opts[:'fields'].nil?
  query_params[:'exclude_fields'] = opts[:'exclude_fields'] if !opts[:'exclude_fields'].nil?

  # header parameters
  header_params = opts[:header_params] || {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json'])

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

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

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

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

  new_options = opts.merge(
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => return_type
  )

  data, status_code, headers = @api_client.call_api(:GET, local_var_path, new_options)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: PublicationsFileApi#my_permissions\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#read(file_file_publication_href, opts = {}) ⇒ FileFilePublicationResponse

Inspect a file publication

A FilePublication contains metadata about all the File Content in a particular File Repository Version. Once a FilePublication has been created, it can be hosted using the File Distribution API.

Parameters:

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

    the optional parameters

Options Hash (opts):

  • :fields (String) —

    A list of fields to include in the response.

  • :exclude_fields (String) —

    A list of fields to exclude from the response.

Returns:



458
459
460
461
 
# File 'lib/pulp_file_client/api/publications_file_api.rb', line 458

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

#read_with_http_info(file_file_publication_href, opts = {}) ⇒ Array<(FileFilePublicationResponse, Integer, Hash)>

Inspect a file publication

A FilePublication contains metadata about all the File Content in a particular File Repository Version. Once a FilePublication has been created, it can be hosted using the File Distribution API.

Parameters:

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

    the optional parameters

Options Hash (opts):

  • :fields (String) —

    A list of fields to include in the response.

  • :exclude_fields (String) —

    A list of fields to exclude from the response.

Returns:

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

    FileFilePublicationResponse data, response status code and response headers



470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
 
# File 'lib/pulp_file_client/api/publications_file_api.rb', line 470

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

  # query parameters
  query_params = opts[:query_params] || {}
  query_params[:'fields'] = opts[:'fields'] if !opts[:'fields'].nil?
  query_params[:'exclude_fields'] = opts[:'exclude_fields'] if !opts[:'exclude_fields'].nil?

  # header parameters
  header_params = opts[:header_params] || {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json'])

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

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

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

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

  new_options = opts.merge(
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => return_type
  )

  data, status_code, headers = @api_client.call_api(:GET, local_var_path, new_options)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: PublicationsFileApi#read\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#remove_role(file_file_publication_href, nested_role, opts = {}) ⇒ NestedRoleResponse

Remove a role for this object from users/groups.

Parameters:

  • file_file_publication_href (String)
  • nested_role (NestedRole)
  • opts (Hash) (defaults to: {}) —

    the optional parameters

Returns:



524
525
526
527
 
# File 'lib/pulp_file_client/api/publications_file_api.rb', line 524

def remove_role(file_file_publication_href, nested_role, opts = {})
  data, _status_code, _headers = remove_role_with_http_info(file_file_publication_href, nested_role, opts)
  data
end

#remove_role_with_http_info(file_file_publication_href, nested_role, opts = {}) ⇒ Array<(NestedRoleResponse, Integer, Hash)>

Remove a role for this object from users/groups.

Parameters:

  • file_file_publication_href (String)
  • nested_role (NestedRole)
  • opts (Hash) (defaults to: {}) —

    the optional parameters

Returns:

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

    NestedRoleResponse data, response status code and response headers



534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
 
# File 'lib/pulp_file_client/api/publications_file_api.rb', line 534

def remove_role_with_http_info(file_file_publication_href, nested_role, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: PublicationsFileApi.remove_role ...'
  end
  # verify the required parameter 'file_file_publication_href' is set
  if @api_client.config.client_side_validation && file_file_publication_href.nil?
    fail ArgumentError, "Missing the required parameter 'file_file_publication_href' when calling PublicationsFileApi.remove_role"
  end
  # verify the required parameter 'nested_role' is set
  if @api_client.config.client_side_validation && nested_role.nil?
    fail ArgumentError, "Missing the required parameter 'nested_role' when calling PublicationsFileApi.remove_role"
  end
  # resource path
  local_var_path = '{file_file_publication_href}remove_role/'.sub('{' + 'file_file_publication_href' + '}', CGI.escape(file_file_publication_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'])
  # HTTP header 'Content-Type'
  header_params['Content-Type'] = @api_client.select_header_content_type(['application/json', 'application/x-www-form-urlencoded', 'multipart/form-data'])

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

  # http body (model)
  post_body = opts[:body] || @api_client.object_to_http_body(nested_role) 

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

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

  new_options = opts.merge(
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => return_type
  )

  data, status_code, headers = @api_client.call_api(:POST, local_var_path, new_options)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: PublicationsFileApi#remove_role\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end