Class: Couchbase::Options::LookupIn

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

Overview

Options for Collection#lookup_in

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. 

LookupIn.new.freeze

Instance Attribute Summary collapse

Attributes inherited from Base

#client_context, #parent_span, #retry_strategy, #timeout

Instance Method Summary collapse

Constructor Details

#initialize(access_deleted: false, transcoder: JsonTranscoder.new, timeout: nil, retry_strategy: nil, client_context: nil, parent_span: nil) {|self| ... } ⇒ LookupIn

Creates an instance of options for Collection#lookup_in

Parameters:

  • access_deleted (Boolean) (defaults to: false) —

    for internal use only: allows access to deleted documents that are in “tombstone” form

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

    used for encoding

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



1004
1005
1006
1007
1008
1009
1010
1011
1012
1013
1014
 
# File 'lib/couchbase/options.rb', line 1004

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

Instance Attribute Details

#access_deleted ⇒ Boolean

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.

Returns:

  • (Boolean) 


1026
1027
1028
 
# File 'lib/couchbase/options.rb', line 1026

def access_deleted
  @access_deleted
end

#transcoder ⇒ JsonTranscoder, #decode(String)

Returns:



991
992
993
 
# File 'lib/couchbase/options.rb', line 991

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. 



1017
1018
1019
1020
1021
1022
 
# File 'lib/couchbase/options.rb', line 1017

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