Class: Harbor2Client::SysteminfoApi

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

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(api_client = ApiClient.default) ⇒ SysteminfoApi

Returns a new instance of SysteminfoApi.



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

def api_client
  @api_client
end

Instance Method Details

#get_cert(opts = {}) ⇒ File

Get default root certificate. This endpoint is for downloading a default root certificate.

Parameters:

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

    the optional parameters

Options Hash (opts):

  • :x_request_id (String) —

    An unique ID for the request

Returns:

  • (File) 


27
28
29
30
 
# File 'lib/harbor2_client/api/systeminfo_api.rb', line 27

def get_cert(opts = {})
  data, _status_code, _headers = get_cert_with_http_info(opts)
  data
end

#get_cert_with_http_info(opts = {}) ⇒ Array<(File, Fixnum, Hash)>

Get default root certificate. This endpoint is for downloading a default root certificate.

Parameters:

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

    the optional parameters

Options Hash (opts):

  • :x_request_id (String) —

    An unique ID for the request

Returns:

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

    File data, response status code and response headers



37
38
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
 
# File 'lib/harbor2_client/api/systeminfo_api.rb', line 37

def get_cert_with_http_info(opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: SysteminfoApi.get_cert ...'
  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 SysteminfoApi.get_cert, the character length must be great than or equal to 1.'
  end

  # resource path
  local_var_path = '/systeminfo/getcert'

  # query parameters
  query_params = {}

  # header parameters
  header_params = {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/octet-stream'])
  # 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 => 'File')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: SysteminfoApi#get_cert\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#get_system_info(opts = {}) ⇒ GeneralInfo

Get general system info This API is for retrieving general system info, this can be called by anonymous request. Some attributes will be omitted in the response when this API is called by anonymous request.

Parameters:

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

    the optional parameters

Options Hash (opts):

  • :x_request_id (String) —

    An unique ID for the request

Returns:



82
83
84
85
 
# File 'lib/harbor2_client/api/systeminfo_api.rb', line 82

def get_system_info(opts = {})
  data, _status_code, _headers = get_system_info_with_http_info(opts)
  data
end

#get_system_info_with_http_info(opts = {}) ⇒ Array<(GeneralInfo, Fixnum, Hash)>

Get general system info This API is for retrieving general system info, this can be called by anonymous request. Some attributes will be omitted in the response when this API is called by anonymous request.

Parameters:

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

    the optional parameters

Options Hash (opts):

  • :x_request_id (String) —

    An unique ID for the request

Returns:

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

    GeneralInfo data, response status code and response headers



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

def get_system_info_with_http_info(opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: SysteminfoApi.get_system_info ...'
  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 SysteminfoApi.get_system_info, the character length must be great than or equal to 1.'
  end

  # resource path
  local_var_path = '/systeminfo'

  # 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 => 'GeneralInfo')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: SysteminfoApi#get_system_info\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#get_volumes(opts = {}) ⇒ SystemInfo

Get system volume info (total/free size). This endpoint is for retrieving system volume info that only provides for admin user. Note that the response only reflects the storage status of local disk.

Parameters:

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

    the optional parameters

Options Hash (opts):

  • :x_request_id (String) —

    An unique ID for the request

Returns:



137
138
139
140
 
# File 'lib/harbor2_client/api/systeminfo_api.rb', line 137

def get_volumes(opts = {})
  data, _status_code, _headers = get_volumes_with_http_info(opts)
  data
end

#get_volumes_with_http_info(opts = {}) ⇒ Array<(SystemInfo, Fixnum, Hash)>

Get system volume info (total/free size). This endpoint is for retrieving system volume info that only provides for admin user. Note that the response only reflects the storage status of local disk.

Parameters:

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

    the optional parameters

Options Hash (opts):

  • :x_request_id (String) —

    An unique ID for the request

Returns:

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

    SystemInfo data, response status code and response headers



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

def get_volumes_with_http_info(opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: SysteminfoApi.get_volumes ...'
  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 SysteminfoApi.get_volumes, the character length must be great than or equal to 1.'
  end

  # resource path
  local_var_path = '/systeminfo/volumes'

  # 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 => 'SystemInfo')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: SysteminfoApi#get_volumes\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end