Class: Couchbase::Management::Options::Collection::UpdateCollection

Inherits:

Options::Base

• Object
• Options::Base
• Couchbase::Management::Options::Collection::UpdateCollection

Defined in:

lib/couchbase/management/collection_manager.rb

Overview

Options for CollectionManager#update_collection

Constant Summary

DEFAULT =

UpdateCollection.new.freeze

Instance Attribute Summary

Attributes inherited from Options::Base

#client_context, #parent_span, #retry_strategy, #timeout

Instance Method Summary

• #initialize(timeout: nil, retry_strategy: nil, client_context: nil, parent_span: nil) {|self| ... } ⇒ UpdateCollection constructor

  Creates an instance of options for CollectionManager#update_collection.

Methods inherited from Options::Base

#to_backend

Constructor Details

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

Creates an instance of options for CollectionManager#update_collection

Parameters:

• timeout (Integer, #in_milliseconds, nil) (defaults to: nil) —

  the time in milliseconds allowed for the operation to complete

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

• self (UpdateCollection)

# File 'lib/couchbase/management/collection_manager.rb', line 120

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