API Docs for: 2.2.2
Show:

FetchIndex.Builder Class

Defined in: lib/commands/yokozuna/fetchindex.js:79
Module: YZ

A builder for constructing FetchIndex instances.

Rather than having to manually construct the options and instantiating a FetchIndex directly, this builder may be used.

var fetch = FetchIndex.Builder()
             .withIndexName('index_name')
             .withCallback(callback)
             .build();

Constructor

FetchIndex.Builder

()

Defined in lib/commands/yokozuna/fetchindex.js:79

Item Index

Methods

Methods

build

() FetchIndex

Defined in lib/commands/yokozuna/fetchindex.js:122

Construct a FetchIndex instance.

Returns:

FetchIndex:

withCallback

(
  • callback
)
chainable

Defined in lib/commands/yokozuna/fetchindex.js:108

Set the callback to be executed when the operation completes.

Parameters:

  • callback Function

    the callback to be executed when the operation completes.

    • err String

      error message

    • response Object

      array of indexes.

      • indexName String
        The name of the index.
      • schemaName String
        The schema for the index.

withIndexName

(
  • indexName
)
chainable

Defined in lib/commands/yokozuna/fetchindex.js:97

The name of the index to fetch. If one is not supplied, all indexes are returned.

Parameters:

  • indexName String

    the name of the index