Class: Couchbase::Management::Options::Collection::DropCollection

Inherits:
Options::Base
  • Object
show all
Defined in:
lib/couchbase/management/collection_manager.rb

Overview

Options for CollectionManager#drop_collection

Constant Summary collapse

DEFAULT = 
DropCollection.new.freeze

Instance Attribute Summary

Attributes inherited from Options::Base

#client_context, #parent_span, #retry_strategy, #timeout

Instance Method Summary collapse

Methods inherited from Options::Base

#to_backend

Constructor Details

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

Creates an instance of options for CollectionManager#drop_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:



141
142
143
144
145
146
147
 
# File 'lib/couchbase/management/collection_manager.rb', line 141

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