com.couchbase.client.java.diagnostics

Class DiagnosticsOptions

java.lang.Object

com.couchbase.client.java.diagnostics.DiagnosticsOptions

public class DiagnosticsOptions
extends Object

Allows to customize the diagnostics report.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
class	DiagnosticsOptions.Built

Method Summary

Modifier and Type	Method and Description
DiagnosticsOptions.Built	build()
static DiagnosticsOptions	diagnosticsOptions() Creates a new set of DiagnosticsOptions.
DiagnosticsOptions	reportId(String reportId) Sets a custom report ID that will be used in the report.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Method Detail

diagnosticsOptions

public static DiagnosticsOptions diagnosticsOptions()

Creates a new set of DiagnosticsOptions.

Returns:

options to customize.

reportId

public DiagnosticsOptions reportId(String reportId)

Sets a custom report ID that will be used in the report.

If no report ID is provided, the client will generate a unique one.

Parameters:

reportId - the report ID that should be used for this report.

Returns:

the DiagnosticsOptions to allow method chaining.

build

@Stability.Internal
public DiagnosticsOptions.Built build()