API Docs for: 2.2.2
Show:

FetchBucketProps Class

Extends FetchPropsBase
Defined in: lib/commands/kv/fetchbucketprops.js:12
Module: KV

Command used to fetch a bucket's properties from Riak.

As a convenience, a builder class is provided:

var fetch = new FetchBucketProps.Builder()
    .withBucketType('my_type')
    .withBucket('myBucket')
    .withCallback(myCallback)
    .build();

See FetchBucketProps.Builder

Constructor

FetchBucketProps

(
  • options
  • callback
)

Defined in lib/commands/kv/fetchbucketprops.js:12

Parameters:

  • options Object

    The options for this command

    • [bucketType=default] String optional

      The bucket type in riak.

    • bucket String

      The bucket in riak.

  • 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. This is an oject with all the bucket properties.

    • data Object

      additional error data. Will be null if no error.

Methods

constructPbRequest

() Object protected

Inherited from CommandBase: lib/commands/commandbase.js:128

Construct and return the Riak protocol buffer message for this command. Subclasses must override this method.

Returns:

Object: a protocol buffer message builder

getCallback

() Function private

Inherited from CommandBase: lib/commands/commandbase.js:68

Fires the user's callback with the arguments passed in.

Returns:

Function: the user supplied callback

getExpectedResponseCode

() Number private

Inherited from CommandBase: lib/commands/commandbase.js:78

Returns the expected response code for this command.

Returns:

Number: the expected response code for this command.

getPbReqBuilder

() Object private

Inherited from CommandBase: lib/commands/commandbase.js:111

Returns and instance of the protocol buffer message builder for this command. This is determined via the pbRequestName passed to the constructor.

Returns:

Object: the builder for the protocol buffer message to be sent for this command

getRiakMessage

() Object private

Inherited from CommandBase: lib/commands/commandbase.js:88

Returns the encoded protobuf and message header.

Returns:

Object: object containing the header and encoded protobuf

onError

(
  • msg
  • data
)
protected

Inherited from CommandBase: lib/commands/commandbase.js:164

Called by RiakNode if an error occurs executing the command and all retries are exhausted.

Parameters:

  • msg String
    an error message
  • data Object
    additional error data

onRiakError

(
  • rpbErrorResp
)
protected

Inherited from CommandBase: lib/commands/commandbase.js:151

Called by RiakNode when a RpbErrorResp is received and all retries are exhausted. Commands may override this method.

Parameters:

  • rpbErrorResp Object
    the RpbErrorResp protocol buffer

onSuccess

(
  • pbResponseMessage
)
Boolean protected

Inherited from CommandBase: lib/commands/commandbase.js:139

Called by RiakNode when a response is received. Subclasses must override this method.

Parameters:

  • pbResponseMessage Object
    the protocol buffer received from riak

Returns:

Boolean: true if not streaming or the last response has been received, false otherwise.

withBucketType

(
  • bucketType
)
chainable

Inherited from FetchPropsBase: lib/commands/kv/fetchpropsbase.js:115

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

Parameters:

  • bucketType String
    the bucket type in riak

withCallback

(
  • callback
)
chainable

Inherited from FetchPropsBase: lib/commands/kv/fetchpropsbase.js:127

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. This is an oject with all the bucket properties.