API Docs for: 2.2.2
Show:

FetchPreflist.Builder Class

Defined in: lib/commands/kv/fetchpreflist.js:91
Module: KV

A builder for constructing FetchPreflist instances.

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

var fetchValue = new FetchPreflist.Builder()
     .withBucketType('myBucketType')
     .withBucket('myBucket')
     .withKey('myKey')
     .build();

Constructor

FetchPreflist.Builder

()

Defined in lib/commands/kv/fetchpreflist.js:91

Methods

build

() FetchPreflist

Defined in lib/commands/kv/fetchpreflist.js:154

Construct a FetchPreflist command.

Returns:

FetchPreflist:

withBucket

(
  • bucket
)
chainable

Defined in lib/commands/kv/fetchpreflist.js:121

Set the bucket.

Parameters:

  • bucket String

    the bucket in Riak

withBucketType

(
  • bucketType
)
chainable

Defined in lib/commands/kv/fetchpreflist.js:110

Set the bucket type. If not supplied, 'default' is used.

Parameters:

  • bucketType String

    the bucket type in riak

withCallback

(
  • callback
)
chainable

Defined in lib/commands/kv/fetchpreflist.js:141

Set the callback to be executed when the operation completes.

Parameters:

  • callback Function

    The callback to be executed when the operation completes.

    • err String

      An error message. Will ne null if no error.

    • response Object

      the response from Riak.

      • preflist Object
        An array of one or more preflist items.

withKey

(
  • key
)
chainable

Defined in lib/commands/kv/fetchpreflist.js:131

Set the key.

Parameters:

  • key String

    the key in riak.