Class: Couchbase::Options::GetAnyReplica

Inherits:
Base
  • Object
show all
Defined in:
lib/couchbase/options.rb

Overview

Options for Collection#get_any_replica

Constant Summary collapse

DEFAULT =

This constant is part of a private API. You should avoid using this constant if possible, as it may be removed or be changed in the future. 

GetAnyReplica.new.freeze

Instance Attribute Summary collapse

Attributes inherited from Base

#client_context, #parent_span, #retry_strategy, #timeout

Instance Method Summary collapse

Constructor Details

#initialize(transcoder: JsonTranscoder.new, read_preference: :no_preference, timeout: nil, retry_strategy: nil, client_context: nil, parent_span: nil) {|self| ... } ⇒ GetAnyReplica

Creates an instance of options for Collection#get_any_replica

Parameters:

  • transcoder (JsonTranscoder, #decode(String, Integer)) (defaults to: JsonTranscoder.new) —

    used for decoding

  • read_preference (Symbol) (defaults to: :no_preference) —

    decides how the replica nodes will be selected.

    :no_preference

    no preference and will select any available replica. This is the default

    :selected_server_group

    restrict to nodes in Cluster#preferred_server_group

  • 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:



297
298
299
300
301
302
303
304
305
306
307
 
# File 'lib/couchbase/options.rb', line 297

def initialize(transcoder: JsonTranscoder.new,
               read_preference: :no_preference,
               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)
  @transcoder = transcoder
  @read_preference = read_preference
  yield self if block_given?
end

Instance Attribute Details

#read_preference ⇒ Symbol

Returns:

  • (Symbol) 


282
283
284
 
# File 'lib/couchbase/options.rb', line 282

def read_preference
  @read_preference
end

#transcoder ⇒ JsonTranscoder, #decode(String, Integer)

Returns:



281
282
283
 
# File 'lib/couchbase/options.rb', line 281

def transcoder
  @transcoder
end

Instance Method Details

#to_backend ⇒ Object

This method is part of a private API. You should avoid using this method if possible, as it may be removed or be changed in the future. 



310
311
312
313
314
315
 
# File 'lib/couchbase/options.rb', line 310

def to_backend
  {
    timeout: Utils::Time.extract_duration(@timeout),
    read_preference: @read_preference,
  }
end