Class: BlackmanClient::SemanticCacheApi

Inherits:
Object
  • Object
show all
Defined in:
lib/blackman_client/api/semantic_cache_api.rb

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(api_client = ApiClient.default) ⇒ SemanticCacheApi

Returns a new instance of SemanticCacheApi.



19
20
21
 
# File 'lib/blackman_client/api/semantic_cache_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/blackman_client/api/semantic_cache_api.rb', line 17

def api_client
  @api_client
end

Instance Method Details

#get_config(opts = {}) ⇒ SemanticCacheConfig

Get semantic cache configuration for the current account

Parameters:

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

    the optional parameters

Returns:



25
26
27
28
 
# File 'lib/blackman_client/api/semantic_cache_api.rb', line 25

def get_config(opts = {})
  data, _status_code, _headers = get_config_with_http_info(opts)
  data
end

#get_config_with_http_info(opts = {}) ⇒ Array<(SemanticCacheConfig, Integer, Hash)>

Get semantic cache configuration for the current account

Parameters:

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

    the optional parameters

Returns:

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

    SemanticCacheConfig data, response status code and response headers



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
69
70
71
72
73
74
75
 
# File 'lib/blackman_client/api/semantic_cache_api.rb', line 33

def get_config_with_http_info(opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: SemanticCacheApi.get_config ...'
  end
  # resource path
  local_var_path = '/v1/semantic-cache/config'

  # 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']) unless header_params['Accept']

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

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

  # return_type
  return_type = opts[:debug_return_type] || 'SemanticCacheConfig'

  # auth_names
  auth_names = opts[:debug_auth_names] || ['BearerAuth']

  new_options = opts.merge(
    :operation => :"SemanticCacheApi.get_config",
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => return_type
  )

  data, status_code, headers = @api_client.call_api(:GET, local_var_path, new_options)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: SemanticCacheApi#get_config\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#get_stats(opts = {}) ⇒ SemanticCacheStats

Get semantic cache statistics including hit rate and savings

Parameters:

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

    the optional parameters

Returns:



80
81
82
83
 
# File 'lib/blackman_client/api/semantic_cache_api.rb', line 80

def get_stats(opts = {})
  data, _status_code, _headers = get_stats_with_http_info(opts)
  data
end

#get_stats_with_http_info(opts = {}) ⇒ Array<(SemanticCacheStats, Integer, Hash)>

Get semantic cache statistics including hit rate and savings

Parameters:

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

    the optional parameters

Returns:

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

    SemanticCacheStats data, response status code and response headers



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/blackman_client/api/semantic_cache_api.rb', line 88

def get_stats_with_http_info(opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: SemanticCacheApi.get_stats ...'
  end
  # resource path
  local_var_path = '/v1/semantic-cache/stats'

  # 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']) unless header_params['Accept']

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

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

  # return_type
  return_type = opts[:debug_return_type] || 'SemanticCacheStats'

  # auth_names
  auth_names = opts[:debug_auth_names] || ['BearerAuth']

  new_options = opts.merge(
    :operation => :"SemanticCacheApi.get_stats",
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => return_type
  )

  data, status_code, headers = @api_client.call_api(:GET, local_var_path, new_options)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: SemanticCacheApi#get_stats\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#invalidate_all(opts = {}) ⇒ InvalidateResponse

Invalidate all cache entries for the current account

Parameters:

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

    the optional parameters

Returns:



135
136
137
138
 
# File 'lib/blackman_client/api/semantic_cache_api.rb', line 135

def invalidate_all(opts = {})
  data, _status_code, _headers = invalidate_all_with_http_info(opts)
  data
end

#invalidate_all_with_http_info(opts = {}) ⇒ Array<(InvalidateResponse, Integer, Hash)>

Invalidate all cache entries for the current account

Parameters:

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

    the optional parameters

Returns:

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

    InvalidateResponse data, response status code and response headers



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
179
180
181
182
183
184
185
 
# File 'lib/blackman_client/api/semantic_cache_api.rb', line 143

def invalidate_all_with_http_info(opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: SemanticCacheApi.invalidate_all ...'
  end
  # resource path
  local_var_path = '/v1/semantic-cache/invalidate'

  # 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']) unless header_params['Accept']

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

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

  # return_type
  return_type = opts[:debug_return_type] || 'InvalidateResponse'

  # auth_names
  auth_names = opts[:debug_auth_names] || ['BearerAuth']

  new_options = opts.merge(
    :operation => :"SemanticCacheApi.invalidate_all",
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => return_type
  )

  data, status_code, headers = @api_client.call_api(:DELETE, local_var_path, new_options)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: SemanticCacheApi#invalidate_all\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#update_config(semantic_cache_config, opts = {}) ⇒ nil

Update semantic cache configuration for the current account

Parameters:

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

    the optional parameters

Returns:

  • (nil) 


191
192
193
194
 
# File 'lib/blackman_client/api/semantic_cache_api.rb', line 191

def update_config(semantic_cache_config, opts = {})
  update_config_with_http_info(semantic_cache_config, opts)
  nil
end

#update_config_with_http_info(semantic_cache_config, opts = {}) ⇒ Array<(nil, Integer, Hash)>

Update semantic cache configuration for the current account

Parameters:

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

    the optional parameters

Returns:

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

    nil, response status code and response headers



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
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
 
# File 'lib/blackman_client/api/semantic_cache_api.rb', line 200

def update_config_with_http_info(semantic_cache_config, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: SemanticCacheApi.update_config ...'
  end
  # verify the required parameter 'semantic_cache_config' is set
  if @api_client.config.client_side_validation && semantic_cache_config.nil?
    fail ArgumentError, "Missing the required parameter 'semantic_cache_config' when calling SemanticCacheApi.update_config"
  end
  # resource path
  local_var_path = '/v1/semantic-cache/config'

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

  # header parameters
  header_params = opts[:header_params] || {}
  # HTTP header 'Content-Type'
  content_type = @api_client.select_header_content_type(['application/json'])
  if !content_type.nil?
      header_params['Content-Type'] = content_type
  end

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

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

  # return_type
  return_type = opts[:debug_return_type]

  # auth_names
  auth_names = opts[:debug_auth_names] || ['BearerAuth']

  new_options = opts.merge(
    :operation => :"SemanticCacheApi.update_config",
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => return_type
  )

  data, status_code, headers = @api_client.call_api(:PUT, local_var_path, new_options)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: SemanticCacheApi#update_config\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end