get_all_replicas_options Struct Reference

Options for collection::get_all_replicas(). More...

#include <couchbase/get_all_replicas_options.hxx>

Inheritance diagram for get_all_replicas_options:

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

Public Member Functions
auto	read_preference (read_preference preference) -> get_all_replicas_options &
	Choose how the replica nodes will be selected.
auto	build () const -> built
	Validates options and returns them as an immutable value.
Public Member Functions inherited from common_options< get_all_replicas_options >
auto	timeout (const std::chrono::milliseconds timeout) -> get_all_replicas_options &
	Specifies a custom per-operation timeout.
auto	retry_strategy (const std::shared_ptr< retry_strategy > strategy) -> get_all_replicas_options &
	Specifies a custom couchbase::retry_strategy for this operation.

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

Detailed Description

Options for collection::get_all_replicas().

Since

1.0.0

Committed

Generally available API and should be preferred in production

Member Function Documentation

build()

auto build ( ) const -> built

inlinenodiscard

Validates 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

read_preference()

auto read_preference ( read_preference preference ) -> get_all_replicas_options&

inline

Choose how the replica nodes will be selected.

By default it has no preference and will select all replicas available. But it is possible to prioritize or restrict to only nodes in local server group.

Parameters

preference

Returns

this options builder for chaining purposes.

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/get_all_replicas_options.hxx