Class: Couchbase::Options::GetAllReplicas

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

Overview

Options for Collection#get_all_replicas

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. 

GetAllReplicas.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| ... } ⇒ GetAllReplicas

Creates an instance of options for Collection#get_all_replicas

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:



255
256
257
258
259
260
261
262
263
264
265
 
# File 'lib/couchbase/options.rb', line 255

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) 


240
241
242
 
# File 'lib/couchbase/options.rb', line 240

def read_preference
  @read_preference
end

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

Returns:



239
240
241
 
# File 'lib/couchbase/options.rb', line 239

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. 



268
269
270
271
272
273
 
# File 'lib/couchbase/options.rb', line 268

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