Class: Couchbase::Options::Ping

Inherits:
Object
  • Object
show all
Defined in:
lib/couchbase/options.rb,
/home/runner/work/couchbase-ruby-client/couchbase-ruby-client/lib/couchbase/options.rb

Overview

Options for Bucket#ping

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(report_id: nil, service_types: [:kv, :query, :analytics, :search, :views, :management], timeout: nil, parent_span: nil) {|self| ... } ⇒ Ping

Creates an instance of options for Bucket#ping

Parameters:

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

    Holds custom report id.

  • service_types (Array<Symbol>) (defaults to: [:kv, :query, :analytics, :search, :views, :management]) —

    The service types to limit this ping request

  • timeout (Integer, #in_milliseconds) (defaults to: nil)
  • parent_span (Span, nil) (defaults to: nil) —

    if set holds the parent span, that should be used for this request

Yield Parameters:



1992
1993
1994
1995
1996
1997
1998
1999
2000
2001
2002
 
# File 'lib/couchbase/options.rb', line 1992

def initialize(report_id: nil,
               service_types: [:kv, :query, :analytics, :search, :views, :management],
               timeout: nil,
               parent_span: nil)
  @report_id = report_id
  @service_types = service_types
  @timeout = timeout
  @parent_span = parent_span

  yield self if block_given?
end

Instance Attribute Details

#parent_span ⇒ Span?

Returns:

  • (Span, nil) 


1982
1983
1984
 
# File 'lib/couchbase/options.rb', line 1982

def parent_span
  @parent_span
end

#report_id ⇒ String

Returns:

  • (String) 


1979
1980
1981
 
# File 'lib/couchbase/options.rb', line 1979

def report_id
  @report_id
end

#service_types ⇒ Array<Symbol>

Returns:

  • (Array<Symbol>) 


1980
1981
1982
 
# File 'lib/couchbase/options.rb', line 1980

def service_types
  @service_types
end

#timeout ⇒ Integer, #in_milliseconds

Returns:

  • (Integer, #in_milliseconds) 


1981
1982
1983
 
# File 'lib/couchbase/options.rb', line 1981

def timeout
  @timeout
end