Class: Couchbase::Management::SearchIndex

Inherits:
Object
  • Object
show all
Defined in:
lib/couchbase/management/search_index_manager.rb

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize {|self| ... } ⇒ SearchIndex

Returns a new instance of SearchIndex.

Yield Parameters:

[View source]

359
360
361
 
# File 'lib/couchbase/management/search_index_manager.rb', line 359

def initialize
  yield self if block_given?
end

Instance Attribute Details

#name ⇒ String

Returns name of the index.

Returns:

  • (String) —

    name of the index


332
333
334
 
# File 'lib/couchbase/management/search_index_manager.rb', line 332

def name
  @name
end

#params ⇒ Hash

Returns index properties such as store type and mappings.

Returns:

  • (Hash) —

    index properties such as store type and mappings


341
342
343
 
# File 'lib/couchbase/management/search_index_manager.rb', line 341

def params
  @params
end

#plan_params ⇒ Hash

Returns plan properties such a number of replicas and number of partitions.

Returns:

  • (Hash) —

    plan properties such a number of replicas and number of partitions


356
357
358
 
# File 'lib/couchbase/management/search_index_manager.rb', line 356

def plan_params
  @plan_params
end

#source_name ⇒ String

Returns name of the source of the data for the index (e.g. bucket name).

Returns:

  • (String) —

    name of the source of the data for the index (e.g. bucket name)


344
345
346
 
# File 'lib/couchbase/management/search_index_manager.rb', line 344

def source_name
  @source_name
end

#source_params ⇒ Hash

Returns extra parameters for the source. These are usually things like advanced connection and tuning.

Returns:

  • (Hash) —

    extra parameters for the source. These are usually things like advanced connection and tuning.


353
354
355
 
# File 'lib/couchbase/management/search_index_manager.rb', line 353

def source_params
  @source_params
end

#source_type ⇒ String

Returns type of the data source.

Returns:

  • (String) —

    type of the data source


347
348
349
 
# File 'lib/couchbase/management/search_index_manager.rb', line 347

def source_type
  @source_type
end

#source_uuid ⇒ String

Returns the UUID of the ata source, this can be used to more tightly tie the index to a source.

Returns:

  • (String) —

    the UUID of the ata source, this can be used to more tightly tie the index to a source


350
351
352
 
# File 'lib/couchbase/management/search_index_manager.rb', line 350

def source_uuid
  @source_uuid
end

#type ⇒ String

Returns type of the index.

Returns:

  • (String) —

    type of the index


335
336
337
 
# File 'lib/couchbase/management/search_index_manager.rb', line 335

def type
  @type
end

#uuid ⇒ String

Returns UUID is required for update. It provides means of ensuring consistency.

Returns:

  • (String) —

    UUID is required for update. It provides means of ensuring consistency.


338
339
340
 
# File 'lib/couchbase/management/search_index_manager.rb', line 338

def uuid
  @uuid
end