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 = {}) ⇒ InlineResponse200

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 (String) —

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

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

  • :media_type (String)
  • :limit (Integer) —

    Number of results to return per page.

  • :offset (Integer) —

    The initial index from which to return the results.

  • :fields (String) —

    A list of fields to include in the response.

  • :exclude_fields (String) —

    A list of fields to exclude from the response.

Returns:



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

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

#list_with_http_info(opts = {}) ⇒ Array<(InlineResponse200, 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 (String) —

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

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

  • :media_type (String)
  • :limit (Integer) —

    Number of results to return per page.

  • :offset (Integer) —

    The initial index from which to return the results.

  • :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<(InlineResponse200, Integer, Hash)>) —

    InlineResponse200 data, response status code and response headers



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
95
96
97
98
99
100
101
102
103
104
105
106
 
# File 'lib/pulp_container_client/api/content_blobs_api.rb', line 55

def list_with_http_info(opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: ContentBlobsApi.list ...'
  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'] = opts[:'digest__in'] if !opts[:'digest__in'].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[:'media_type'] = opts[:'media_type'] if !opts[:'media_type'].nil?
  query_params[:'limit'] = opts[:'limit'] if !opts[:'limit'].nil?
  query_params[:'offset'] = opts[:'offset'] if !opts[:'offset'].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] || 'InlineResponse200' 

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

  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(blob_href, opts = {}) ⇒ ContainerBlob

Inspect a blob ViewSet for Blobs.

Parameters:

  • blob_href (String) —

    URI of Blob. e.g.: /pulp/api/v3/content/container/blobs/1/

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



115
116
117
118
 
# File 'lib/pulp_container_client/api/content_blobs_api.rb', line 115

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

#read_with_http_info(blob_href, opts = {}) ⇒ Array<(ContainerBlob, Integer, Hash)>

Inspect a blob ViewSet for Blobs.

Parameters:

  • blob_href (String) —

    URI of Blob. e.g.: /pulp/api/v3/content/container/blobs/1/

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

    ContainerBlob data, response status code and response headers



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
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
 
# File 'lib/pulp_container_client/api/content_blobs_api.rb', line 127

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

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

  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