Class: RagieRubySdk::PartitionsApi

Inherits:
Object
  • Object
show all
Defined in:
lib/ragie_ruby_sdk/api/partitions_api.rb

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(api_client = ApiClient.default) ⇒ PartitionsApi

Returns a new instance of PartitionsApi.



19
20
21
 
# File 'lib/ragie_ruby_sdk/api/partitions_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/ragie_ruby_sdk/api/partitions_api.rb', line 17

def api_client
  @api_client
end

Instance Method Details

#create_partition_partitions_post(create_partition_params, opts = {}) ⇒ Partition

Create Partition Create a new partition. Partitions are used to scope documents, connections, and instructions. Partitions must be lowercase alphanumeric and may only include the special characters ‘_` and `-`. A partition may also be created by creating a document in it. Limits for a partition may optionally be defined when creating.

Parameters:

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

    the optional parameters

Returns:



27
28
29
30
 
# File 'lib/ragie_ruby_sdk/api/partitions_api.rb', line 27

def create_partition_partitions_post(create_partition_params, opts = {})
  data, _status_code, _headers = create_partition_partitions_post_with_http_info(create_partition_params, opts)
  data
end

#create_partition_partitions_post_with_http_info(create_partition_params, opts = {}) ⇒ Array<(Partition, Integer, Hash)>

Create Partition Create a new partition. Partitions are used to scope documents, connections, and instructions. Partitions must be lowercase alphanumeric and may only include the special characters &#x60;_&#x60; and &#x60;-&#x60;. A partition may also be created by creating a document in it. Limits for a partition may optionally be defined when creating.

Parameters:

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

    the optional parameters

Returns:

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

    Partition 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
77
78
79
80
81
82
83
84
85
86
87
88
 
# File 'lib/ragie_ruby_sdk/api/partitions_api.rb', line 37

def create_partition_partitions_post_with_http_info(create_partition_params, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: PartitionsApi.create_partition_partitions_post ...'
  end
  # verify the required parameter 'create_partition_params' is set
  if @api_client.config.client_side_validation && create_partition_params.nil?
    fail ArgumentError, "Missing the required parameter 'create_partition_params' when calling PartitionsApi.create_partition_partitions_post"
  end
  # resource path
  local_var_path = '/partitions'

  # 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']
  # 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(create_partition_params)

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

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

  new_options = opts.merge(
    :operation => :"PartitionsApi.create_partition_partitions_post",
    :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(:POST, local_var_path, new_options)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: PartitionsApi#create_partition_partitions_post\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#delete_partition_partitions_partition_id_delete(partition_id, opts = {}) ⇒ Hash<String, String>

Delete Partition Deletes a partition and all of its associated data. This includes connections, documents, and partition specific instructions. This operation is irreversible.

Parameters:

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

    the optional parameters

Returns:

  • (Hash<String, String>) 


95
96
97
98
 
# File 'lib/ragie_ruby_sdk/api/partitions_api.rb', line 95

def delete_partition_partitions_partition_id_delete(partition_id, opts = {})
  data, _status_code, _headers = delete_partition_partitions_partition_id_delete_with_http_info(partition_id, opts)
  data
end

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

Delete Partition Deletes a partition and all of its associated data. This includes connections, documents, and partition specific instructions. This operation is irreversible.

Parameters:

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

    the optional parameters

Returns:

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

    Hash<String, String> data, response status code and response headers



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
147
148
149
150
151
 
# File 'lib/ragie_ruby_sdk/api/partitions_api.rb', line 105

def delete_partition_partitions_partition_id_delete_with_http_info(partition_id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: PartitionsApi.delete_partition_partitions_partition_id_delete ...'
  end
  # verify the required parameter 'partition_id' is set
  if @api_client.config.client_side_validation && partition_id.nil?
    fail ArgumentError, "Missing the required parameter 'partition_id' when calling PartitionsApi.delete_partition_partitions_partition_id_delete"
  end
  # resource path
  local_var_path = '/partitions/{partition_id}'.sub('{' + 'partition_id' + '}', CGI.escape(partition_id.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']) 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] || 'Hash<String, String>'

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

  new_options = opts.merge(
    :operation => :"PartitionsApi.delete_partition_partitions_partition_id_delete",
    :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: PartitionsApi#delete_partition_partitions_partition_id_delete\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#get_partition_partitions_partition_id_get(partition_id, opts = {}) ⇒ PartitionDetail

Get Partition Get a partition by its ID. Includes usage information such as the number of documents and pages hosted and processed. The partition’s limits are also included.

Parameters:

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

    the optional parameters

Returns:



158
159
160
161
 
# File 'lib/ragie_ruby_sdk/api/partitions_api.rb', line 158

def get_partition_partitions_partition_id_get(partition_id, opts = {})
  data, _status_code, _headers = get_partition_partitions_partition_id_get_with_http_info(partition_id, opts)
  data
end

#get_partition_partitions_partition_id_get_with_http_info(partition_id, opts = {}) ⇒ Array<(PartitionDetail, Integer, Hash)>

Get Partition Get a partition by its ID. Includes usage information such as the number of documents and pages hosted and processed. The partition&#39;s limits are also included.

Parameters:

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

    the optional parameters

Returns:

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

    PartitionDetail data, response status code and response headers



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/ragie_ruby_sdk/api/partitions_api.rb', line 168

def get_partition_partitions_partition_id_get_with_http_info(partition_id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: PartitionsApi.get_partition_partitions_partition_id_get ...'
  end
  # verify the required parameter 'partition_id' is set
  if @api_client.config.client_side_validation && partition_id.nil?
    fail ArgumentError, "Missing the required parameter 'partition_id' when calling PartitionsApi.get_partition_partitions_partition_id_get"
  end
  # resource path
  local_var_path = '/partitions/{partition_id}'.sub('{' + 'partition_id' + '}', CGI.escape(partition_id.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']) 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] || 'PartitionDetail'

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

  new_options = opts.merge(
    :operation => :"PartitionsApi.get_partition_partitions_partition_id_get",
    :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: PartitionsApi#get_partition_partitions_partition_id_get\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#list_partitions_partitions_get(opts = {}) ⇒ PartitionList

List Partitions List all partitions sorted by name in ascending order. Results are paginated with a max limit of 100. When more partitions are available, a ‘cursor` will be provided. Use the `cursor` parameter to retrieve the subsequent page.

Parameters:

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

    the optional parameters

Options Hash (opts):

  • :cursor (String) —

    An opaque cursor for pagination

  • :page_size (Integer) —

    The number of items per page (must be greater than 0 and less than or equal to 100) (default to 10)

Returns:



222
223
224
225
 
# File 'lib/ragie_ruby_sdk/api/partitions_api.rb', line 222

def list_partitions_partitions_get(opts = {})
  data, _status_code, _headers = list_partitions_partitions_get_with_http_info(opts)
  data
end

#list_partitions_partitions_get_with_http_info(opts = {}) ⇒ Array<(PartitionList, Integer, Hash)>

List Partitions List all partitions sorted by name in ascending order. Results are paginated with a max limit of 100. When more partitions are available, a &#x60;cursor&#x60; will be provided. Use the &#x60;cursor&#x60; parameter to retrieve the subsequent page.

Parameters:

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

    the optional parameters

Options Hash (opts):

  • :cursor (String) —

    An opaque cursor for pagination

  • :page_size (Integer) —

    The number of items per page (must be greater than 0 and less than or equal to 100) (default to 10)

Returns:

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

    PartitionList data, response status code and response headers



233
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
 
# File 'lib/ragie_ruby_sdk/api/partitions_api.rb', line 233

def list_partitions_partitions_get_with_http_info(opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: PartitionsApi.list_partitions_partitions_get ...'
  end
  if @api_client.config.client_side_validation && !opts[:'page_size'].nil? && opts[:'page_size'] > 100
    fail ArgumentError, 'invalid value for "opts[:"page_size"]" when calling PartitionsApi.list_partitions_partitions_get, must be smaller than or equal to 100.'
  end

  if @api_client.config.client_side_validation && !opts[:'page_size'].nil? && opts[:'page_size'] < 1
    fail ArgumentError, 'invalid value for "opts[:"page_size"]" when calling PartitionsApi.list_partitions_partitions_get, must be greater than or equal to 1.'
  end

  # resource path
  local_var_path = '/partitions'

  # query parameters
  query_params = opts[:query_params] || {}
  query_params[:'cursor'] = opts[:'cursor'] if !opts[:'cursor'].nil?
  query_params[:'page_size'] = opts[:'page_size'] if !opts[:'page_size'].nil?

  # 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] || 'PartitionList'

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

  new_options = opts.merge(
    :operation => :"PartitionsApi.list_partitions_partitions_get",
    :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: PartitionsApi#list_partitions_partitions_get\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#set_partition_limits_partitions_partition_id_limits_put(partition_id, partition_limit_params, opts = {}) ⇒ PartitionDetail

Set Partition Limits Sets limits on a partition. Limits can be set on the total number of pages a partition can host and process. When the limit is reached, the partition will be disabled. A limit may be removed by setting it to ‘null`.

Parameters:

  • partition_id (String)
  • partition_limit_params (PartitionLimitParams)
  • opts (Hash) (defaults to: {}) —

    the optional parameters

Returns:



293
294
295
296
 
# File 'lib/ragie_ruby_sdk/api/partitions_api.rb', line 293

def set_partition_limits_partitions_partition_id_limits_put(partition_id, partition_limit_params, opts = {})
  data, _status_code, _headers = set_partition_limits_partitions_partition_id_limits_put_with_http_info(partition_id, partition_limit_params, opts)
  data
end

#set_partition_limits_partitions_partition_id_limits_put_with_http_info(partition_id, partition_limit_params, opts = {}) ⇒ Array<(PartitionDetail, Integer, Hash)>

Set Partition Limits Sets limits on a partition. Limits can be set on the total number of pages a partition can host and process. When the limit is reached, the partition will be disabled. A limit may be removed by setting it to &#x60;null&#x60;.

Parameters:

  • partition_id (String)
  • partition_limit_params (PartitionLimitParams)
  • opts (Hash) (defaults to: {}) —

    the optional parameters

Returns:

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

    PartitionDetail data, response status code and response headers



304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
 
# File 'lib/ragie_ruby_sdk/api/partitions_api.rb', line 304

def set_partition_limits_partitions_partition_id_limits_put_with_http_info(partition_id, partition_limit_params, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: PartitionsApi.set_partition_limits_partitions_partition_id_limits_put ...'
  end
  # verify the required parameter 'partition_id' is set
  if @api_client.config.client_side_validation && partition_id.nil?
    fail ArgumentError, "Missing the required parameter 'partition_id' when calling PartitionsApi.set_partition_limits_partitions_partition_id_limits_put"
  end
  # verify the required parameter 'partition_limit_params' is set
  if @api_client.config.client_side_validation && partition_limit_params.nil?
    fail ArgumentError, "Missing the required parameter 'partition_limit_params' when calling PartitionsApi.set_partition_limits_partitions_partition_id_limits_put"
  end
  # resource path
  local_var_path = '/partitions/{partition_id}/limits'.sub('{' + 'partition_id' + '}', CGI.escape(partition_id.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']) unless header_params['Accept']
  # 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(partition_limit_params)

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

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

  new_options = opts.merge(
    :operation => :"PartitionsApi.set_partition_limits_partitions_partition_id_limits_put",
    :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: PartitionsApi#set_partition_limits_partitions_partition_id_limits_put\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end