InfluxDB2\Configuration Class Reference

Public Member Functions
	__construct ()
	setApiKey ($apiKeyIdentifier, $key)
	getApiKey ($apiKeyIdentifier)
	setApiKeyPrefix ($apiKeyIdentifier, $prefix)
	getApiKeyPrefix ($apiKeyIdentifier)
	setAccessToken ($accessToken)
	getAccessToken ()
	setUsername ($username)
	getUsername ()
	setPassword ($password)
	getPassword ()
	setHost ($host)
	getHost ()
	setUserAgent ($userAgent)
	getUserAgent ()
	setDebug ($debug)
	getDebug ()
	setDebugFile ($debugFile)
	getDebugFile ()
	setTempFolderPath ($tempFolderPath)
	getTempFolderPath ()
	getApiKeyWithPrefix ($apiKeyIdentifier)

Static Public Member Functions
static	getDefaultConfiguration ()
static	setDefaultConfiguration (Configuration $config)
static	toDebugReport ()

Protected Attributes
	$apiKeys = []
	$apiKeyPrefixes = []
	$accessToken = ''
	$username = ''
	$password = ''
	$host = 'http://localhost/api/v2'
	$userAgent = 'OpenAPI-Generator/1.0.0/PHP'
	$debug = false
	$debugFile = 'php://output'
	$tempFolderPath

Constructor & Destructor Documentation

__construct()

InfluxDB2\Configuration::__construct

(

)

Constructor

Member Function Documentation

getAccessToken()

InfluxDB2\Configuration::getAccessToken

(

)

Gets the access token for OAuth

Returns

string Access token for OAuth

getApiKey()

InfluxDB2\Configuration::getApiKey

(

$apiKeyIdentifier

)

Gets API key

Parameters

string

$apiKeyIdentifier

API key identifier (authentication scheme)

Returns

string API key or token

getApiKeyPrefix()

InfluxDB2\Configuration::getApiKeyPrefix

(

$apiKeyIdentifier

)

Gets API key prefix

Parameters

string

$apiKeyIdentifier

API key identifier (authentication scheme)

Returns

string

getApiKeyWithPrefix()

InfluxDB2\Configuration::getApiKeyWithPrefix

(

$apiKeyIdentifier

)

Get API key (with prefix if set)

Parameters

string

$apiKeyIdentifier

name of apikey

Returns

string API key with the prefix

getDebug()

InfluxDB2\Configuration::getDebug

(

)

Gets the debug flag

Returns

bool

getDebugFile()

InfluxDB2\Configuration::getDebugFile

(

)

Gets the debug file

Returns

string

getDefaultConfiguration()

static InfluxDB2\Configuration::getDefaultConfiguration ( )

static

Gets the default configuration instance

Returns

Configuration

getHost()

InfluxDB2\Configuration::getHost

(

)

Gets the host

Returns

string Host

getPassword()

InfluxDB2\Configuration::getPassword

(

)

Gets the password for HTTP basic authentication

Returns

string Password for HTTP basic authentication

getTempFolderPath()

InfluxDB2\Configuration::getTempFolderPath

(

)

Gets the temp folder path

Returns

string Temp folder path

getUserAgent()

InfluxDB2\Configuration::getUserAgent

(

)

Gets the user agent of the api client

Returns

string user agent

getUsername()

InfluxDB2\Configuration::getUsername

(

)

Gets the username for HTTP basic authentication

Returns

string Username for HTTP basic authentication

setAccessToken()

InfluxDB2\Configuration::setAccessToken

(

$accessToken

)

Sets the access token for OAuth

Parameters

string

$accessToken

Token for OAuth

Returns

$this

setApiKey()

InfluxDB2\Configuration::setApiKey	(		$apiKeyIdentifier,
			$key )

Sets API key

Parameters

string	$apiKeyIdentifier	API key identifier (authentication scheme)
string	$key	API key or token

Returns

$this

setApiKeyPrefix()

InfluxDB2\Configuration::setApiKeyPrefix	(		$apiKeyIdentifier,
			$prefix )

Sets the prefix for API key (e.g. Bearer)

Parameters

string	$apiKeyIdentifier	API key identifier (authentication scheme)
string	$prefix	API key prefix, e.g. Bearer

Returns

$this

setDebug()

InfluxDB2\Configuration::setDebug

(

$debug

)

Sets debug flag

Parameters

bool

$debug

Debug flag

Returns

$this

setDebugFile()

InfluxDB2\Configuration::setDebugFile

(

$debugFile

)

Sets the debug file

Parameters

string

$debugFile

Debug file

Returns

$this

setDefaultConfiguration()

static InfluxDB2\Configuration::setDefaultConfiguration ( Configuration $config )

static

Sets the detault configuration instance

Parameters

Configuration

$config

An instance of the Configuration Object

Returns

void

setHost()

InfluxDB2\Configuration::setHost

(

$host

)

Sets the host

Parameters

string

$host

Host

Returns

$this

setPassword()

InfluxDB2\Configuration::setPassword

(

$password

)

Sets the password for HTTP basic authentication

Parameters

string

$password

Password for HTTP basic authentication

Returns

$this

setTempFolderPath()

InfluxDB2\Configuration::setTempFolderPath

(

$tempFolderPath

)

Sets the temp folder path

Parameters

string

$tempFolderPath

Temp folder path

Returns

$this

setUserAgent()

InfluxDB2\Configuration::setUserAgent

(

$userAgent

)

Sets the user agent of the api client

Parameters

string

$userAgent

the user agent of the api client

Exceptions

InvalidArgumentException

Returns

$this

setUsername()

InfluxDB2\Configuration::setUsername

(

$username

)

Sets the username for HTTP basic authentication

Parameters

string

$username

Username for HTTP basic authentication

Returns

$this

toDebugReport()

static InfluxDB2\Configuration::toDebugReport ( )

static

Gets the essential information for debugging

Returns

string The report for debugging

---

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

• src/InfluxDB2/Configuration.php