get_links_analytics_options Class Reference

#include <couchbase/get_links_analytics_options.hxx>

Inheritance diagram for get_links_analytics_options:

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

Public Member Functions
auto	dataverse_name (std::string dataverse_name) -> get_links_analytics_options &
	The name of the dataverse to restrict returned links to.
auto	name (std::string name) -> get_links_analytics_options &
	The name of the link to fetch.
auto	link_type (management::analytics_link_type link_type) -> get_links_analytics_options &
	The type of links to restrict returned links to.
auto	build () const -> built
	Validates options and returns them as an immutable value.
Public Member Functions inherited from common_options< get_links_analytics_options >
auto	timeout (const std::chrono::milliseconds timeout) -> get_links_analytics_options &
	Specifies a custom per-operation timeout.
auto	retry_strategy (const std::shared_ptr< retry_strategy > strategy) -> get_links_analytics_options &
	Specifies a custom couchbase::retry_strategy for this operation.
auto	parent_span (std::shared_ptr< tracing::request_span > span) -> get_links_analytics_options &

Additional Inherited Members
Protected Member Functions inherited from common_options< get_links_analytics_options >
auto	build_common_options () const -> built
auto	self () -> get_links_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 ) -> get_links_analytics_options&

inline

The name of the dataverse to restrict returned links to.

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

link_type()

auto link_type ( management::analytics_link_type link_type ) -> get_links_analytics_options&

inline

The type of links to restrict returned links to.

Parameters

link_type

link type

Returns

reference to this object, for use in chaining

Since

1.0.0

Committed

Generally available API and should be preferred in production

name()

auto name ( std::string name ) -> get_links_analytics_options&

inline

The name of the link to fetch.

Parameters

name

link name

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