Class: PulpAnsibleClient::ContentCollectionSignaturesApi

Inherits:
Object
  • Object
show all
Defined in:
lib/pulp_ansible_client/api/content_collection_signatures_api.rb

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(api_client = ApiClient.default) ⇒ ContentCollectionSignaturesApi

Returns a new instance of ContentCollectionSignaturesApi.



19
20
21
 
# File 'lib/pulp_ansible_client/api/content_collection_signatures_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_ansible_client/api/content_collection_signatures_api.rb', line 17

def api_client
  @api_client
end

Instance Method Details

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

Create a collection version signature Trigger an asynchronous task to create content,optionally create new repository version.

Parameters:

  • signed_collection (String) —

    The content this signature is pointing to.

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

    the optional parameters

Options Hash (opts):

  • :repository (String) —

    A URI of a repository the new content unit should be associated with.

  • :file (File) —

    An uploaded file that may be turned into the content unit.

  • :upload (String) —

    An uncommitted upload that may be turned into the content unit.

Returns:



30
31
32
33
 
# File 'lib/pulp_ansible_client/api/content_collection_signatures_api.rb', line 30

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

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

Create a collection version signature Trigger an asynchronous task to create content,optionally create new repository version.

Parameters:

  • signed_collection (String) —

    The content this signature is pointing to.

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

    the optional parameters

Options Hash (opts):

  • :repository (String) —

    A URI of a repository the new content unit should be associated with.

  • :file (File) —

    An uploaded file that may be turned into the content unit.

  • :upload (String) —

    An uncommitted upload that may be turned into the content unit.

Returns:

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

    AsyncOperationResponse data, response status code and response headers



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

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

  # 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(['multipart/form-data', 'application/x-www-form-urlencoded'])

  # form parameters
  form_params = opts[:form_params] || {}
  form_params['signed_collection'] = signed_collection
  form_params['repository'] = opts[:'repository'] if !opts[:'repository'].nil?
  form_params['file'] = opts[:'file'] if !opts[:'file'].nil?
  form_params['upload'] = opts[:'upload'] if !opts[:'upload'].nil?

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

  # 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: ContentCollectionSignaturesApi#create\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#list(opts = {}) ⇒ PaginatedansibleCollectionVersionSignatureResponseList

List collection version signatures ViewSet for looking at signature objects for CollectionVersion content.

Parameters:

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

    the optional parameters

Options Hash (opts):

  • :limit (Integer) —

    Number of results to return per page.

  • :offset (Integer) —

    The initial index from which to return the results.

  • :ordering (Array<String>) —

    Ordering * &#x60;pulp_id&#x60; - Pulp id * &#x60;-pulp_id&#x60; - Pulp id (descending) * &#x60;pulp_created&#x60; - Pulp created * &#x60;-pulp_created&#x60; - Pulp created (descending) * &#x60;pulp_last_updated&#x60; - Pulp last updated * &#x60;-pulp_last_updated&#x60; - Pulp last updated (descending) * &#x60;pulp_type&#x60; - Pulp type * &#x60;-pulp_type&#x60; - Pulp type (descending) * &#x60;upstream_id&#x60; - Upstream id * &#x60;-upstream_id&#x60; - Upstream id (descending) * &#x60;timestamp_of_interest&#x60; - Timestamp of interest * &#x60;-timestamp_of_interest&#x60; - Timestamp of interest (descending) * &#x60;data&#x60; - Data * &#x60;-data&#x60; - Data (descending) * &#x60;digest&#x60; - Digest * &#x60;-digest&#x60; - Digest (descending) * &#x60;pubkey_fingerprint&#x60; - Pubkey fingerprint * &#x60;-pubkey_fingerprint&#x60; - Pubkey fingerprint (descending) * &#x60;pk&#x60; - Pk * &#x60;-pk&#x60; - Pk (descending)

  • :orphaned_for (Float) —

    Minutes Content has been orphaned for. -1 uses ORPHAN_PROTECTION_TIME.

  • :pubkey_fingerprint (String) —

    Filter results where pubkey_fingerprint matches value

  • :pubkey_fingerprint__in (Array<String>) —

    Filter results where pubkey_fingerprint is in a comma-separated list of values

  • :pulp_href__in (Array<String>) —

    Multiple values may be separated by commas.

  • :pulp_id__in (Array<String>) —

    Multiple values may be separated by commas.

  • :q (String)
  • :repository_version (String) —

    Repository Version referenced by HREF

  • :repository_version_added (String) —

    Repository Version referenced by HREF

  • :repository_version_removed (String) —

    Repository Version referenced by HREF

  • :signed_collection (String) —

    Filter signatures for collection version

  • :signing_service (String) —

    Filter signatures produced by signature service

  • :fields (Array<String>) —

    A list of fields to include in the response.

  • :exclude_fields (Array<String>) —

    A list of fields to exclude from the response.

Returns:



116
117
118
119
 
# File 'lib/pulp_ansible_client/api/content_collection_signatures_api.rb', line 116

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

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

List collection version signatures ViewSet for looking at signature objects for CollectionVersion content.

Parameters:

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

    the optional parameters

Options Hash (opts):

  • :limit (Integer) —

    Number of results to return per page.

  • :offset (Integer) —

    The initial index from which to return the results.

  • :ordering (Array<String>) —

    Ordering * &#x60;pulp_id&#x60; - Pulp id * &#x60;-pulp_id&#x60; - Pulp id (descending) * &#x60;pulp_created&#x60; - Pulp created * &#x60;-pulp_created&#x60; - Pulp created (descending) * &#x60;pulp_last_updated&#x60; - Pulp last updated * &#x60;-pulp_last_updated&#x60; - Pulp last updated (descending) * &#x60;pulp_type&#x60; - Pulp type * &#x60;-pulp_type&#x60; - Pulp type (descending) * &#x60;upstream_id&#x60; - Upstream id * &#x60;-upstream_id&#x60; - Upstream id (descending) * &#x60;timestamp_of_interest&#x60; - Timestamp of interest * &#x60;-timestamp_of_interest&#x60; - Timestamp of interest (descending) * &#x60;data&#x60; - Data * &#x60;-data&#x60; - Data (descending) * &#x60;digest&#x60; - Digest * &#x60;-digest&#x60; - Digest (descending) * &#x60;pubkey_fingerprint&#x60; - Pubkey fingerprint * &#x60;-pubkey_fingerprint&#x60; - Pubkey fingerprint (descending) * &#x60;pk&#x60; - Pk * &#x60;-pk&#x60; - Pk (descending)

  • :orphaned_for (Float) —

    Minutes Content has been orphaned for. -1 uses ORPHAN_PROTECTION_TIME.

  • :pubkey_fingerprint (String) —

    Filter results where pubkey_fingerprint matches value

  • :pubkey_fingerprint__in (Array<String>) —

    Filter results where pubkey_fingerprint is in a comma-separated list of values

  • :pulp_href__in (Array<String>) —

    Multiple values may be separated by commas.

  • :pulp_id__in (Array<String>) —

    Multiple values may be separated by commas.

  • :q (String)
  • :repository_version (String) —

    Repository Version referenced by HREF

  • :repository_version_added (String) —

    Repository Version referenced by HREF

  • :repository_version_removed (String) —

    Repository Version referenced by HREF

  • :signed_collection (String) —

    Filter signatures for collection version

  • :signing_service (String) —

    Filter signatures produced by signature service

  • :fields (Array<String>) —

    A list of fields to include in the response.

  • :exclude_fields (Array<String>) —

    A list of fields to exclude from the response.

Returns:



141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
 
# File 'lib/pulp_ansible_client/api/content_collection_signatures_api.rb', line 141

def list_with_http_info(opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: ContentCollectionSignaturesApi.list ...'
  end
  allowable_values = ["-data", "-digest", "-pk", "-pubkey_fingerprint", "-pulp_created", "-pulp_id", "-pulp_last_updated", "-pulp_type", "-timestamp_of_interest", "-upstream_id", "data", "digest", "pk", "pubkey_fingerprint", "pulp_created", "pulp_id", "pulp_last_updated", "pulp_type", "timestamp_of_interest", "upstream_id"]
  if @api_client.config.client_side_validation && opts[:'ordering'] && !opts[:'ordering'].all? { |item| allowable_values.include?(item) }
    fail ArgumentError, "invalid value for \"ordering\", must include one of #{allowable_values}"
  end
  # resource path
  local_var_path = '/pulp/api/v3/content/ansible/collection_signatures/'

  # query parameters
  query_params = opts[:query_params] || {}
  query_params[:'limit'] = opts[:'limit'] if !opts[:'limit'].nil?
  query_params[:'offset'] = opts[:'offset'] if !opts[:'offset'].nil?
  query_params[:'ordering'] = @api_client.build_collection_param(opts[:'ordering'], :csv) if !opts[:'ordering'].nil?
  query_params[:'orphaned_for'] = opts[:'orphaned_for'] if !opts[:'orphaned_for'].nil?
  query_params[:'pubkey_fingerprint'] = opts[:'pubkey_fingerprint'] if !opts[:'pubkey_fingerprint'].nil?
  query_params[:'pubkey_fingerprint__in'] = @api_client.build_collection_param(opts[:'pubkey_fingerprint__in'], :csv) if !opts[:'pubkey_fingerprint__in'].nil?
  query_params[:'pulp_href__in'] = @api_client.build_collection_param(opts[:'pulp_href__in'], :csv) if !opts[:'pulp_href__in'].nil?
  query_params[:'pulp_id__in'] = @api_client.build_collection_param(opts[:'pulp_id__in'], :csv) if !opts[:'pulp_id__in'].nil?
  query_params[:'q'] = opts[:'q'] if !opts[:'q'].nil?
  query_params[:'repository_version'] = opts[:'repository_version'] if !opts[:'repository_version'].nil?
  query_params[:'repository_version_added'] = opts[:'repository_version_added'] if !opts[:'repository_version_added'].nil?
  query_params[:'repository_version_removed'] = opts[:'repository_version_removed'] if !opts[:'repository_version_removed'].nil?
  query_params[:'signed_collection'] = opts[:'signed_collection'] if !opts[:'signed_collection'].nil?
  query_params[:'signing_service'] = opts[:'signing_service'] if !opts[:'signing_service'].nil?
  query_params[:'fields'] = @api_client.build_collection_param(opts[:'fields'], :multi) if !opts[:'fields'].nil?
  query_params[:'exclude_fields'] = @api_client.build_collection_param(opts[:'exclude_fields'], :multi) if !opts[:'exclude_fields'].nil?

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

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

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

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

  # 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: ContentCollectionSignaturesApi#list\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#read(ansible_collection_version_signature_href, opts = {}) ⇒ AnsibleCollectionVersionSignatureResponse

Inspect a collection version signature ViewSet for looking at signature objects for CollectionVersion content.

Parameters:

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

    the optional parameters

Options Hash (opts):

  • :fields (Array<String>) —

    A list of fields to include in the response.

  • :exclude_fields (Array<String>) —

    A list of fields to exclude from the response.

Returns:



211
212
213
214
 
# File 'lib/pulp_ansible_client/api/content_collection_signatures_api.rb', line 211

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

#read_with_http_info(ansible_collection_version_signature_href, opts = {}) ⇒ Array<(AnsibleCollectionVersionSignatureResponse, Integer, Hash)>

Inspect a collection version signature ViewSet for looking at signature objects for CollectionVersion content.

Parameters:

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

    the optional parameters

Options Hash (opts):

  • :fields (Array<String>) —

    A list of fields to include in the response.

  • :exclude_fields (Array<String>) —

    A list of fields to exclude from the response.

Returns:



223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
 
# File 'lib/pulp_ansible_client/api/content_collection_signatures_api.rb', line 223

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

  # query parameters
  query_params = opts[:query_params] || {}
  query_params[:'fields'] = @api_client.build_collection_param(opts[:'fields'], :multi) if !opts[:'fields'].nil?
  query_params[:'exclude_fields'] = @api_client.build_collection_param(opts[:'exclude_fields'], :multi) if !opts[:'exclude_fields'].nil?

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

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

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

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

  # 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: ContentCollectionSignaturesApi#read\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end