Class: Harbor2Client::ScanAllApi

Inherits:
Object
  • Object
show all
Defined in:
lib/harbor2_client/api/scan_all_api.rb

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(api_client = ApiClient.default) ⇒ ScanAllApi

Returns a new instance of ScanAllApi.



19
20
21
 
# File 'lib/harbor2_client/api/scan_all_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/harbor2_client/api/scan_all_api.rb', line 17

def api_client
  @api_client
end

Instance Method Details

#create_scan_all_schedule(schedule, opts = {}) ⇒ nil

Create a schedule or a manual trigger for the scan all job. This endpoint is for creating a schedule or a manual trigger for the scan all job, which scans all of images in Harbor.

Parameters:

  • schedule —

    Create a schedule or a manual trigger for the scan all job.

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

    the optional parameters

Options Hash (opts):

  • :x_request_id (String) —

    An unique ID for the request

Returns:

  • (nil) 


28
29
30
31
 
# File 'lib/harbor2_client/api/scan_all_api.rb', line 28

def create_scan_all_schedule(schedule, opts = {})
  create_scan_all_schedule_with_http_info(schedule, opts)
  nil
end

#create_scan_all_schedule_with_http_info(schedule, opts = {}) ⇒ Array<(nil, Fixnum, Hash)>

Create a schedule or a manual trigger for the scan all job. This endpoint is for creating a schedule or a manual trigger for the scan all job, which scans all of images in Harbor.

Parameters:

  • schedule —

    Create a schedule or a manual trigger for the scan all job.

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

    the optional parameters

Options Hash (opts):

  • :x_request_id (String) —

    An unique ID for the request

Returns:

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

    nil, response status code and response headers



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
 
# File 'lib/harbor2_client/api/scan_all_api.rb', line 39

def create_scan_all_schedule_with_http_info(schedule, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: ScanAllApi.create_scan_all_schedule ...'
  end
  # verify the required parameter 'schedule' is set
  if @api_client.config.client_side_validation && schedule.nil?
    fail ArgumentError, "Missing the required parameter 'schedule' when calling ScanAllApi.create_scan_all_schedule"
  end
  if @api_client.config.client_side_validation && !opts[:'x_request_id'].nil? && opts[:'x_request_id'].to_s.length < 1
    fail ArgumentError, 'invalid value for "opts[:"x_request_id"]" when calling ScanAllApi.create_scan_all_schedule, the character length must be great than or equal to 1.'
  end

  # resource path
  local_var_path = '/system/scanAll/schedule'

  # query parameters
  query_params = {}

  # header parameters
  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'])
  header_params[:'X-Request-Id'] = opts[:'x_request_id'] if !opts[:'x_request_id'].nil?

  # form parameters
  form_params = {}

  # http body (model)
  post_body = @api_client.object_to_http_body(schedule)
  auth_names = ['basic']
  data, status_code, headers = @api_client.call_api(:POST, local_var_path,
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: ScanAllApi#create_scan_all_schedule\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#get_latest_scan_all_metrics(opts = {}) ⇒ Stats

Get the metrics of the latest scan all process Get the metrics of the latest scan all process

Parameters:

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

    the optional parameters

Options Hash (opts):

  • :x_request_id (String) —

    An unique ID for the request

Returns:



87
88
89
90
 
# File 'lib/harbor2_client/api/scan_all_api.rb', line 87

def get_latest_scan_all_metrics(opts = {})
  data, _status_code, _headers = get_latest_scan_all_metrics_with_http_info(opts)
  data
end

#get_latest_scan_all_metrics_with_http_info(opts = {}) ⇒ Array<(Stats, Fixnum, Hash)>

Get the metrics of the latest scan all process Get the metrics of the latest scan all process

Parameters:

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

    the optional parameters

Options Hash (opts):

  • :x_request_id (String) —

    An unique ID for the request

Returns:

  • (Array<(Stats, Fixnum, Hash)>) —

    Stats data, response status code and response headers



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
 
# File 'lib/harbor2_client/api/scan_all_api.rb', line 97

def get_latest_scan_all_metrics_with_http_info(opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: ScanAllApi.get_latest_scan_all_metrics ...'
  end
  if @api_client.config.client_side_validation && !opts[:'x_request_id'].nil? && opts[:'x_request_id'].to_s.length < 1
    fail ArgumentError, 'invalid value for "opts[:"x_request_id"]" when calling ScanAllApi.get_latest_scan_all_metrics, the character length must be great than or equal to 1.'
  end

  # resource path
  local_var_path = '/scans/all/metrics'

  # query parameters
  query_params = {}

  # header parameters
  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'])
  header_params[:'X-Request-Id'] = opts[:'x_request_id'] if !opts[:'x_request_id'].nil?

  # form parameters
  form_params = {}

  # http body (model)
  post_body = nil
  auth_names = ['basic']
  data, status_code, headers = @api_client.call_api(:GET, local_var_path,
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => 'Stats')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: ScanAllApi#get_latest_scan_all_metrics\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#get_latest_scheduled_scan_all_metrics(opts = {}) ⇒ Stats

Get the metrics of the latest scheduled scan all process Get the metrics of the latest scheduled scan all process

Parameters:

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

    the optional parameters

Options Hash (opts):

  • :x_request_id (String) —

    An unique ID for the request

Returns:



142
143
144
145
 
# File 'lib/harbor2_client/api/scan_all_api.rb', line 142

def get_latest_scheduled_scan_all_metrics(opts = {})
  data, _status_code, _headers = get_latest_scheduled_scan_all_metrics_with_http_info(opts)
  data
end

#get_latest_scheduled_scan_all_metrics_with_http_info(opts = {}) ⇒ Array<(Stats, Fixnum, Hash)>

Get the metrics of the latest scheduled scan all process Get the metrics of the latest scheduled scan all process

Parameters:

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

    the optional parameters

Options Hash (opts):

  • :x_request_id (String) —

    An unique ID for the request

Returns:

  • (Array<(Stats, Fixnum, Hash)>) —

    Stats data, response status code and response headers



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
 
# File 'lib/harbor2_client/api/scan_all_api.rb', line 152

def get_latest_scheduled_scan_all_metrics_with_http_info(opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: ScanAllApi.get_latest_scheduled_scan_all_metrics ...'
  end
  if @api_client.config.client_side_validation && !opts[:'x_request_id'].nil? && opts[:'x_request_id'].to_s.length < 1
    fail ArgumentError, 'invalid value for "opts[:"x_request_id"]" when calling ScanAllApi.get_latest_scheduled_scan_all_metrics, the character length must be great than or equal to 1.'
  end

  # resource path
  local_var_path = '/scans/schedule/metrics'

  # query parameters
  query_params = {}

  # header parameters
  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'])
  header_params[:'X-Request-Id'] = opts[:'x_request_id'] if !opts[:'x_request_id'].nil?

  # form parameters
  form_params = {}

  # http body (model)
  post_body = nil
  auth_names = ['basic']
  data, status_code, headers = @api_client.call_api(:GET, local_var_path,
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => 'Stats')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: ScanAllApi#get_latest_scheduled_scan_all_metrics\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#get_scan_all_schedule(opts = {}) ⇒ Schedule

Get scan all’s schedule. This endpoint is for getting a schedule for the scan all job, which scans all of images in Harbor.

Parameters:

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

    the optional parameters

Options Hash (opts):

  • :x_request_id (String) —

    An unique ID for the request

Returns:



197
198
199
200
 
# File 'lib/harbor2_client/api/scan_all_api.rb', line 197

def get_scan_all_schedule(opts = {})
  data, _status_code, _headers = get_scan_all_schedule_with_http_info(opts)
  data
end

#get_scan_all_schedule_with_http_info(opts = {}) ⇒ Array<(Schedule, Fixnum, Hash)>

Get scan all&#39;s schedule. This endpoint is for getting a schedule for the scan all job, which scans all of images in Harbor.

Parameters:

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

    the optional parameters

Options Hash (opts):

  • :x_request_id (String) —

    An unique ID for the request

Returns:

  • (Array<(Schedule, Fixnum, Hash)>) —

    Schedule data, response status code and response headers



207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
 
# File 'lib/harbor2_client/api/scan_all_api.rb', line 207

def get_scan_all_schedule_with_http_info(opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: ScanAllApi.get_scan_all_schedule ...'
  end
  if @api_client.config.client_side_validation && !opts[:'x_request_id'].nil? && opts[:'x_request_id'].to_s.length < 1
    fail ArgumentError, 'invalid value for "opts[:"x_request_id"]" when calling ScanAllApi.get_scan_all_schedule, the character length must be great than or equal to 1.'
  end

  # resource path
  local_var_path = '/system/scanAll/schedule'

  # query parameters
  query_params = {}

  # header parameters
  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'])
  header_params[:'X-Request-Id'] = opts[:'x_request_id'] if !opts[:'x_request_id'].nil?

  # form parameters
  form_params = {}

  # http body (model)
  post_body = nil
  auth_names = ['basic']
  data, status_code, headers = @api_client.call_api(:GET, local_var_path,
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => 'Schedule')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: ScanAllApi#get_scan_all_schedule\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#update_scan_all_schedule(schedule, opts = {}) ⇒ nil

Update scan all’s schedule. This endpoint is for updating the schedule of scan all job, which scans all of images in Harbor.

Parameters:

  • schedule —

    Updates the schedule of scan all job, which scans all of images in Harbor.

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

    the optional parameters

Options Hash (opts):

  • :x_request_id (String) —

    An unique ID for the request

Returns:

  • (nil) 


253
254
255
256
 
# File 'lib/harbor2_client/api/scan_all_api.rb', line 253

def update_scan_all_schedule(schedule, opts = {})
  update_scan_all_schedule_with_http_info(schedule, opts)
  nil
end

#update_scan_all_schedule_with_http_info(schedule, opts = {}) ⇒ Array<(nil, Fixnum, Hash)>

Update scan all&#39;s schedule. This endpoint is for updating the schedule of scan all job, which scans all of images in Harbor.

Parameters:

  • schedule —

    Updates the schedule of scan all job, which scans all of images in Harbor.

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

    the optional parameters

Options Hash (opts):

  • :x_request_id (String) —

    An unique ID for the request

Returns:

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

    nil, response status code and response headers



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
 
# File 'lib/harbor2_client/api/scan_all_api.rb', line 264

def update_scan_all_schedule_with_http_info(schedule, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: ScanAllApi.update_scan_all_schedule ...'
  end
  # verify the required parameter 'schedule' is set
  if @api_client.config.client_side_validation && schedule.nil?
    fail ArgumentError, "Missing the required parameter 'schedule' when calling ScanAllApi.update_scan_all_schedule"
  end
  if @api_client.config.client_side_validation && !opts[:'x_request_id'].nil? && opts[:'x_request_id'].to_s.length < 1
    fail ArgumentError, 'invalid value for "opts[:"x_request_id"]" when calling ScanAllApi.update_scan_all_schedule, the character length must be great than or equal to 1.'
  end

  # resource path
  local_var_path = '/system/scanAll/schedule'

  # query parameters
  query_params = {}

  # header parameters
  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'])
  header_params[:'X-Request-Id'] = opts[:'x_request_id'] if !opts[:'x_request_id'].nil?

  # form parameters
  form_params = {}

  # http body (model)
  post_body = @api_client.object_to_http_body(schedule)
  auth_names = ['basic']
  data, status_code, headers = @api_client.call_api(:PUT, local_var_path,
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: ScanAllApi#update_scan_all_schedule\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end