Class: SwaggerClient::SysteminfoApi

Inherits:
Object
  • Object
show all
Defined in:
lib/harbor_swagger_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/harbor_swagger_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/harbor_swagger_client/api/systeminfo_api.rb', line 17

def api_client
  @api_client
end

Instance Method Details

#systeminfo_get(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

Returns:



26
27
28
29
 
# File 'lib/harbor_swagger_client/api/systeminfo_api.rb', line 26

def systeminfo_get(opts = {})
  data, _status_code, _headers = systeminfo_get_with_http_info(opts)
  data
end

#systeminfo_get_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

Returns:

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

    GeneralInfo data, response status code and response headers



35
36
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
 
# File 'lib/harbor_swagger_client/api/systeminfo_api.rb', line 35

def systeminfo_get_with_http_info(opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: SysteminfoApi.systeminfo_get ...'
  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'])

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

#systeminfo_getcert_get(opts = {}) ⇒ File

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

Parameters:

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

    the optional parameters

Returns:

  • (File) 


74
75
76
77
 
# File 'lib/harbor_swagger_client/api/systeminfo_api.rb', line 74

def systeminfo_getcert_get(opts = {})
  data, _status_code, _headers = systeminfo_getcert_get_with_http_info(opts)
  data
end

#systeminfo_getcert_get_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

Returns:

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

    File data, response status code and response headers



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

def systeminfo_getcert_get_with_http_info(opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: SysteminfoApi.systeminfo_getcert_get ...'
  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'])

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

#systeminfo_volumes_get(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

Returns:



122
123
124
125
 
# File 'lib/harbor_swagger_client/api/systeminfo_api.rb', line 122

def systeminfo_volumes_get(opts = {})
  data, _status_code, _headers = systeminfo_volumes_get_with_http_info(opts)
  data
end

#systeminfo_volumes_get_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

Returns:

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

    SystemInfo data, response status code and response headers



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

def systeminfo_volumes_get_with_http_info(opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: SysteminfoApi.systeminfo_volumes_get ...'
  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'])

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