Class: Couchbase::Management::Options::Analytics::CreateIndex

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

Overview

Options for AnalyticsIndexManager#create_index

Instance Attribute Summary collapse

Attributes inherited from Options::Base

#client_context, #parent_span, #retry_strategy, #timeout

Instance Method Summary collapse

Constructor Details

#initialize(ignore_if_exists: false, dataverse_name: nil, timeout: nil, retry_strategy: nil, client_context: nil, parent_span: nil) {|self| ... } ⇒ CreateIndex

Creates an instance of options for AnalyticsIndexManager#create_index

Yield Parameters:



209
210
211
212
213
214
215
216
217
218
219
 
# File 'lib/couchbase/management/analytics_index_manager.rb', line 209

def initialize(ignore_if_exists: false,
               dataverse_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)
  @ignore_if_exists = ignore_if_exists
  @dataverse_name = dataverse_name
  yield self if block_given?
end

Instance Attribute Details

#dataverse_name ⇒ String 



195
196
197
 
# File 'lib/couchbase/management/analytics_index_manager.rb', line 195

def dataverse_name
  @dataverse_name
end

#ignore_if_exists ⇒ Boolean 



194
195
196
 
# File 'lib/couchbase/management/analytics_index_manager.rb', line 194

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



222
223
224
225
226
227
228
 
# File 'lib/couchbase/management/analytics_index_manager.rb', line 222

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