search_options::built Struct Reference

Immutable value object representing consistent options. More...

#include <couchbase/search_options.hxx>

Inheritance diagram for search_options::built:

Public Attributes
std::optional< std::string >	client_context_id {}
bool	include_locations { false }
bool	disable_scoring { false }
std::optional< bool >	explain {}
std::optional< std::uint32_t >	limit {}
std::optional< std::uint32_t >	skip {}
std::vector< std::string >	collections {}
std::vector< std::string >	fields {}
std::vector< std::string >	highlight_fields {}
std::optional< couchbase::highlight_style >	highlight_style {}
std::optional< search_scan_consistency >	scan_consistency {}
std::vector< mutation_token >	mutation_state {}
std::map< std::string, codec::binary, std::less<> >	raw {}
std::map< std::string, std::shared_ptr< search_facet >, std::less<> >	facets {}
std::vector< std::shared_ptr< search_sort > >	sort {}
std::vector< std::string >	sort_string {}
Public Attributes inherited from common_options< derived_class >::built
const std::optional< std::chrono::milliseconds >	timeout
const std::shared_ptr< couchbase::retry_strategy >	retry_strategy
const std::shared_ptr< tracing::request_span >	parent_span

Detailed Description

Immutable value object representing consistent options.

Since

1.0.0

Internal

Internal interface

Member Data Documentation

client_context_id

std::optional<std::string> client_context_id {}

collections

std::vector<std::string> collections {}

disable_scoring

bool disable_scoring { false }

explain

std::optional<bool> explain {}

facets

std::map<std::string, std::shared_ptr<search_facet>, std::less<> > facets {}

fields

std::vector<std::string> fields {}

highlight_fields

std::vector<std::string> highlight_fields {}

highlight_style

std::optional<couchbase::highlight_style> highlight_style {}

include_locations

bool include_locations { false }

limit

std::optional<std::uint32_t> limit {}

mutation_state

std::vector<mutation_token> mutation_state {}

raw

std::map<std::string, codec::binary, std::less<> > raw {}

scan_consistency

std::optional<search_scan_consistency> scan_consistency {}

skip

std::optional<std::uint32_t> skip {}

sort

std::vector<std::shared_ptr<search_sort> > sort {}

sort_string

std::vector<std::string> sort_string {}

---

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

• couchbase/search_options.hxx