Class: Couchbase::Options::Base

Inherits:

Object

• Object
• Couchbase::Options::Base

Defined in:

lib/couchbase/options.rb,
/Users/sergey.auseyau/code/couchbase-ruby-client/lib/couchbase/options.rb more...

Overview

Base class for most of the options

Direct Known Subclasses

Analytics, Append, Decrement, Exists, Get, GetAllReplicas, GetAndLock, GetAndTouch, GetAnyReplica, GetMulti, Increment, Insert, LookupIn, MutateIn, Prepend, Query, Remove, RemoveMulti, Replace, Search, Touch, Unlock, Upsert, UpsertMulti, View

Instance Attribute Summary

• #client_context ⇒ Hash^?
• #parent_span ⇒ Span^?
• #retry_strategy ⇒ Proc^?
• #timeout ⇒ Integer, ...

Instance Method Summary

• #initialize(timeout: nil, retry_strategy: nil, client_context: nil, parent_span: nil) {|| ... } ⇒ Base constructor

  A new instance of Base.

Constructor Details

#initialize(timeout: nil, retry_strategy: nil, client_context: nil, parent_span: nil) {|| ... } ⇒ Base

Returns a new instance of Base.

Parameters:

• timeout (Integer, #in_milliseconds, nil) (defaults to: nil) —

  the time in milliseconds allowed for the operation to complete

• retry_strategy (Proc, nil) (defaults to: nil) —

  the custom retry strategy, if set

• client_context (Hash, nil) (defaults to: nil) —

  the client context data, if set

• parent_span (Span, nil) (defaults to: nil) —

  if set holds the parent span, that should be used for this request

Yield Parameters:

• (Base)

# File 'lib/couchbase/options.rb', line 33

def initialize(timeout: nil,
               retry_strategy: nil,
               client_context: nil,
               parent_span: nil)
  @timeout = timeout
  @retry_strategy = retry_strategy
  @client_context = client_context
  @parent_span = parent_span
  yield self if block_given?
end

Instance Attribute Details

#client_context ⇒ Hash^?

Returns:

• (Hash, nil)

# File 'lib/couchbase/options.rb', line 24

def client_context
  @client_context
end

#parent_span ⇒ Span^?

Returns:

• (Span, nil)

# File 'lib/couchbase/options.rb', line 25

def parent_span
  @parent_span
end

#retry_strategy ⇒ Proc^?

Returns:

• (Proc, nil)

# File 'lib/couchbase/options.rb', line 23

def retry_strategy
  @retry_strategy
end

#timeout ⇒ Integer, ...

Returns:

• (Integer, #in_milliseconds, nil)

# File 'lib/couchbase/options.rb', line 22

def timeout
  @timeout
end