Class: Couchbase::Options::Ping

Inherits:
Object
  • Object
show all
Defined in:
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) {|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:



1190
1191
1192
1193
1194
1195
1196
1197
# File 'lib/couchbase/options.rb', line 1190

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_idString

Returns:

  • (String)


1179
1180
1181
# File 'lib/couchbase/options.rb', line 1179

def report_id
  @report_id
end

#service_typesArray<Symbol>

Returns:

  • (Array<Symbol>)


1180
1181
1182
# File 'lib/couchbase/options.rb', line 1180

def service_types
  @service_types
end

#timeoutInteger, #in_milliseconds

Returns:

  • (Integer, #in_milliseconds)


1181
1182
1183
# File 'lib/couchbase/options.rb', line 1181

def timeout
  @timeout
end