Class: Couchbase::Management::Options::Analytics::ConnectLink

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

Overview

Options for AnalyticsIndexManager#connect_link

Instance Attribute Summary collapse

Attributes inherited from Options::Base

#client_context, #parent_span, #retry_strategy, #timeout

Instance Method Summary collapse

Constructor Details

#initialize(link_name: "Local", force: false, dataverse_name: nil, timeout: nil, retry_strategy: nil, client_context: nil, parent_span: nil) {|self| ... } ⇒ ConnectLink

Creates an instance of options for AnalyticsIndexManager#connect_link

Parameters:

  • link_name (String) (defaults to: "Local") —

    the name of the link

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

    if true, link creation will be forced even if the bucket UUID changed, for example due to the bucket being deleted and recreated

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



310
311
312
313
314
315
316
317
318
319
320
321
322
 
# File 'lib/couchbase/management/analytics_index_manager.rb', line 310

def initialize(link_name: "Local",
               force: 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)
  @link_name = link_name
  @force = force
  @dataverse_name = dataverse_name
  yield self if block_given?
end

Instance Attribute Details

#dataverse_name ⇒ String

Returns:

  • (String) 


295
296
297
 
# File 'lib/couchbase/management/analytics_index_manager.rb', line 295

def dataverse_name
  @dataverse_name
end

#force ⇒ Boolean

Returns:

  • (Boolean) 


294
295
296
 
# File 'lib/couchbase/management/analytics_index_manager.rb', line 294

def force
  @force
end

#link_name ⇒ String

Returns:

  • (String) 


293
294
295
 
# File 'lib/couchbase/management/analytics_index_manager.rb', line 293

def link_name
  @link_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. 



325
326
327
328
329
330
331
332
 
# File 'lib/couchbase/management/analytics_index_manager.rb', line 325

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