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

Yield Parameters:



1018
1019
1020
1021
1022
1023
1024
1025
1026
1027
1028
 
# File 'lib/couchbase/options.rb', line 1018

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. 



1040
1041
1042
 
# File 'lib/couchbase/options.rb', line 1040

def access_deleted
  @access_deleted
end

#transcoder ⇒ JsonTranscoder, #decode(String) 



1005
1006
1007
 
# File 'lib/couchbase/options.rb', line 1005

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. 



1031
1032
1033
1034
1035
1036
 
# File 'lib/couchbase/options.rb', line 1031

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