Class: Couchbase::Options::Cluster

Inherits:
Object
  • Object
show all
Defined in:
lib/couchbase/options.rb,
/Users/sergey.auseyau/code/couchbase-ruby-client/lib/couchbase/options.rb more...

Overview

Options for Cluster.connect

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(authenticator: nil, enable_metrics: nil, metrics_emit_interval: nil, enable_tracing: nil, orphaned_emit_interval: nil, orphaned_sample_size: nil, threshold_emit_interval: nil, threshold_sample_size: nil, key_value_threshold: nil, query_threshold: nil, view_threshold: nil, search_threshold: nil, analytics_threshold: nil, management_threshold: nil) {|self| ... } ⇒ Cluster

Creates an instance of options for Cluster.connect

Parameters:

Yield Parameters:

[View source]

1171
1172
1173
1174
1175
1176
1177
1178
1179
1180
1181
1182
1183
1184
1185
1186
1187
1188
1189
1190
1191
1192
1193
1194
1195
1196
1197
1198
1199
1200
 
# File 'lib/couchbase/options.rb', line 1171

def initialize(authenticator: nil,
               enable_metrics: nil,
               metrics_emit_interval: nil,
               enable_tracing: nil,
               orphaned_emit_interval: nil,
               orphaned_sample_size: nil,
               threshold_emit_interval: nil,
               threshold_sample_size: nil,
               key_value_threshold: nil,
               query_threshold: nil,
               view_threshold: nil,
               search_threshold: nil,
               analytics_threshold: nil,
               management_threshold: nil)
  @authenticator = authenticator
  @enable_metrics = enable_metrics
  @metrics_emit_interval = metrics_emit_interval
  @enable_tracing = enable_tracing
  @orphaned_emit_interval = orphaned_emit_interval
  @orphaned_sample_size = orphaned_sample_size
  @threshold_emit_interval = threshold_emit_interval
  @threshold_sample_size = threshold_sample_size
  @key_value_threshold = key_value_threshold
  @query_threshold = query_threshold
  @view_threshold = view_threshold
  @search_threshold = search_threshold
  @analytics_threshold = analytics_threshold
  @management_threshold = management_threshold
  yield self if block_given?
end

Instance Attribute Details

#analytics_threshold ⇒ nil, ...

Returns:

  • (nil, Integer, #in_milliseconds) 

1163
1164
1165
 
# File 'lib/couchbase/options.rb', line 1163

def analytics_threshold
  @analytics_threshold
end

#authenticator ⇒ PasswordAuthenticator, CertificateAuthenticator

Returns:


1150
1151
1152
 
# File 'lib/couchbase/options.rb', line 1150

def authenticator
  @authenticator
end

#enable_metrics ⇒ Boolean

Returns:

  • (Boolean) 

1152
1153
1154
 
# File 'lib/couchbase/options.rb', line 1152

def enable_metrics
  @enable_metrics
end

#enable_tracing ⇒ Boolean

Returns:

  • (Boolean) 

1154
1155
1156
 
# File 'lib/couchbase/options.rb', line 1154

def enable_tracing
  @enable_tracing
end

#key_value_threshold ⇒ nil, ...

Returns:

  • (nil, Integer, #in_milliseconds) 

1159
1160
1161
 
# File 'lib/couchbase/options.rb', line 1159

def key_value_threshold
  @key_value_threshold
end

#management_threshold ⇒ nil, ...

Returns:

  • (nil, Integer, #in_milliseconds) 

1164
1165
1166
 
# File 'lib/couchbase/options.rb', line 1164

def management_threshold
  @management_threshold
end

#metrics_emit_interval ⇒ nil, ...

Returns:

  • (nil, Integer, #in_milliseconds) 

1153
1154
1155
 
# File 'lib/couchbase/options.rb', line 1153

def metrics_emit_interval
  @metrics_emit_interval
end

#orphaned_emit_interval ⇒ nil, ...

Returns:

  • (nil, Integer, #in_milliseconds) 

1155
1156
1157
 
# File 'lib/couchbase/options.rb', line 1155

def orphaned_emit_interval
  @orphaned_emit_interval
end

#orphaned_sample_size ⇒ nil, Integer

Returns:

  • (nil, Integer) 

1156
1157
1158
 
# File 'lib/couchbase/options.rb', line 1156

def orphaned_sample_size
  @orphaned_sample_size
end

#query_threshold ⇒ nil, ...

Returns:

  • (nil, Integer, #in_milliseconds) 

1160
1161
1162
 
# File 'lib/couchbase/options.rb', line 1160

def query_threshold
  @query_threshold
end

#search_threshold ⇒ nil, ...

Returns:

  • (nil, Integer, #in_milliseconds) 

1162
1163
1164
 
# File 'lib/couchbase/options.rb', line 1162

def search_threshold
  @search_threshold
end

#threshold_emit_interval ⇒ nil, ...

Returns:

  • (nil, Integer, #in_milliseconds) 

1157
1158
1159
 
# File 'lib/couchbase/options.rb', line 1157

def threshold_emit_interval
  @threshold_emit_interval
end

#threshold_sample_size ⇒ nil, Integer

Returns:

  • (nil, Integer) 

1158
1159
1160
 
# File 'lib/couchbase/options.rb', line 1158

def threshold_sample_size
  @threshold_sample_size
end

#view_threshold ⇒ nil, ...

Returns:

  • (nil, Integer, #in_milliseconds) 

1161
1162
1163
 
# File 'lib/couchbase/options.rb', line 1161

def view_threshold
  @view_threshold
end

Instance Method Details

#authenticate(username, password) ⇒ Object

Parameters:

  • username (String)
  • password (String)
[View source]

1204
1205
1206
 
# File 'lib/couchbase/options.rb', line 1204

def authenticate(username, password)
  @authenticator = PasswordAuthenticator.new(username, password)
end