InfluxDB PHP Client
Public Member Functions | Protected Member Functions | Protected Attributes | List of all members
InfluxDB2\Service\InvokableScriptsService Class Reference

Public Member Functions

 __construct (ClientInterface $client=null, Configuration $config=null, HeaderSelector $selector=null)
 
 getConfig ()
 
 deleteScriptsID ($script_id)
 
 deleteScriptsIDWithHttpInfo ($script_id)
 
 deleteScriptsIDAsync ($script_id)
 
 deleteScriptsIDAsyncWithHttpInfo ($script_id)
 
 getScripts ($limit=null, $offset=null)
 
 getScriptsWithHttpInfo ($limit=null, $offset=null)
 
 getScriptsAsync ($limit=null, $offset=null)
 
 getScriptsAsyncWithHttpInfo ($limit=null, $offset=null)
 
 getScriptsID ($script_id)
 
 getScriptsIDWithHttpInfo ($script_id)
 
 getScriptsIDAsync ($script_id)
 
 getScriptsIDAsyncWithHttpInfo ($script_id)
 
 patchScriptsID ($script_id, $script_update_request)
 
 patchScriptsIDWithHttpInfo ($script_id, $script_update_request)
 
 patchScriptsIDAsync ($script_id, $script_update_request)
 
 patchScriptsIDAsyncWithHttpInfo ($script_id, $script_update_request)
 
 postScripts ($script_create_request)
 
 postScriptsWithHttpInfo ($script_create_request)
 
 postScriptsAsync ($script_create_request)
 
 postScriptsAsyncWithHttpInfo ($script_create_request)
 
 postScriptsIDInvoke ($script_id, $script_invocation_params=null)
 
 postScriptsIDInvokeWithHttpInfo ($script_id, $script_invocation_params=null)
 
 postScriptsIDInvokeAsync ($script_id, $script_invocation_params=null)
 
 postScriptsIDInvokeAsyncWithHttpInfo ($script_id, $script_invocation_params=null)
 

Protected Member Functions

 deleteScriptsIDRequest ($script_id)
 
 getScriptsRequest ($limit=null, $offset=null)
 
 getScriptsIDRequest ($script_id)
 
 patchScriptsIDRequest ($script_id, $script_update_request)
 
 postScriptsRequest ($script_create_request)
 
 postScriptsIDInvokeRequest ($script_id, $script_invocation_params=null)
 
 createHttpClientOption ()
 

Protected Attributes

 $client
 
 $config
 
 $headerSelector
 

Constructor & Destructor Documentation

◆ __construct()

InfluxDB2\Service\InvokableScriptsService::__construct ( ClientInterface  $client = null,
Configuration  $config = null,
HeaderSelector  $selector = null 
)
Parameters
ClientInterface$client
Configuration$config
HeaderSelector$selector

Member Function Documentation

◆ createHttpClientOption()

InfluxDB2\Service\InvokableScriptsService::createHttpClientOption ( )
protected

Create http client option

Exceptions

RuntimeException on file opening failure

Returns
array of http client options

◆ 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

◆ deleteScriptsIDAsync()

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

Operation deleteScriptsIDAsync

Delete a script

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

InvalidArgumentException

Returns
\GuzzleHttp\Promise\PromiseInterface

◆ deleteScriptsIDAsyncWithHttpInfo()

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

Operation deleteScriptsIDAsyncWithHttpInfo

Delete a script

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

InvalidArgumentException

Returns
\GuzzleHttp\Promise\PromiseInterface

◆ 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
\GuzzleHttp\Psr7\Request

◆ 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)

◆ getConfig()

InfluxDB2\Service\InvokableScriptsService::getConfig ( )
Returns
Configuration

◆ getScripts()

InfluxDB2\Service\InvokableScriptsService::getScripts (   $limit = null,
  $offset = null 
)

Operation getScripts

List scripts

Parameters
int$limitThe number of scripts to return. (optional)
int$offsetThe offset for pagination. (optional)
Exceptions

InfluxDB2\ApiException on non-2xx response

Exceptions

InvalidArgumentException

Returns
\InfluxDB2\Model\Scripts|string

◆ getScriptsAsync()

InfluxDB2\Service\InvokableScriptsService::getScriptsAsync (   $limit = null,
  $offset = null 
)

Operation getScriptsAsync

List scripts

Parameters
int$limitThe number of scripts to return. (optional)
int$offsetThe offset for pagination. (optional)
Exceptions

InvalidArgumentException

Returns
\GuzzleHttp\Promise\PromiseInterface

◆ getScriptsAsyncWithHttpInfo()

InfluxDB2\Service\InvokableScriptsService::getScriptsAsyncWithHttpInfo (   $limit = null,
  $offset = null 
)

Operation getScriptsAsyncWithHttpInfo

List scripts

Parameters
int$limitThe number of scripts to return. (optional)
int$offsetThe offset for pagination. (optional)
Exceptions

InvalidArgumentException

Returns
\GuzzleHttp\Promise\PromiseInterface

◆ 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|string

◆ getScriptsIDAsync()

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

Operation getScriptsIDAsync

Retrieve a script

Parameters
string$script_idThe script ID. (required)
Exceptions

InvalidArgumentException

Returns
\GuzzleHttp\Promise\PromiseInterface

◆ getScriptsIDAsyncWithHttpInfo()

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

Operation getScriptsIDAsyncWithHttpInfo

Retrieve a script

Parameters
string$script_idThe script ID. (required)
Exceptions

InvalidArgumentException

Returns
\GuzzleHttp\Promise\PromiseInterface

◆ getScriptsIDRequest()

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

Create request for operation 'getScriptsID'

Parameters
string$script_idThe script ID. (required)
Exceptions

InvalidArgumentException

Returns
\GuzzleHttp\Psr7\Request

◆ 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|string, HTTP status code, HTTP response headers (array of strings)

◆ getScriptsRequest()

InfluxDB2\Service\InvokableScriptsService::getScriptsRequest (   $limit = null,
  $offset = null 
)
protected

Create request for operation 'getScripts'

Parameters
int$limitThe number of scripts to return. (optional)
int$offsetThe offset for pagination. (optional)
Exceptions

InvalidArgumentException

Returns
\GuzzleHttp\Psr7\Request

◆ getScriptsWithHttpInfo()

InfluxDB2\Service\InvokableScriptsService::getScriptsWithHttpInfo (   $limit = null,
  $offset = null 
)

Operation getScriptsWithHttpInfo

List scripts

Parameters
int$limitThe number of scripts to return. (optional)
int$offsetThe offset for pagination. (optional)
Exceptions

InfluxDB2\ApiException on non-2xx response

Exceptions

InvalidArgumentException

Returns
array of \InfluxDB2\Model\Scripts|string, 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|string

◆ patchScriptsIDAsync()

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

Operation patchScriptsIDAsync

Update a script

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

InvalidArgumentException

Returns
\GuzzleHttp\Promise\PromiseInterface

◆ patchScriptsIDAsyncWithHttpInfo()

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

Operation patchScriptsIDAsyncWithHttpInfo

Update a script

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

InvalidArgumentException

Returns
\GuzzleHttp\Promise\PromiseInterface

◆ 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
\GuzzleHttp\Psr7\Request

◆ 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|string, 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|string

◆ postScriptsAsync()

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

Operation postScriptsAsync

Create a script

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

InvalidArgumentException

Returns
\GuzzleHttp\Promise\PromiseInterface

◆ postScriptsAsyncWithHttpInfo()

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

Operation postScriptsAsyncWithHttpInfo

Create a script

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

InvalidArgumentException

Returns
\GuzzleHttp\Promise\PromiseInterface

◆ postScriptsIDInvoke()

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

Operation postScriptsIDInvoke

Invoke a script

Parameters
string$script_idscript_id (required)
\InfluxDB2\Model\ScriptInvocationParams$script_invocation_paramsscript_invocation_params (optional)
Exceptions

InfluxDB2\ApiException on non-2xx response

Exceptions

InvalidArgumentException

Returns
string|string

◆ postScriptsIDInvokeAsync()

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

Operation postScriptsIDInvokeAsync

Invoke a script

Parameters
string$script_id(required)
\InfluxDB2\Model\ScriptInvocationParams$script_invocation_params(optional)
Exceptions

InvalidArgumentException

Returns
\GuzzleHttp\Promise\PromiseInterface

◆ postScriptsIDInvokeAsyncWithHttpInfo()

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

Operation postScriptsIDInvokeAsyncWithHttpInfo

Invoke a script

Parameters
string$script_id(required)
\InfluxDB2\Model\ScriptInvocationParams$script_invocation_params(optional)
Exceptions

InvalidArgumentException

Returns
\GuzzleHttp\Promise\PromiseInterface

◆ postScriptsIDInvokeRequest()

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

Create request for operation 'postScriptsIDInvoke'

Parameters
string$script_id(required)
\InfluxDB2\Model\ScriptInvocationParams$script_invocation_params(optional)
Exceptions

InvalidArgumentException

Returns
\GuzzleHttp\Psr7\Request

◆ postScriptsIDInvokeWithHttpInfo()

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

Operation postScriptsIDInvokeWithHttpInfo

Invoke a script

Parameters
string$script_id(required)
\InfluxDB2\Model\ScriptInvocationParams$script_invocation_params(optional)
Exceptions

InfluxDB2\ApiException on non-2xx response

Exceptions

InvalidArgumentException

Returns
array of string|string, 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
\GuzzleHttp\Psr7\Request

◆ 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|string, HTTP status code, HTTP response headers (array of strings)

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