Class: Couchbase::Management::Options::Query::GetAllIndexes

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

Overview

Options for QueryIndexManager#get_all_indexes

Instance Attribute Summary collapse

Attributes inherited from Options::Base

#client_context, #parent_span, #retry_strategy, #timeout

Instance Method Summary collapse

Constructor Details

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

Creates an instance of options for QueryIndexManager#get_all_indexes

Parameters:

  • scope_name (String, nil) (defaults to: nil) —

    the name of the scope

  • collection_name (String, nil) (defaults to: nil) —

    the name of the collection

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


41
42
43
44
45
46
47
48
49
50
51
 
# File 'lib/couchbase/management/query_index_manager.rb', line 41

def initialize(scope_name: nil,
               collection_name: nil,
               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)
  @scope_name = scope_name
  @collection_name = collection_name
  yield self if block_given?
end

Instance Attribute Details

#collection_name ⇒ String?

Returns:

  • (String, nil) 


28
29
30
 
# File 'lib/couchbase/management/query_index_manager.rb', line 28

def collection_name
  @collection_name
end

#scope_name ⇒ String?

Returns:

  • (String, nil) 


27
28
29
 
# File 'lib/couchbase/management/query_index_manager.rb', line 27

def scope_name
  @scope_name
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. 



54
55
56
57
58
59
60
 
# File 'lib/couchbase/management/query_index_manager.rb', line 54

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