Class: IndexeaClient::GlobalApi

Inherits:
Object
  • Object
show all
Defined in:
lib/indexea_client/api/global_api.rb

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(api_client = ApiClient.default) ⇒ GlobalApi

Returns a new instance of GlobalApi.



16
17
18
 
# File 'lib/indexea_client/api/global_api.rb', line 16

def initialize(api_client = ApiClient.default)
  @api_client = api_client
end

Instance Attribute Details

#api_client ⇒ Object

Returns the value of attribute api_client.



14
15
16
 
# File 'lib/indexea_client/api/global_api.rb', line 14

def api_client
  @api_client
end

Instance Method Details

#json(opts = {}) ⇒ Object

接口定义(JSON) 获取 OpenAPI 接口定义(JSON)

Parameters:

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

    the optional parameters

Returns:

  • (Object) 


23
24
25
26
 
# File 'lib/indexea_client/api/global_api.rb', line 23

def json(opts = {})
  data, _status_code, _headers = json_with_http_info(opts)
  data
end

#json_with_http_info(opts = {}) ⇒ Array<(Object, Integer, Hash)>

接口定义(JSON) 获取 OpenAPI 接口定义(JSON)

Parameters:

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

    the optional parameters

Returns:

  • (Array<(Object, Integer, Hash)>) —

    Object data, response status code and response headers



32
33
34
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
 
# File 'lib/indexea_client/api/global_api.rb', line 32

def json_with_http_info(opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: GlobalApi.json ...'
  end
  # resource path
  local_var_path = '/json'

  # query parameters
  query_params = opts[:query_params] || {}

  # 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 = opts[:return_type] || 'Object' 

  auth_names = opts[:auth_names] || []
  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 => return_type)

  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: GlobalApi#json\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#options_get(name, keys, opts = {}) ⇒ Object

系统全局配置接口

Parameters:

  • name
  • keys —

    配置项名,多个配置项请使用逗号隔开

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

    the optional parameters

Returns:

  • (Object) 


74
75
76
77
 
# File 'lib/indexea_client/api/global_api.rb', line 74

def options_get(name, keys, opts = {})
  data, _status_code, _headers = options_get_with_http_info(name, keys, opts)
  data
end

#options_get_with_http_info(name, keys, opts = {}) ⇒ Array<(Object, Integer, Hash)>

系统全局配置接口

Parameters:

  • name
  • keys —

    配置项名,多个配置项请使用逗号隔开

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

    the optional parameters

Returns:

  • (Array<(Object, Integer, Hash)>) —

    Object data, response status code and response headers



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
 
# File 'lib/indexea_client/api/global_api.rb', line 84

def options_get_with_http_info(name, keys, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: GlobalApi.options_get ...'
  end
  # verify the required parameter 'name' is set
  if @api_client.config.client_side_validation && name.nil?
    fail ArgumentError, "Missing the required parameter 'name' when calling GlobalApi.options_get"
  end
  # verify the required parameter 'keys' is set
  if @api_client.config.client_side_validation && keys.nil?
    fail ArgumentError, "Missing the required parameter 'keys' when calling GlobalApi.options_get"
  end
  # resource path
  local_var_path = '/options'

  # query parameters
  query_params = opts[:query_params] || {}
  query_params[:'name'] = name
  query_params[:'keys'] = keys

  # 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 = opts[:return_type] || 'Object' 

  auth_names = opts[:auth_names] || []
  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 => return_type)

  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: GlobalApi#options_get\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#status_database(opts = {}) ⇒ String

数据库服务状态测试

Parameters:

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

    the optional parameters

Returns:

  • (String) 


134
135
136
137
 
# File 'lib/indexea_client/api/global_api.rb', line 134

def status_database(opts = {})
  data, _status_code, _headers = status_database_with_http_info(opts)
  data
end

#status_database_with_http_info(opts = {}) ⇒ Array<(String, Integer, Hash)>

数据库服务状态测试

Parameters:

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

    the optional parameters

Returns:

  • (Array<(String, Integer, Hash)>) —

    String data, response status code and response headers



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
175
176
177
178
 
# File 'lib/indexea_client/api/global_api.rb', line 142

def status_database_with_http_info(opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: GlobalApi.status_database ...'
  end
  # resource path
  local_var_path = '/status/database'

  # query parameters
  query_params = opts[:query_params] || {}

  # header parameters
  header_params = opts[:header_params] || {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['text/plain'])

  # form parameters
  form_params = opts[:form_params] || {}

  # http body (model)
  post_body = opts[:body] 

  return_type = opts[:return_type] || 'String' 

  auth_names = opts[:auth_names] || []
  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 => return_type)

  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: GlobalApi#status_database\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#status_engine(opts = {}) ⇒ String

搜索引擎状态测试

Parameters:

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

    the optional parameters

Returns:

  • (String) 


182
183
184
185
 
# File 'lib/indexea_client/api/global_api.rb', line 182

def status_engine(opts = {})
  data, _status_code, _headers = status_engine_with_http_info(opts)
  data
end

#status_engine_with_http_info(opts = {}) ⇒ Array<(String, Integer, Hash)>

搜索引擎状态测试

Parameters:

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

    the optional parameters

Returns:

  • (Array<(String, Integer, Hash)>) —

    String data, response status code and response headers



190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
 
# File 'lib/indexea_client/api/global_api.rb', line 190

def status_engine_with_http_info(opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: GlobalApi.status_engine ...'
  end
  # resource path
  local_var_path = '/status/engine'

  # query parameters
  query_params = opts[:query_params] || {}

  # header parameters
  header_params = opts[:header_params] || {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['text/plain'])

  # form parameters
  form_params = opts[:form_params] || {}

  # http body (model)
  post_body = opts[:body] 

  return_type = opts[:return_type] || 'String' 

  auth_names = opts[:auth_names] || []
  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 => return_type)

  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: GlobalApi#status_engine\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#welcome(opts = {}) ⇒ String

接口欢迎信息

Parameters:

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

    the optional parameters

Returns:

  • (String) 


230
231
232
233
 
# File 'lib/indexea_client/api/global_api.rb', line 230

def welcome(opts = {})
  data, _status_code, _headers = welcome_with_http_info(opts)
  data
end

#welcome_with_http_info(opts = {}) ⇒ Array<(String, Integer, Hash)>

接口欢迎信息

Parameters:

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

    the optional parameters

Returns:

  • (Array<(String, Integer, Hash)>) —

    String data, response status code and response headers



238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
 
# File 'lib/indexea_client/api/global_api.rb', line 238

def welcome_with_http_info(opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: GlobalApi.welcome ...'
  end
  # resource path
  local_var_path = '/'

  # query parameters
  query_params = opts[:query_params] || {}

  # header parameters
  header_params = opts[:header_params] || {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['text/plain', 'text/html', 'application/json', 'application/x-yaml'])

  # form parameters
  form_params = opts[:form_params] || {}

  # http body (model)
  post_body = opts[:body] 

  return_type = opts[:return_type] || 'String' 

  auth_names = opts[:auth_names] || []
  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 => return_type)

  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: GlobalApi#welcome\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#yaml(opts = {}) ⇒ String

接口定义(YAML) 获取 OpenAPI 接口定义(YAML)

Parameters:

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

    the optional parameters

Returns:

  • (String) 


279
280
281
282
 
# File 'lib/indexea_client/api/global_api.rb', line 279

def yaml(opts = {})
  data, _status_code, _headers = yaml_with_http_info(opts)
  data
end

#yaml_with_http_info(opts = {}) ⇒ Array<(String, Integer, Hash)>

接口定义(YAML) 获取 OpenAPI 接口定义(YAML)

Parameters:

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

    the optional parameters

Returns:

  • (Array<(String, Integer, Hash)>) —

    String data, response status code and response headers



288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
 
# File 'lib/indexea_client/api/global_api.rb', line 288

def yaml_with_http_info(opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: GlobalApi.yaml ...'
  end
  # resource path
  local_var_path = '/yaml'

  # query parameters
  query_params = opts[:query_params] || {}

  # header parameters
  header_params = opts[:header_params] || {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/x-yaml'])

  # form parameters
  form_params = opts[:form_params] || {}

  # http body (model)
  post_body = opts[:body] 

  return_type = opts[:return_type] || 'String' 

  auth_names = opts[:auth_names] || []
  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 => return_type)

  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: GlobalApi#yaml\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end