pinecone::net::connection_args Struct Reference

Arguments required to connect to a Pinecone server. More...

#include <arguments.hpp>

Public Member Functions
	connection_args (std::string environment, std::string api_key) noexcept
	Construct a new connection args object. More...
auto	environment () const noexcept -> std::string const &
auto	api_key () const noexcept -> std::string const &
auto	api_key_header () const noexcept -> char const *

Detailed Description

Arguments required to connect to a Pinecone server.

Definition at line 25 of file arguments.hpp.

Constructor & Destructor Documentation

connection_args()

pinecone::net::connection_args::connection_args ( std::string  environment, std::string  api_key  )

inlinenoexcept

Construct a new connection args object.

Parameters

environment	the cloud environment for the connection (e.g., us-west1-gcp)
api_key	a Pinecone API key

Definition at line 32 of file arguments.hpp.

Member Function Documentation

api_key_header()

auto pinecone::net::connection_args::api_key_header ( ) const -> char const*

inlinenoexcept

Returns

a CURL compatible header

Definition at line 46 of file arguments.hpp.

---

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

• include/pinecone/net/arguments.hpp