InfluxDB PHP Client
Loading...
Searching...
No Matches
Public Member Functions | Protected Member Functions | Protected Attributes | List of all members
InfluxDB2\Service\InvokableScriptsService Class Reference

Public Member Functions

 __construct (DefaultApi $defaultApi)
 
 deleteScriptsID ($script_id)
 
 deleteScriptsIDWithHttpInfo ($script_id)
 
 getScripts ($limit=100, $offset=0, $name=null, $label_names=null, $label_contains=null)
 
 getScriptsWithHttpInfo ($limit=100, $offset=0, $name=null, $label_names=null, $label_contains=null)
 
 getScriptsID ($script_id)
 
 getScriptsIDWithHttpInfo ($script_id)
 
 patchScriptsID ($script_id, $script_update_request)
 
 patchScriptsIDWithHttpInfo ($script_id, $script_update_request)
 
 patchScriptsIDAddLabels ($script_id, $label_mapping)
 
 patchScriptsIDAddLabelsWithHttpInfo ($script_id, $label_mapping)
 
 patchScriptsIDRemoveLabels ($script_id, $label_mapping)
 
 patchScriptsIDRemoveLabelsWithHttpInfo ($script_id, $label_mapping)
 
 postScripts ($script_create_request)
 
 postScriptsWithHttpInfo ($script_create_request)
 
 postScriptsIDInvoke ($script_id, $script_invocation_params=null)
 
 postScriptsIDInvokeWithHttpInfo ($script_id, $script_invocation_params=null)
 

Protected Member Functions

 deleteScriptsIDRequest ($script_id)
 
 getScriptsRequest ($limit=100, $offset=0, $name=null, $label_names=null, $label_contains=null)
 
 getScriptsIDRequest ($script_id)
 
 patchScriptsIDRequest ($script_id, $script_update_request)
 
 patchScriptsIDAddLabelsRequest ($script_id, $label_mapping)
 
 patchScriptsIDRemoveLabelsRequest ($script_id, $label_mapping)
 
 postScriptsRequest ($script_create_request)
 
 postScriptsIDInvokeRequest ($script_id, $script_invocation_params=null)
 

Protected Attributes

 $defaultApi
 
 $headerSelector
 

Constructor & Destructor Documentation

◆ __construct()

InfluxDB2\Service\InvokableScriptsService::__construct ( DefaultApi $defaultApi)
Parameters
DefaultApi$defaultApi
HeaderSelector$selector

Member Function Documentation

◆ deleteScriptsID()

InfluxDB2\Service\InvokableScriptsService::deleteScriptsID ( $script_id)

Operation deleteScriptsID

Delete a script

Parameters
string$script_idThe ID of the script to delete. (required)
Exceptions

InfluxDB2\ApiException on non-2xx response

Exceptions

InvalidArgumentException

Returns
void

◆ deleteScriptsIDRequest()

InfluxDB2\Service\InvokableScriptsService::deleteScriptsIDRequest ( $script_id)
protected

Create request for operation 'deleteScriptsID'

Parameters
string$script_idThe ID of the script to delete. (required)
Exceptions

InvalidArgumentException

Returns
\Psr\Http\Message\RequestInterface

◆ deleteScriptsIDWithHttpInfo()

InfluxDB2\Service\InvokableScriptsService::deleteScriptsIDWithHttpInfo ( $script_id)

Operation deleteScriptsIDWithHttpInfo

Delete a script

Parameters
string$script_idThe ID of the script to delete. (required)
Exceptions

InfluxDB2\ApiException on non-2xx response

Exceptions

InvalidArgumentException

Returns
array of null, HTTP status code, HTTP response headers (array of strings)

◆ getScripts()

InfluxDB2\Service\InvokableScriptsService::getScripts ( $limit = 100,
$offset = 0,
$name = null,
$label_names = null,
$label_contains = null )

Operation getScripts

List scripts

Parameters
int$limitLimits the number of scripts returned. Default is `100`. (optional, default to 100)
int$offsetThe offset for pagination. The number of records to skip. (optional, default to 0)
string$nameThe name of the script. (optional)
string[]$label_namesA list of label names. Only returns scripts that have all these labels. To retrieve a script, each name you pass in `labelNames` must exactly match the label for a script. (optional)
string$label_containsA part of the label name. Returns scripts that have a label that contains this phrase. (optional)
Exceptions

InfluxDB2\ApiException on non-2xx response

Exceptions

InvalidArgumentException

Returns
\InfluxDB2\Model\Scripts|\InfluxDB2\Model\Error|object|\InfluxDB2\Model\Error|\InfluxDB2\Model\Error

◆ getScriptsID()

InfluxDB2\Service\InvokableScriptsService::getScriptsID ( $script_id)

Operation getScriptsID

Retrieve a script

Parameters
string$script_idThe script ID. (required)
Exceptions

InfluxDB2\ApiException on non-2xx response

Exceptions

InvalidArgumentException

Returns
\InfluxDB2\Model\Script

◆ getScriptsIDRequest()

InfluxDB2\Service\InvokableScriptsService::getScriptsIDRequest ( $script_id)
protected

Create request for operation 'getScriptsID'

Parameters
string$script_idThe script ID. (required)
Exceptions

InvalidArgumentException

Returns
\Psr\Http\Message\RequestInterface

◆ getScriptsIDWithHttpInfo()

InfluxDB2\Service\InvokableScriptsService::getScriptsIDWithHttpInfo ( $script_id)

Operation getScriptsIDWithHttpInfo

Retrieve a script

Parameters
string$script_idThe script ID. (required)
Exceptions

InfluxDB2\ApiException on non-2xx response

Exceptions

InvalidArgumentException

Returns
array of \InfluxDB2\Model\Script, HTTP status code, HTTP response headers (array of strings)

◆ getScriptsRequest()

InfluxDB2\Service\InvokableScriptsService::getScriptsRequest ( $limit = 100,
$offset = 0,
$name = null,
$label_names = null,
$label_contains = null )
protected

Create request for operation 'getScripts'

Parameters
int$limitLimits the number of scripts returned. Default is `100`. (optional, default to 100)
int$offsetThe offset for pagination. The number of records to skip. (optional, default to 0)
string$nameThe name of the script. (optional)
string[]$label_namesA list of label names. Only returns scripts that have all these labels. To retrieve a script, each name you pass in `labelNames` must exactly match the label for a script. (optional)
string$label_containsA part of the label name. Returns scripts that have a label that contains this phrase. (optional)
Exceptions

InvalidArgumentException

Returns
\Psr\Http\Message\RequestInterface

◆ getScriptsWithHttpInfo()

InfluxDB2\Service\InvokableScriptsService::getScriptsWithHttpInfo ( $limit = 100,
$offset = 0,
$name = null,
$label_names = null,
$label_contains = null )

Operation getScriptsWithHttpInfo

List scripts

Parameters
int$limitLimits the number of scripts returned. Default is `100`. (optional, default to 100)
int$offsetThe offset for pagination. The number of records to skip. (optional, default to 0)
string$nameThe name of the script. (optional)
string[]$label_namesA list of label names. Only returns scripts that have all these labels. To retrieve a script, each name you pass in `labelNames` must exactly match the label for a script. (optional)
string$label_containsA part of the label name. Returns scripts that have a label that contains this phrase. (optional)
Exceptions

InfluxDB2\ApiException on non-2xx response

Exceptions

InvalidArgumentException

Returns
array of \InfluxDB2\Model\Scripts|\InfluxDB2\Model\Error|object|\InfluxDB2\Model\Error|\InfluxDB2\Model\Error, HTTP status code, HTTP response headers (array of strings)

◆ patchScriptsID()

InfluxDB2\Service\InvokableScriptsService::patchScriptsID ( $script_id,
$script_update_request )

Operation patchScriptsID

Update a script

Parameters
string$script_idThe script ID. (required)
\InfluxDB2\Model\ScriptUpdateRequest$script_update_requestScript update to apply (required)
Exceptions

InfluxDB2\ApiException on non-2xx response

Exceptions

InvalidArgumentException

Returns
\InfluxDB2\Model\Script

◆ patchScriptsIDAddLabels()

InfluxDB2\Service\InvokableScriptsService::patchScriptsIDAddLabels ( $script_id,
$label_mapping )

Operation patchScriptsIDAddLabels

Adds labels to a script

Parameters
string$script_idThe script ID. (required)
\InfluxDB2\Model\LabelMapping$label_mappingThe names of labels to add to the script. (required)
Exceptions

InfluxDB2\ApiException on non-2xx response

Exceptions

InvalidArgumentException

Returns
\InfluxDB2\Model\Script|object|\InfluxDB2\Model\Error

◆ patchScriptsIDAddLabelsRequest()

InfluxDB2\Service\InvokableScriptsService::patchScriptsIDAddLabelsRequest ( $script_id,
$label_mapping )
protected

Create request for operation 'patchScriptsIDAddLabels'

Parameters
string$script_idThe script ID. (required)
\InfluxDB2\Model\LabelMapping$label_mappingThe names of labels to add to the script. (required)
Exceptions

InvalidArgumentException

Returns
\Psr\Http\Message\RequestInterface

◆ patchScriptsIDAddLabelsWithHttpInfo()

InfluxDB2\Service\InvokableScriptsService::patchScriptsIDAddLabelsWithHttpInfo ( $script_id,
$label_mapping )

Operation patchScriptsIDAddLabelsWithHttpInfo

Adds labels to a script

Parameters
string$script_idThe script ID. (required)
\InfluxDB2\Model\LabelMapping$label_mappingThe names of labels to add to the script. (required)
Exceptions

InfluxDB2\ApiException on non-2xx response

Exceptions

InvalidArgumentException

Returns
array of \InfluxDB2\Model\Script|object|\InfluxDB2\Model\Error, HTTP status code, HTTP response headers (array of strings)

◆ patchScriptsIDRemoveLabels()

InfluxDB2\Service\InvokableScriptsService::patchScriptsIDRemoveLabels ( $script_id,
$label_mapping )

Operation patchScriptsIDRemoveLabels

Removes labels from a script

Parameters
string$script_idThe script ID. (required)
\InfluxDB2\Model\LabelMapping$label_mappingThe names of labels to remove from the script. (required)
Exceptions

InfluxDB2\ApiException on non-2xx response

Exceptions

InvalidArgumentException

Returns
\InfluxDB2\Model\Script|object|\InfluxDB2\Model\Error

◆ patchScriptsIDRemoveLabelsRequest()

InfluxDB2\Service\InvokableScriptsService::patchScriptsIDRemoveLabelsRequest ( $script_id,
$label_mapping )
protected

Create request for operation 'patchScriptsIDRemoveLabels'

Parameters
string$script_idThe script ID. (required)
\InfluxDB2\Model\LabelMapping$label_mappingThe names of labels to remove from the script. (required)
Exceptions

InvalidArgumentException

Returns
\Psr\Http\Message\RequestInterface

◆ patchScriptsIDRemoveLabelsWithHttpInfo()

InfluxDB2\Service\InvokableScriptsService::patchScriptsIDRemoveLabelsWithHttpInfo ( $script_id,
$label_mapping )

Operation patchScriptsIDRemoveLabelsWithHttpInfo

Removes labels from a script

Parameters
string$script_idThe script ID. (required)
\InfluxDB2\Model\LabelMapping$label_mappingThe names of labels to remove from the script. (required)
Exceptions

InfluxDB2\ApiException on non-2xx response

Exceptions

InvalidArgumentException

Returns
array of \InfluxDB2\Model\Script|object|\InfluxDB2\Model\Error, HTTP status code, HTTP response headers (array of strings)

◆ patchScriptsIDRequest()

InfluxDB2\Service\InvokableScriptsService::patchScriptsIDRequest ( $script_id,
$script_update_request )
protected

Create request for operation 'patchScriptsID'

Parameters
string$script_idThe script ID. (required)
\InfluxDB2\Model\ScriptUpdateRequest$script_update_requestScript update to apply (required)
Exceptions

InvalidArgumentException

Returns
\Psr\Http\Message\RequestInterface

◆ patchScriptsIDWithHttpInfo()

InfluxDB2\Service\InvokableScriptsService::patchScriptsIDWithHttpInfo ( $script_id,
$script_update_request )

Operation patchScriptsIDWithHttpInfo

Update a script

Parameters
string$script_idThe script ID. (required)
\InfluxDB2\Model\ScriptUpdateRequest$script_update_requestScript update to apply (required)
Exceptions

InfluxDB2\ApiException on non-2xx response

Exceptions

InvalidArgumentException

Returns
array of \InfluxDB2\Model\Script, HTTP status code, HTTP response headers (array of strings)

◆ postScripts()

InfluxDB2\Service\InvokableScriptsService::postScripts ( $script_create_request)

Operation postScripts

Create a script

Parameters
\InfluxDB2\Model\ScriptCreateRequest$script_create_requestThe script to create. (required)
Exceptions

InfluxDB2\ApiException on non-2xx response

Exceptions

InvalidArgumentException

Returns
\InfluxDB2\Model\Script|\InfluxDB2\Model\Error|object|\InfluxDB2\Model\Error|\InfluxDB2\Model\Error|\InfluxDB2\Model\Error

◆ postScriptsIDInvoke()

InfluxDB2\Service\InvokableScriptsService::postScriptsIDInvoke ( $script_id,
$script_invocation_params = null )

Operation postScriptsIDInvoke

Invoke a script

Parameters
string$script_idScript ID. Only returns scripts with this ID. (required)
\InfluxDB2\Model\ScriptInvocationParams$script_invocation_paramsscript_invocation_params (optional)
Exceptions

InfluxDB2\ApiException on non-2xx response

Exceptions

InvalidArgumentException

Returns
\SplFileObject|\InfluxDB2\Model\Error|object|\InfluxDB2\Model\Error|\InfluxDB2\Model\Error|\InfluxDB2\Model\Error

◆ postScriptsIDInvokeRequest()

InfluxDB2\Service\InvokableScriptsService::postScriptsIDInvokeRequest ( $script_id,
$script_invocation_params = null )
protected

Create request for operation 'postScriptsIDInvoke'

Parameters
string$script_idScript ID. Only returns scripts with this ID. (required)
\InfluxDB2\Model\ScriptInvocationParams$script_invocation_params(optional)
Exceptions

InvalidArgumentException

Returns
\Psr\Http\Message\RequestInterface

◆ postScriptsIDInvokeWithHttpInfo()

InfluxDB2\Service\InvokableScriptsService::postScriptsIDInvokeWithHttpInfo ( $script_id,
$script_invocation_params = null )

Operation postScriptsIDInvokeWithHttpInfo

Invoke a script

Parameters
string$script_idScript ID. Only returns scripts with this ID. (required)
\InfluxDB2\Model\ScriptInvocationParams$script_invocation_params(optional)
Exceptions

InfluxDB2\ApiException on non-2xx response

Exceptions

InvalidArgumentException

Returns
array of \SplFileObject|\InfluxDB2\Model\Error|object|\InfluxDB2\Model\Error|\InfluxDB2\Model\Error|\InfluxDB2\Model\Error, HTTP status code, HTTP response headers (array of strings)

◆ postScriptsRequest()

InfluxDB2\Service\InvokableScriptsService::postScriptsRequest ( $script_create_request)
protected

Create request for operation 'postScripts'

Parameters
\InfluxDB2\Model\ScriptCreateRequest$script_create_requestThe script to create. (required)
Exceptions

InvalidArgumentException

Returns
\Psr\Http\Message\RequestInterface

◆ postScriptsWithHttpInfo()

InfluxDB2\Service\InvokableScriptsService::postScriptsWithHttpInfo ( $script_create_request)

Operation postScriptsWithHttpInfo

Create a script

Parameters
\InfluxDB2\Model\ScriptCreateRequest$script_create_requestThe script to create. (required)
Exceptions

InfluxDB2\ApiException on non-2xx response

Exceptions

InvalidArgumentException

Returns
array of \InfluxDB2\Model\Script|\InfluxDB2\Model\Error|object|\InfluxDB2\Model\Error|\InfluxDB2\Model\Error|\InfluxDB2\Model\Error, HTTP status code, HTTP response headers (array of strings)
The documentation for this class was generated from the following file:
Generated by doxygen 1.10.0