InfluxDB2\InvokableScriptsApi Class Reference

Inheritance diagram for InfluxDB2\InvokableScriptsApi:

Public Member Functions
	__construct (array $options, InvokableScriptsService $service)
	createScript (ScriptCreateRequest $createRequest)
	updateScript (string $scriptId, ScriptUpdateRequest $updateRequest)
	deleteScript (string $scriptId)
	findScripts (?int $limit=null, ?int $offset=null)
	invokeScript (string $scriptId, ?array $params=null)
	invokeScriptStream (string $scriptId, ?array $params=null)
	invokeScriptRaw (string $scriptId, ?array $params=null)
Public Member Functions inherited from InfluxDB2\DefaultApi
	__construct (array $options)
	post ($payload, $uriPath, $queryParams)
	get ($payload, $uriPath, $queryParams)
	configuredClient (ClientInterface $client)
	createRequest (string $method, string $uriPath, string $payload, array $headers, array $queryParams)
	sendRequest (RequestInterface $request)

Additional Inherited Members
Static Public Member Functions inherited from InfluxDB2\DefaultApi
static	log (string $level, string $message, array $options)
Public Attributes inherited from InfluxDB2\DefaultApi
	$options
	$http
Protected Member Functions inherited from InfluxDB2\DefaultApi
	check ($key, $value)

Constructor & Destructor Documentation

__construct()

InfluxDB2\InvokableScriptsApi::__construct	(	array	$options,
		InvokableScriptsService	$service )

InvokableScriptsApi constructor.

Parameters

array	$options	default array options
InvokableScriptsService	$service	HTTP API for Invokable Scripts

Member Function Documentation

createScript()

InfluxDB2\InvokableScriptsApi::createScript

(

ScriptCreateRequest

$createRequest

)

Create a script.

Parameters

ScriptCreateRequest

$createRequest

The script to create.

Returns

Script The created script.

deleteScript()

InfluxDB2\InvokableScriptsApi::deleteScript

(

string

$scriptId

)

Delete a script.

Parameters

string

$scriptId

The ID of the script to delete. (required)

Returns

void

findScripts()

InfluxDB2\InvokableScriptsApi::findScripts	(	?int	$limit = null,
		?int	$offset = null )

List scripts.

Parameters

int | null	$limit	The number of scripts to return.
int | null	$offset	The offset for pagination.

Returns

Script[]

invokeScript()

InfluxDB2\InvokableScriptsApi::invokeScript	(	string	$scriptId,
		?array	$params = null )

Invoke synchronously a script and return result as a FluxTable[].

Parameters

string	$scriptId	The ID of the script to invoke. (required)
	array<string,object>|null	$params Represent key/value pairs parameters to be injected into script

Returns

FluxTable[]

invokeScriptRaw()

InfluxDB2\InvokableScriptsApi::invokeScriptRaw	(	string	$scriptId,
		?array	$params = null )

Invoke synchronously a script and return result as a String.

Parameters

string	$scriptId	The ID of the script to invoke. (required)
array | null	$params	Represent key/value pairs parameters to be injected into script

Returns

string

invokeScriptStream()

InfluxDB2\InvokableScriptsApi::invokeScriptStream	(	string	$scriptId,
		?array	$params = null )

Invoke synchronously a script and return result as a stream of FluxRecord.

Parameters

string	$scriptId	The ID of the script to invoke. (required)
	array<string,object>|null	$params Represent key/value pairs parameters to be injected into script

Returns

FluxCsvParser generator of FluxRecords

updateScript()

InfluxDB2\InvokableScriptsApi::updateScript	(	string	$scriptId,
		ScriptUpdateRequest	$updateRequest )

Update a script.

Parameters

string	$scriptId	The ID of the script to update. (required)
ScriptUpdateRequest	$updateRequest	Script updates to apply (required)

Returns

Script The updated script.

---

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

• src/InfluxDB2/InvokableScriptsApi.php