Class: PulpContainerClient::ContentBlobsApi

Inherits:
Object
  • Object
show all
Defined in:
lib/pulp_container_client/api/content_blobs_api.rb

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(api_client = ApiClient.default) ⇒ ContentBlobsApi

Returns a new instance of ContentBlobsApi.



19
20
21
 
# File 'lib/pulp_container_client/api/content_blobs_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_container_client/api/content_blobs_api.rb', line 17

def api_client
  @api_client
end

Instance Method Details

#list(opts = {}) ⇒ PaginatedcontainerBlobResponseList

List blobs ViewSet for Blobs.

Parameters:

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

    the optional parameters

Options Hash (opts):

  • :digest (String) —

    Filter results where digest matches value

  • :digest__in (Array<String>) —

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

  • :limit (Integer) —

    Number of results to return per page.

  • :media_type (Array<String>)
  • :offset (Integer) —

    The initial index from which to return the results.

  • :ordering (String) —

    Which field to use when ordering the results.

  • :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

  • :fields (String) —

    A list of fields to include in the response.

  • :exclude_fields (String) —

    A list of fields to exclude from the response.

Returns:



37
38
39
40
 
# File 'lib/pulp_container_client/api/content_blobs_api.rb', line 37

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

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

List blobs ViewSet for Blobs.

Parameters:

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

    the optional parameters

Options Hash (opts):

  • :digest (String) —

    Filter results where digest matches value

  • :digest__in (Array<String>) —

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

  • :limit (Integer) —

    Number of results to return per page.

  • :media_type (Array<String>)
  • :offset (Integer) —

    The initial index from which to return the results.

  • :ordering (String) —

    Which field to use when ordering the results.

  • :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

  • :fields (String) —

    A list of fields to include in the response.

  • :exclude_fields (String) —

    A list of fields to exclude from the response.

Returns:



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
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
 
# File 'lib/pulp_container_client/api/content_blobs_api.rb', line 57

def list_with_http_info(opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: ContentBlobsApi.list ...'
  end
  allowable_values = ["application/vnd.docker.container.image.v1+json", "application/vnd.docker.image.rootfs.diff.tar.gzip", "application/vnd.docker.image.rootfs.foreign.diff.tar.gzip", "application/vnd.oci.image.config.v1+json", "application/vnd.oci.image.layer.nondistributable.v1.tar+gzip", "application/vnd.oci.image.layer.v1.tar+gzip"]
  if @api_client.config.client_side_validation && opts[:'media_type'] && !opts[:'media_type'].all? { |item| allowable_values.include?(item) }
    fail ArgumentError, "invalid value for \"media_type\", must include one of #{allowable_values}"
  end
  # resource path
  local_var_path = '/pulp/api/v3/content/container/blobs/'

  # query parameters
  query_params = opts[:query_params] || {}
  query_params[:'digest'] = opts[:'digest'] if !opts[:'digest'].nil?
  query_params[:'digest__in'] = @api_client.build_collection_param(opts[:'digest__in'], :csv) if !opts[:'digest__in'].nil?
  query_params[:'limit'] = opts[:'limit'] if !opts[:'limit'].nil?
  query_params[:'media_type'] = @api_client.build_collection_param(opts[:'media_type'], :multi) if !opts[:'media_type'].nil?
  query_params[:'offset'] = opts[:'offset'] if !opts[:'offset'].nil?
  query_params[:'ordering'] = opts[:'ordering'] if !opts[:'ordering'].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[:'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] || 'PaginatedcontainerBlobResponseList' 

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

#read(container_blob_href, opts = {}) ⇒ ContainerBlobResponse

Inspect a blob ViewSet for Blobs.

Parameters:

  • container_blob_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:



122
123
124
125
 
# File 'lib/pulp_container_client/api/content_blobs_api.rb', line 122

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

#read_with_http_info(container_blob_href, opts = {}) ⇒ Array<(ContainerBlobResponse, Integer, Hash)>

Inspect a blob ViewSet for Blobs.

Parameters:

  • container_blob_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<(ContainerBlobResponse, Integer, Hash)>) —

    ContainerBlobResponse data, response status code and response headers



134
135
136
137
138
139
140
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
 
# File 'lib/pulp_container_client/api/content_blobs_api.rb', line 134

def read_with_http_info(container_blob_href, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: ContentBlobsApi.read ...'
  end
  # verify the required parameter 'container_blob_href' is set
  if @api_client.config.client_side_validation && container_blob_href.nil?
    fail ArgumentError, "Missing the required parameter 'container_blob_href' when calling ContentBlobsApi.read"
  end
  # resource path
  local_var_path = '{container_blob_href}'.sub('{' + 'container_blob_href' + '}', CGI.escape(container_blob_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] || 'ContainerBlobResponse' 

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