Class: Couchbase::Options::Prepend

Inherits:
Base
  • Object
show all
Defined in:
lib/couchbase/options.rb,
/Users/sergey.auseyau/code/couchbase-ruby-client/lib/couchbase/options.rb more...

Overview

Options for BinaryCollection#prepend

Instance Attribute Summary collapse

Attributes inherited from Base

#client_context, #parent_span, #retry_strategy, #timeout

Instance Method Summary collapse

Constructor Details

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

Creates an instance of options for BinaryCollection#prepend

Parameters:

  • cas (Integer) (defaults to: nil) —

    The default CAS used (0 means no CAS in this context)

  • timeout (Integer, #in_milliseconds, nil) (defaults to: nil)
  • 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:

[View source]

829
830
831
832
833
834
835
836
837
 
# File 'lib/couchbase/options.rb', line 829

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

Instance Attribute Details

#cas ⇒ Integer

Returns The default CAS used (0 means no CAS in this context).

Returns:

  • (Integer) —

    The default CAS used (0 means no CAS in this context)


817
818
819
 
# File 'lib/couchbase/options.rb', line 817

def cas
  @cas
end