Class: IndexeaClient::FieldsApi

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

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(api_client = ApiClient.default) ⇒ FieldsApi

Returns a new instance of FieldsApi.



16
17
18
 
# File 'lib/indexea_client/api/fields_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/fields_api.rb', line 14

def api_client
  @api_client
end

Instance Method Details

#index_fields(app, index, opts = {}) ⇒ Object

获取索引字段映射详情

Parameters:

  • app —

    应用标识

  • index —

    索引编号

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

    the optional parameters

Returns:

  • (Object) 


24
25
26
27
 
# File 'lib/indexea_client/api/fields_api.rb', line 24

def index_fields(app, index, opts = {})
  data, _status_code, _headers = index_fields_with_http_info(app, index, opts)
  data
end

#index_fields_with_http_info(app, index, opts = {}) ⇒ Array<(Object, Integer, Hash)>

获取索引字段映射详情

Parameters:

  • app —

    应用标识

  • index —

    索引编号

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

    the optional parameters

Returns:

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

    Object data, response status code and response headers



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
69
70
71
72
73
74
75
76
77
78
 
# File 'lib/indexea_client/api/fields_api.rb', line 34

def index_fields_with_http_info(app, index, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: FieldsApi.index_fields ...'
  end
  # verify the required parameter 'app' is set
  if @api_client.config.client_side_validation && app.nil?
    fail ArgumentError, "Missing the required parameter 'app' when calling FieldsApi.index_fields"
  end
  # verify the required parameter 'index' is set
  if @api_client.config.client_side_validation && index.nil?
    fail ArgumentError, "Missing the required parameter 'index' when calling FieldsApi.index_fields"
  end
  # resource path
  local_var_path = '/indices/{app}/{index}/fields'.sub('{' + 'app' + '}', app.to_s).sub('{' + 'index' + '}', index.to_s)

  # 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] || ['TokenAuth']
  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: FieldsApi#index_fields\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#index_update_fields(body, app, index, opts = {}) ⇒ Object

更新索引的字段映射

Parameters:

  • body
  • app —

    应用标识

  • index —

    索引编号

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

    the optional parameters

Returns:

  • (Object) 


85
86
87
88
 
# File 'lib/indexea_client/api/fields_api.rb', line 85

def index_update_fields(body, app, index, opts = {})
  data, _status_code, _headers = index_update_fields_with_http_info(body, app, index, opts)
  data
end

#index_update_fields_with_http_info(body, app, index, opts = {}) ⇒ Array<(Object, Integer, Hash)>

更新索引的字段映射

Parameters:

  • body
  • app —

    应用标识

  • index —

    索引编号

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

    the optional parameters

Returns:

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

    Object data, response status code and response headers



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
145
146
 
# File 'lib/indexea_client/api/fields_api.rb', line 96

def index_update_fields_with_http_info(body, app, index, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: FieldsApi.index_update_fields ...'
  end
  # verify the required parameter 'body' is set
  if @api_client.config.client_side_validation && body.nil?
    fail ArgumentError, "Missing the required parameter 'body' when calling FieldsApi.index_update_fields"
  end
  # verify the required parameter 'app' is set
  if @api_client.config.client_side_validation && app.nil?
    fail ArgumentError, "Missing the required parameter 'app' when calling FieldsApi.index_update_fields"
  end
  # verify the required parameter 'index' is set
  if @api_client.config.client_side_validation && index.nil?
    fail ArgumentError, "Missing the required parameter 'index' when calling FieldsApi.index_update_fields"
  end
  # resource path
  local_var_path = '/indices/{app}/{index}/fields'.sub('{' + 'app' + '}', app.to_s).sub('{' + 'index' + '}', index.to_s)

  # 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'])
  # HTTP header 'Content-Type'
  header_params['Content-Type'] = @api_client.select_header_content_type(['application/json'])

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

  # http body (model)
  post_body = opts[:body] || @api_client.object_to_http_body(body) 

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

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

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

#index_update_html_strip_fields(body, app, index, opts = {}) ⇒ Object

更新索引的HTML过滤字段列表

Parameters:

  • body
  • app —

    应用标识

  • index —

    索引编号

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

    the optional parameters

Returns:

  • (Object) 


153
154
155
156
 
# File 'lib/indexea_client/api/fields_api.rb', line 153

def index_update_html_strip_fields(body, app, index, opts = {})
  data, _status_code, _headers = index_update_html_strip_fields_with_http_info(body, app, index, opts)
  data
end

#index_update_html_strip_fields_with_http_info(body, app, index, opts = {}) ⇒ Array<(Object, Integer, Hash)>

更新索引的HTML过滤字段列表

Parameters:

  • body
  • app —

    应用标识

  • index —

    索引编号

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

    the optional parameters

Returns:

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

    Object data, response status code and response headers



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
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
 
# File 'lib/indexea_client/api/fields_api.rb', line 164

def index_update_html_strip_fields_with_http_info(body, app, index, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: FieldsApi.index_update_html_strip_fields ...'
  end
  # verify the required parameter 'body' is set
  if @api_client.config.client_side_validation && body.nil?
    fail ArgumentError, "Missing the required parameter 'body' when calling FieldsApi.index_update_html_strip_fields"
  end
  # verify the required parameter 'app' is set
  if @api_client.config.client_side_validation && app.nil?
    fail ArgumentError, "Missing the required parameter 'app' when calling FieldsApi.index_update_html_strip_fields"
  end
  # verify the required parameter 'index' is set
  if @api_client.config.client_side_validation && index.nil?
    fail ArgumentError, "Missing the required parameter 'index' when calling FieldsApi.index_update_html_strip_fields"
  end
  # resource path
  local_var_path = '/indices/{app}/{index}/fields'.sub('{' + 'app' + '}', app.to_s).sub('{' + 'index' + '}', index.to_s)

  # 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'])
  # HTTP header 'Content-Type'
  header_params['Content-Type'] = @api_client.select_header_content_type(['application/json'])

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

  # http body (model)
  post_body = opts[:body] || @api_client.object_to_http_body(body) 

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

  auth_names = opts[:auth_names] || ['TokenAuth']
  data, status_code, headers = @api_client.call_api(:PATCH, 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: FieldsApi#index_update_html_strip_fields\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#index_values_of_field(app, index, field, size, opts = {}) ⇒ Array<ValueOfField>

获取索引字段的所有值列表

Parameters:

  • app —

    应用标识

  • index —

    索引编号

  • field —

    字段名称

  • size —

    values count

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

    the optional parameters

Returns:



222
223
224
225
 
# File 'lib/indexea_client/api/fields_api.rb', line 222

def index_values_of_field(app, index, field, size, opts = {})
  data, _status_code, _headers = index_values_of_field_with_http_info(app, index, field, size, opts)
  data
end

#index_values_of_field_with_http_info(app, index, field, size, opts = {}) ⇒ Array<(Array<ValueOfField>, Integer, Hash)>

获取索引字段的所有值列表

Parameters:

  • app —

    应用标识

  • index —

    索引编号

  • field —

    字段名称

  • size —

    values count

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

    the optional parameters

Returns:

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

    Array<ValueOfField> data, response status code and response headers



234
235
236
237
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
275
276
277
278
279
280
281
282
283
284
285
286
287
 
# File 'lib/indexea_client/api/fields_api.rb', line 234

def index_values_of_field_with_http_info(app, index, field, size, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: FieldsApi.index_values_of_field ...'
  end
  # verify the required parameter 'app' is set
  if @api_client.config.client_side_validation && app.nil?
    fail ArgumentError, "Missing the required parameter 'app' when calling FieldsApi.index_values_of_field"
  end
  # verify the required parameter 'index' is set
  if @api_client.config.client_side_validation && index.nil?
    fail ArgumentError, "Missing the required parameter 'index' when calling FieldsApi.index_values_of_field"
  end
  # verify the required parameter 'field' is set
  if @api_client.config.client_side_validation && field.nil?
    fail ArgumentError, "Missing the required parameter 'field' when calling FieldsApi.index_values_of_field"
  end
  # verify the required parameter 'size' is set
  if @api_client.config.client_side_validation && size.nil?
    fail ArgumentError, "Missing the required parameter 'size' when calling FieldsApi.index_values_of_field"
  end
  # resource path
  local_var_path = '/indices/{app}/{index}/fields/{field}'.sub('{' + 'app' + '}', app.to_s).sub('{' + 'index' + '}', index.to_s).sub('{' + 'field' + '}', field.to_s)

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

  # 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] || 'Array<ValueOfField>' 

  auth_names = opts[:auth_names] || ['TokenAuth']
  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: FieldsApi#index_values_of_field\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end