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.

API:

  • private

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] service_types The service types to limit this diagnostics request

Parameters:

  • (defaults to: nil)

    Holds custom report id.

  • (defaults to: nil)

Yield Parameters:



1930
1931
1932
1933
1934
1935
1936
1937
 
# File 'lib/couchbase/options.rb', line 1930

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:



1919
1920
1921
 
# File 'lib/couchbase/options.rb', line 1919

def report_id
  @report_id
end

#service_types ⇒ Array<Symbol>

Returns:



1920
1921
1922
 
# File 'lib/couchbase/options.rb', line 1920

def service_types
  @service_types
end

#timeout ⇒ Integer, #in_milliseconds

Returns:



1921
1922
1923
 
# File 'lib/couchbase/options.rb', line 1921

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.

API:

  • private



1940
1941
1942
1943
1944
1945
1946
 
# File 'lib/couchbase/options.rb', line 1940

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