Class: Pulp2to3MigrationClient::Pulp2ContentApi

Inherits:
Object
  • Object
show all
Defined in:
lib/pulp_2to3_migration_client/api/pulp2_content_api.rb

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(api_client = ApiClient.default) ⇒ Pulp2ContentApi

Returns a new instance of Pulp2ContentApi.



19
20
21
 
# File 'lib/pulp_2to3_migration_client/api/pulp2_content_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_2to3_migration_client/api/pulp2_content_api.rb', line 17

def api_client
  @api_client
end

Instance Method Details

#list(opts = {}) ⇒ Paginatedpulp2to3MigrationPulp2ContentResponseList

List pulp2 contents ViewSet for Pulp2Content model.

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

    Which field to use when ordering the results.

  • :pulp2_content_type_id (String)
  • :pulp2_content_type_id__in (Array<String>) —

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

  • :pulp2_id (String)
  • :pulp2_id__in (Array<String>) —

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

  • :pulp2_last_updated (Integer) —

    ISO 8601 formatted dates are supported

  • :pulp2_last_updated__gt (Integer) —

    Filter results where pulp2_last_updated is greater than value

  • :pulp2_last_updated__gte (Integer) —

    Filter results where pulp2_last_updated is greater than or equal to value

  • :pulp2_last_updated__lt (Integer) —

    Filter results where pulp2_last_updated is less than value

  • :pulp2_last_updated__lte (Integer) —

    Filter results where pulp2_last_updated is less than or equal to value

  • :pulp2_last_updated__range (Array<Integer>) —

    Filter results where pulp2_last_updated is between two comma separated values

  • :pulp3_content (String) —

    Foreign Key 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:



42
43
44
45
 
# File 'lib/pulp_2to3_migration_client/api/pulp2_content_api.rb', line 42

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

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

List pulp2 contents ViewSet for Pulp2Content model.

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

    Which field to use when ordering the results.

  • :pulp2_content_type_id (String)
  • :pulp2_content_type_id__in (Array<String>) —

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

  • :pulp2_id (String)
  • :pulp2_id__in (Array<String>) —

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

  • :pulp2_last_updated (Integer) —

    ISO 8601 formatted dates are supported

  • :pulp2_last_updated__gt (Integer) —

    Filter results where pulp2_last_updated is greater than value

  • :pulp2_last_updated__gte (Integer) —

    Filter results where pulp2_last_updated is greater than or equal to value

  • :pulp2_last_updated__lt (Integer) —

    Filter results where pulp2_last_updated is less than value

  • :pulp2_last_updated__lte (Integer) —

    Filter results where pulp2_last_updated is less than or equal to value

  • :pulp2_last_updated__range (Array<Integer>) —

    Filter results where pulp2_last_updated is between two comma separated values

  • :pulp3_content (String) —

    Foreign Key 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:



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
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
 
# File 'lib/pulp_2to3_migration_client/api/pulp2_content_api.rb', line 67

def list_with_http_info(opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: Pulp2ContentApi.list ...'
  end
  if @api_client.config.client_side_validation && !opts[:'pulp2_last_updated'].nil? && opts[:'pulp2_last_updated'] > 2147483647
    fail ArgumentError, 'invalid value for "opts[:"pulp2_last_updated"]" when calling Pulp2ContentApi.list, must be smaller than or equal to 2147483647.'
  end

  if @api_client.config.client_side_validation && !opts[:'pulp2_last_updated__gt'].nil? && opts[:'pulp2_last_updated__gt'] > 2147483647
    fail ArgumentError, 'invalid value for "opts[:"pulp2_last_updated__gt"]" when calling Pulp2ContentApi.list, must be smaller than or equal to 2147483647.'
  end

  if @api_client.config.client_side_validation && !opts[:'pulp2_last_updated__gte'].nil? && opts[:'pulp2_last_updated__gte'] > 2147483647
    fail ArgumentError, 'invalid value for "opts[:"pulp2_last_updated__gte"]" when calling Pulp2ContentApi.list, must be smaller than or equal to 2147483647.'
  end

  if @api_client.config.client_side_validation && !opts[:'pulp2_last_updated__lt'].nil? && opts[:'pulp2_last_updated__lt'] > 2147483647
    fail ArgumentError, 'invalid value for "opts[:"pulp2_last_updated__lt"]" when calling Pulp2ContentApi.list, must be smaller than or equal to 2147483647.'
  end

  if @api_client.config.client_side_validation && !opts[:'pulp2_last_updated__lte'].nil? && opts[:'pulp2_last_updated__lte'] > 2147483647
    fail ArgumentError, 'invalid value for "opts[:"pulp2_last_updated__lte"]" when calling Pulp2ContentApi.list, must be smaller than or equal to 2147483647.'
  end

  # resource path
  local_var_path = '/pulp/api/v3/pulp2content/'

  # 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'] = opts[:'ordering'] if !opts[:'ordering'].nil?
  query_params[:'pulp2_content_type_id'] = opts[:'pulp2_content_type_id'] if !opts[:'pulp2_content_type_id'].nil?
  query_params[:'pulp2_content_type_id__in'] = @api_client.build_collection_param(opts[:'pulp2_content_type_id__in'], :csv) if !opts[:'pulp2_content_type_id__in'].nil?
  query_params[:'pulp2_id'] = opts[:'pulp2_id'] if !opts[:'pulp2_id'].nil?
  query_params[:'pulp2_id__in'] = @api_client.build_collection_param(opts[:'pulp2_id__in'], :csv) if !opts[:'pulp2_id__in'].nil?
  query_params[:'pulp2_last_updated'] = opts[:'pulp2_last_updated'] if !opts[:'pulp2_last_updated'].nil?
  query_params[:'pulp2_last_updated__gt'] = opts[:'pulp2_last_updated__gt'] if !opts[:'pulp2_last_updated__gt'].nil?
  query_params[:'pulp2_last_updated__gte'] = opts[:'pulp2_last_updated__gte'] if !opts[:'pulp2_last_updated__gte'].nil?
  query_params[:'pulp2_last_updated__lt'] = opts[:'pulp2_last_updated__lt'] if !opts[:'pulp2_last_updated__lt'].nil?
  query_params[:'pulp2_last_updated__lte'] = opts[:'pulp2_last_updated__lte'] if !opts[:'pulp2_last_updated__lte'].nil?
  query_params[:'pulp2_last_updated__range'] = @api_client.build_collection_param(opts[:'pulp2_last_updated__range'], :csv) if !opts[:'pulp2_last_updated__range'].nil?
  query_params[:'pulp3_content'] = opts[:'pulp3_content'] if !opts[:'pulp3_content'].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] || 'Paginatedpulp2to3MigrationPulp2ContentResponseList' 

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

#read(pulp_2to3_migration_pulp2_content_href, opts = {}) ⇒ Pulp2to3MigrationPulp2ContentResponse

Inspect a pulp2 content ViewSet for Pulp2Content model.

Parameters:

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



153
154
155
156
 
# File 'lib/pulp_2to3_migration_client/api/pulp2_content_api.rb', line 153

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

#read_with_http_info(pulp_2to3_migration_pulp2_content_href, opts = {}) ⇒ Array<(Pulp2to3MigrationPulp2ContentResponse, Integer, Hash)>

Inspect a pulp2 content ViewSet for Pulp2Content model.

Parameters:

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



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
203
204
205
206
207
208
209
210
211
212
 
# File 'lib/pulp_2to3_migration_client/api/pulp2_content_api.rb', line 165

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

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