Class: Couchbase::Management::Options::Query::WatchIndexes

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

Overview

Instance Attribute Summary collapse

Attributes inherited from Options::Base

#client_context, #parent_span, #retry_strategy, #timeout

Instance Method Summary collapse

Constructor Details

#initialize(watch_primary: false, retry_strategy: nil, client_context: nil, parent_span: nil) {|self| ... } ⇒ WatchIndexes

Creates an instance of options for QueryIndexManager#watch_indexes

Parameters:

  • watch_primary (Boolean) (defaults to: false)

    whether or not to watch the primary index

  • 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 (GetAllScopes)


269
270
271
272
273
274
275
276
# File 'lib/couchbase/management/query_index_manager.rb', line 269

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

Instance Attribute Details

#watch_primaryBoolean

Returns:

  • (Boolean)


259
260
261
# File 'lib/couchbase/management/query_index_manager.rb', line 259

def watch_primary
  @watch_primary
end