Class: Couchbase::Options::Ping

Inherits:
Object
  • Object
show all
Defined in:
lib/couchbase/options.rb

Overview

Options for Bucket#ping

Constant Summary collapse

DEFAULT =

This constant is part of a private API. You should avoid using this constant if possible, as it may be removed or be changed in the future. 

Ping.new.freeze

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

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

Creates an instance of options for Bucket#ping

@@param [Array<Symbol>] service_types The service types to limit this diagnostics request

Parameters:

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

    Holds custom report id.

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

Yield Parameters:



1864
1865
1866
1867
1868
1869
1870
1871
 
# File 'lib/couchbase/options.rb', line 1864

def initialize(report_id: nil,
               service_types: [:kv, :query, :analytics, :search, :views, :management],
               timeout: nil)
  @report_id = report_id
  @service_types = service_types
  @timeout = timeout
  yield self if block_given?
end

Instance Attribute Details

#report_id ⇒ String

Returns:

  • (String) 


1853
1854
1855
 
# File 'lib/couchbase/options.rb', line 1853

def report_id
  @report_id
end

#service_types ⇒ Array<Symbol>

Returns:

  • (Array<Symbol>) 


1854
1855
1856
 
# File 'lib/couchbase/options.rb', line 1854

def service_types
  @service_types
end

#timeout ⇒ Integer, #in_milliseconds

Returns:

  • (Integer, #in_milliseconds) 


1855
1856
1857
 
# File 'lib/couchbase/options.rb', line 1855

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



1874
1875
1876
1877
1878
1879
1880
 
# File 'lib/couchbase/options.rb', line 1874

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