Class: Couchbase::Management::Options::Analytics::CreateDataverse

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

Overview

Options for AnalyticsIndexManager#create_dataverse

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, timeout: nil, retry_strategy: nil, client_context: nil, parent_span: nil) {|self| ... } ⇒ CreateDataverse

Creates an instance of options for AnalyticsIndexManager#create_dataverse

Parameters:

  • ignore_if_exists (Boolean) (defaults to: false) —

    if true, the exception Error::DataverseExists will not be raised if the dataverse with the specified name already exists.

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



39
40
41
42
43
44
45
46
47
 
# File 'lib/couchbase/management/analytics_index_manager.rb', line 39

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

Instance Attribute Details

#ignore_if_exists ⇒ Boolean

Returns:

  • (Boolean) 


26
27
28
 
# File 'lib/couchbase/management/analytics_index_manager.rb', line 26

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. 



50
51
52
53
54
55
 
# File 'lib/couchbase/management/analytics_index_manager.rb', line 50

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