Class: Couchbase::Management::Options::Analytics::CreateDataset

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

Overview

Options for AnalyticsIndexManager#create_dataset

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

Creates an instance of options for AnalyticsIndexManager#create_dataset

Parameters:

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

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

  • condition (String) (defaults to: nil) —

    WHERE clause to use for creating dataset

  • dataverse_name (String) (defaults to: nil) —

    the name of the dataverse to use (defaults to nil)

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



111
112
113
114
115
116
117
118
119
120
121
122
123
 
# File 'lib/couchbase/management/analytics_index_manager.rb', line 111

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

Instance Attribute Details

#condition ⇒ String

Returns:

  • (String) 


95
96
97
 
# File 'lib/couchbase/management/analytics_index_manager.rb', line 95

def condition
  @condition
end

#dataverse_name ⇒ String

Returns:

  • (String) 


96
97
98
 
# File 'lib/couchbase/management/analytics_index_manager.rb', line 96

def dataverse_name
  @dataverse_name
end

#ignore_if_exists ⇒ Boolean

Returns:

  • (Boolean) 


94
95
96
 
# File 'lib/couchbase/management/analytics_index_manager.rb', line 94

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. 



126
127
128
129
130
131
132
133
 
# File 'lib/couchbase/management/analytics_index_manager.rb', line 126

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