mongocxx::v1::indexes::create_one_options Class Reference

#include <mongocxx/v1/indexes.hpp>

Description

Options for mongocxx::v1::indexes::create_one.

Supported fields include:

• comment
• commit_quorum ("commitQuorum")
• max_time ("maxTimeMS")
• write_concern ("writeConcern")

Public Member Functions
	create_one_options ()
	Default initialization.
	create_one_options (create_one_options &&other) noexcept
	Move constructor.
	create_one_options (create_one_options const &other)
	Copy construction.
	~create_one_options ()
	Destroy this object.
bsoncxx::v1::stdx::optional< bsoncxx::v1::types::view >	comment () const
	Return the current "comment" field.
create_one_options &	comment (bsoncxx::v1::types::value v)
	Set the "comment" field.
bsoncxx::v1::stdx::optional< bsoncxx::v1::document::view >	commit_quorum () const
	Return the current "commitQuorum" field.
create_one_options &	commit_quorum (bsoncxx::v1::document::value v)
	Set the "commitQuorum" field.
bsoncxx::v1::stdx::optional< std::chrono::milliseconds >	max_time () const
	Return the current "maxTimeMS" field.
create_one_options &	max_time (std::chrono::milliseconds v)
	Set the "maxTimeMS" field.
create_one_options &	operator= (create_one_options &&other) noexcept
	Move assignment.
create_one_options &	operator= (create_one_options const &other)
	Copy assignment.
bsoncxx::v1::stdx::optional< v1::write_concern >	write_concern () const
	Return the current "writeConcern" field.
create_one_options &	write_concern (v1::write_concern v)
	Set the "writeConcern" field.

Constructor & Destructor Documentation

~create_one_options()

mongocxx::v1::indexes::create_one_options::~create_one_options

(

)

Destroy this object.

Warning

Invalidates all associated views.

create_one_options() [1/3]

mongocxx::v1::indexes::create_one_options::create_one_options ( create_one_options && other )

noexcept

Move constructor.

Postconditions:

• other is in an assign-or-destroy-only state.

create_one_options() [2/3]

mongocxx::v1::indexes::create_one_options::create_one_options

(

create_one_options const &

other

)

Copy construction.

create_one_options() [3/3]

mongocxx::v1::indexes::create_one_options::create_one_options

(

)

Default initialization.

Postconditions:

• All supported fields are "unset" or zero-initialized.

Member Function Documentation

comment() [1/2]

bsoncxx::v1::stdx::optional< bsoncxx::v1::types::view > mongocxx::v1::indexes::create_one_options::comment

(

)

const

Return the current "comment" field.

comment() [2/2]

create_one_options & mongocxx::v1::indexes::create_one_options::comment

(

bsoncxx::v1::types::value

v

)

Set the "comment" field.

commit_quorum() [1/2]

bsoncxx::v1::stdx::optional< bsoncxx::v1::document::view > mongocxx::v1::indexes::create_one_options::commit_quorum

(

)

const

Return the current "commitQuorum" field.

commit_quorum() [2/2]

create_one_options & mongocxx::v1::indexes::create_one_options::commit_quorum

(

bsoncxx::v1::document::value

v

)

Set the "commitQuorum" field.

max_time() [1/2]

bsoncxx::v1::stdx::optional< std::chrono::milliseconds > mongocxx::v1::indexes::create_one_options::max_time

(

)

const

Return the current "maxTimeMS" field.

max_time() [2/2]

create_one_options & mongocxx::v1::indexes::create_one_options::max_time

(

std::chrono::milliseconds

v

)

Set the "maxTimeMS" field.

operator=() [1/2]

create_one_options & mongocxx::v1::indexes::create_one_options::operator= ( create_one_options && other )

noexcept

Move assignment.

Postconditions:

• other is in an assign-or-destroy-only state.

operator=() [2/2]

create_one_options & mongocxx::v1::indexes::create_one_options::operator=

(

create_one_options const &

other

)

Copy assignment.

write_concern() [1/2]

bsoncxx::v1::stdx::optional< v1::write_concern > mongocxx::v1::indexes::create_one_options::write_concern

(

)

const

Return the current "writeConcern" field.

write_concern() [2/2]

create_one_options & mongocxx::v1::indexes::create_one_options::write_concern

(

v1::write_concern

v

)

Set the "writeConcern" field.

---

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

• mongocxx/v1/indexes.hpp