Class: Couchbase::Management::SearchIndex

Inherits:

Object

• Object
• Couchbase::Management::SearchIndex

Defined in:

lib/couchbase/management/search_index_manager.rb

Instance Attribute Summary

• #name ⇒ String

  Name of the index.

• #params ⇒ Hash

  Index properties such as store type and mappings.

• #plan_params ⇒ Hash

  Plan properties such a number of replicas and number of partitions.

• #source_name ⇒ String

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

• #source_params ⇒ Hash

  Extra parameters for the source.

• #source_type ⇒ String

  Type of the data source.

• #source_uuid ⇒ String

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

• #type ⇒ String

  Type of the index.

• #uuid ⇒ String

  UUID is required for update.

Instance Method Summary

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

  A new instance of SearchIndex.

• #to_backend ⇒ Object private

Constructor Details

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

Returns a new instance of SearchIndex.

Yield Parameters:

• self (SearchIndex)

# File 'lib/couchbase/management/search_index_manager.rb', line 402

def initialize
  @type = "fulltext-index"
  @source_type = "couchbase"
  yield self if block_given?
end

Instance Attribute Details

#name ⇒ String

# File 'lib/couchbase/management/search_index_manager.rb', line 375

def name
  @name
end

#params ⇒ Hash

# File 'lib/couchbase/management/search_index_manager.rb', line 384

def params
  @params
end

#plan_params ⇒ Hash

# File 'lib/couchbase/management/search_index_manager.rb', line 399

def plan_params
  @plan_params
end

#source_name ⇒ String

# File 'lib/couchbase/management/search_index_manager.rb', line 387

def source_name
  @source_name
end

#source_params ⇒ Hash

# File 'lib/couchbase/management/search_index_manager.rb', line 396

def source_params
  @source_params
end

#source_type ⇒ String

# File 'lib/couchbase/management/search_index_manager.rb', line 390

def source_type
  @source_type
end

#source_uuid ⇒ String

# File 'lib/couchbase/management/search_index_manager.rb', line 393

def source_uuid
  @source_uuid
end

#type ⇒ String

# File 'lib/couchbase/management/search_index_manager.rb', line 378

def type
  @type
end

#uuid ⇒ String

# File 'lib/couchbase/management/search_index_manager.rb', line 381

def uuid
  @uuid
end

Instance Method Details

#to_backend ⇒ Object

This method is part of a private API. You should avoid using this method if possible, as it may be removed or be changed in the future.

# File 'lib/couchbase/management/search_index_manager.rb', line 409

def to_backend
  {
    name: name,
    type: type,
    uuid: uuid,
    params: (JSON.generate(params) if params),
    source_name: source_name,
    source_type: source_type,
    source_uuid: source_uuid,
    source_params: (JSON.generate(source_params) if source_params),
    plan_params: (JSON.generate(plan_params) if plan_params),
  }
end