Class: Couchbase::Management::Options::Analytics::GetLinks

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

Overview

Options for AnalyticsIndexManager#get_links

Instance Attribute Summary collapse

Attributes inherited from Options::Base

#client_context, #parent_span, #retry_strategy, #timeout

Instance Method Summary collapse

Constructor Details

#initialize(link_type: nil, dataverse: nil, name: nil, timeout: nil, retry_strategy: nil, client_context: nil, parent_span: nil) {|self| ... } ⇒ GetLinks

Creates an instance of options for AnalyticsIndexManager#get_links

Parameters:

  • link_type (:s3, :azureblob, :couchbase, nil) (defaults to: nil) —

    restricts the results to the given link type.

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

    restricts the results to a given dataverse, can be given in the form of “namepart” or “namepart1/namepart2”.

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

    restricts the results to the link with the specified name. If set then dataverse must also be set.

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



491
492
493
494
495
496
497
498
499
500
501
502
503
 
# File 'lib/couchbase/management/analytics_index_manager.rb', line 491

def initialize(link_type: nil,
               dataverse: nil,
               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_type = link_type
  @dataverse = dataverse
  @name = name
  yield self if block_given?
end

Instance Attribute Details

#dataverse ⇒ String?

Returns:

  • (String, nil) 


472
473
474
 
# File 'lib/couchbase/management/analytics_index_manager.rb', line 472

def dataverse
  @dataverse
end

#link_type ⇒ Symbol?

Returns:

  • (Symbol, nil) 


473
474
475
 
# File 'lib/couchbase/management/analytics_index_manager.rb', line 473

def link_type
  @link_type
end

#name ⇒ String?

Returns:

  • (String, nil) 


474
475
476
 
# File 'lib/couchbase/management/analytics_index_manager.rb', line 474

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



506
507
508
509
510
511
512
513
 
# File 'lib/couchbase/management/analytics_index_manager.rb', line 506

def to_backend
  {
    timeout: Utils::Time.extract_duration(@timeout),
    link_type: @link_type.to_s,
    dataverse: @dataverse,
    name: @name,
  }
end