drop_index_analytics_options Class Reference

#include <couchbase/drop_index_analytics_options.hxx>

Inheritance diagram for drop_index_analytics_options:

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

Public Member Functions
auto	ignore_if_not_exists (bool ignore_if_not_exists) -> drop_index_analytics_options &
	Ignore error if the index does not exist.
auto	dataverse_name (std::string dataverse_name) -> drop_index_analytics_options &
	The name of the dataverse the index should be dropped from.
auto	build () const -> built
	Validates options and returns them as an immutable value.
Public Member Functions inherited from common_options< drop_index_analytics_options >
auto	timeout (const std::chrono::milliseconds timeout) -> drop_index_analytics_options &
	Specifies a custom per-operation timeout.
auto	retry_strategy (const std::shared_ptr< retry_strategy > strategy) -> drop_index_analytics_options &
	Specifies a custom couchbase::retry_strategy for this operation.
auto	parent_span (std::shared_ptr< tracing::request_span > span) -> drop_index_analytics_options &

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

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

dataverse_name()

auto dataverse_name ( std::string dataverse_name ) -> drop_index_analytics_options&

inline

The name of the dataverse the index should be dropped from.

Parameters

dataverse_name

Returns

reference to this object, for use in chaining

Since

1.0.0

Committed

Generally available API and should be preferred in production

ignore_if_not_exists()

auto ignore_if_not_exists ( bool ignore_if_not_exists ) -> drop_index_analytics_options&

inline

Ignore error if the index does not exist.

defaults to false

Parameters

ignore_if_not_exists

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 class was generated from the following file:

• couchbase/drop_index_analytics_options.hxx