diagnostics_options Struct Reference

#include <couchbase/diagnostics_options.hxx>

Inheritance diagram for diagnostics_options:

Classes
struct	built
	Immutable value object representing consistent options. More...

Public Member Functions
auto	report_id (std::string report_id) -> diagnostics_options &
	Sets a custom report ID that will be used in the report.
auto	build () const -> built
	Validates the options and returns them as an immutable value.
Public Member Functions inherited from common_options< diagnostics_options >
auto	timeout (const std::chrono::milliseconds timeout) -> diagnostics_options &
	Specifies a custom per-operation timeout.
auto	retry_strategy (const std::shared_ptr< retry_strategy > strategy) -> diagnostics_options &
	Specifies a custom couchbase::retry_strategy for this operation.

Additional Inherited Members
Protected Member Functions inherited from common_options< diagnostics_options >
auto	build_common_options () const -> built
auto	self () -> diagnostics_options &
	Allows to return the right options builder instance for child implementations.

Member Function Documentation

build()

auto build ( ) const -> built

inlinenodiscard

Validates the options and returns them as an immutable value.

Returns

consistent options as an immutable value

Exceptions

std::system_error

with code errc::common::invalid_argument if the options are not valid

Since

1.0.0

Internal

Internal interface

report_id()

auto report_id ( std::string report_id ) -> diagnostics_options&

inline

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

report_id

the report ID that should be used.

Returns

reference to this object, for use in chaining.

Since

1.0.0

Committed

Generally available API and should be preferred in production

---

The documentation for this struct was generated from the following file:

• couchbase/diagnostics_options.hxx