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

Public Member Functions

 __construct (DefaultApi $defaultApi)
 
 deleteVariablesID ($variable_id, $zap_trace_span=null)
 
 deleteVariablesIDWithHttpInfo ($variable_id, $zap_trace_span=null)
 
 deleteVariablesIDLabelsID ($variable_id, $label_id, $zap_trace_span=null)
 
 deleteVariablesIDLabelsIDWithHttpInfo ($variable_id, $label_id, $zap_trace_span=null)
 
 getVariables ($zap_trace_span=null, $org=null, $org_id=null)
 
 getVariablesWithHttpInfo ($zap_trace_span=null, $org=null, $org_id=null)
 
 getVariablesID ($variable_id, $zap_trace_span=null)
 
 getVariablesIDWithHttpInfo ($variable_id, $zap_trace_span=null)
 
 getVariablesIDLabels ($variable_id, $zap_trace_span=null)
 
 getVariablesIDLabelsWithHttpInfo ($variable_id, $zap_trace_span=null)
 
 patchVariablesID ($variable_id, $variable, $zap_trace_span=null)
 
 patchVariablesIDWithHttpInfo ($variable_id, $variable, $zap_trace_span=null)
 
 postVariables ($variable, $zap_trace_span=null)
 
 postVariablesWithHttpInfo ($variable, $zap_trace_span=null)
 
 postVariablesIDLabels ($variable_id, $label_mapping, $zap_trace_span=null)
 
 postVariablesIDLabelsWithHttpInfo ($variable_id, $label_mapping, $zap_trace_span=null)
 
 putVariablesID ($variable_id, $variable, $zap_trace_span=null)
 
 putVariablesIDWithHttpInfo ($variable_id, $variable, $zap_trace_span=null)
 

Protected Member Functions

 deleteVariablesIDRequest ($variable_id, $zap_trace_span=null)
 
 deleteVariablesIDLabelsIDRequest ($variable_id, $label_id, $zap_trace_span=null)
 
 getVariablesRequest ($zap_trace_span=null, $org=null, $org_id=null)
 
 getVariablesIDRequest ($variable_id, $zap_trace_span=null)
 
 getVariablesIDLabelsRequest ($variable_id, $zap_trace_span=null)
 
 patchVariablesIDRequest ($variable_id, $variable, $zap_trace_span=null)
 
 postVariablesRequest ($variable, $zap_trace_span=null)
 
 postVariablesIDLabelsRequest ($variable_id, $label_mapping, $zap_trace_span=null)
 
 putVariablesIDRequest ($variable_id, $variable, $zap_trace_span=null)
 

Protected Attributes

 $defaultApi
 
 $headerSelector
 

Constructor & Destructor Documentation

◆ __construct()

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

Member Function Documentation

◆ deleteVariablesID()

InfluxDB2\Service\VariablesService::deleteVariablesID ( $variable_id,
$zap_trace_span = null )

Operation deleteVariablesID

Delete a variable

Parameters
string$variable_idThe variable ID. (required)
string$zap_trace_spanOpenTracing span context (optional)
Exceptions

InfluxDB2\ApiException on non-2xx response

Exceptions

InvalidArgumentException

Returns
void

◆ deleteVariablesIDLabelsID()

InfluxDB2\Service\VariablesService::deleteVariablesIDLabelsID ( $variable_id,
$label_id,
$zap_trace_span = null )

Operation deleteVariablesIDLabelsID

Delete a label from a variable

Parameters
string$variable_idThe variable ID. (required)
string$label_idThe label ID to delete. (required)
string$zap_trace_spanOpenTracing span context (optional)
Exceptions

InfluxDB2\ApiException on non-2xx response

Exceptions

InvalidArgumentException

Returns
void

◆ deleteVariablesIDLabelsIDRequest()

InfluxDB2\Service\VariablesService::deleteVariablesIDLabelsIDRequest ( $variable_id,
$label_id,
$zap_trace_span = null )
protected

Create request for operation 'deleteVariablesIDLabelsID'

Parameters
string$variable_idThe variable ID. (required)
string$label_idThe label ID to delete. (required)
string$zap_trace_spanOpenTracing span context (optional)
Exceptions

InvalidArgumentException

Returns
\Psr\Http\Message\RequestInterface

◆ deleteVariablesIDLabelsIDWithHttpInfo()

InfluxDB2\Service\VariablesService::deleteVariablesIDLabelsIDWithHttpInfo ( $variable_id,
$label_id,
$zap_trace_span = null )

Operation deleteVariablesIDLabelsIDWithHttpInfo

Delete a label from a variable

Parameters
string$variable_idThe variable ID. (required)
string$label_idThe label ID to delete. (required)
string$zap_trace_spanOpenTracing span context (optional)
Exceptions

InfluxDB2\ApiException on non-2xx response

Exceptions

InvalidArgumentException

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

◆ deleteVariablesIDRequest()

InfluxDB2\Service\VariablesService::deleteVariablesIDRequest ( $variable_id,
$zap_trace_span = null )
protected

Create request for operation 'deleteVariablesID'

Parameters
string$variable_idThe variable ID. (required)
string$zap_trace_spanOpenTracing span context (optional)
Exceptions

InvalidArgumentException

Returns
\Psr\Http\Message\RequestInterface

◆ deleteVariablesIDWithHttpInfo()

InfluxDB2\Service\VariablesService::deleteVariablesIDWithHttpInfo ( $variable_id,
$zap_trace_span = null )

Operation deleteVariablesIDWithHttpInfo

Delete a variable

Parameters
string$variable_idThe variable ID. (required)
string$zap_trace_spanOpenTracing span context (optional)
Exceptions

InfluxDB2\ApiException on non-2xx response

Exceptions

InvalidArgumentException

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

◆ getVariables()

InfluxDB2\Service\VariablesService::getVariables ( $zap_trace_span = null,
$org = null,
$org_id = null )

Operation getVariables

List all variables

Parameters
string$zap_trace_spanOpenTracing span context (optional)
string$orgThe name of the organization. (optional)
string$org_idThe organization ID. (optional)
Exceptions

InfluxDB2\ApiException on non-2xx response

Exceptions

InvalidArgumentException

Returns
\InfluxDB2\Model\Variables|string|string

◆ getVariablesID()

InfluxDB2\Service\VariablesService::getVariablesID ( $variable_id,
$zap_trace_span = null )

Operation getVariablesID

Retrieve a variable

Parameters
string$variable_idThe variable ID. (required)
string$zap_trace_spanOpenTracing span context (optional)
Exceptions

InfluxDB2\ApiException on non-2xx response

Exceptions

InvalidArgumentException

Returns
\InfluxDB2\Model\Variable|string|string

◆ getVariablesIDLabels()

InfluxDB2\Service\VariablesService::getVariablesIDLabels ( $variable_id,
$zap_trace_span = null )

Operation getVariablesIDLabels

List all labels for a variable

Parameters
string$variable_idThe variable ID. (required)
string$zap_trace_spanOpenTracing span context (optional)
Exceptions

InfluxDB2\ApiException on non-2xx response

Exceptions

InvalidArgumentException

Returns
\InfluxDB2\Model\LabelsResponse|\InfluxDB2\Model\Error

◆ getVariablesIDLabelsRequest()

InfluxDB2\Service\VariablesService::getVariablesIDLabelsRequest ( $variable_id,
$zap_trace_span = null )
protected

Create request for operation 'getVariablesIDLabels'

Parameters
string$variable_idThe variable ID. (required)
string$zap_trace_spanOpenTracing span context (optional)
Exceptions

InvalidArgumentException

Returns
\Psr\Http\Message\RequestInterface

◆ getVariablesIDLabelsWithHttpInfo()

InfluxDB2\Service\VariablesService::getVariablesIDLabelsWithHttpInfo ( $variable_id,
$zap_trace_span = null )

Operation getVariablesIDLabelsWithHttpInfo

List all labels for a variable

Parameters
string$variable_idThe variable ID. (required)
string$zap_trace_spanOpenTracing span context (optional)
Exceptions

InfluxDB2\ApiException on non-2xx response

Exceptions

InvalidArgumentException

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

◆ getVariablesIDRequest()

InfluxDB2\Service\VariablesService::getVariablesIDRequest ( $variable_id,
$zap_trace_span = null )
protected

Create request for operation 'getVariablesID'

Parameters
string$variable_idThe variable ID. (required)
string$zap_trace_spanOpenTracing span context (optional)
Exceptions

InvalidArgumentException

Returns
\Psr\Http\Message\RequestInterface

◆ getVariablesIDWithHttpInfo()

InfluxDB2\Service\VariablesService::getVariablesIDWithHttpInfo ( $variable_id,
$zap_trace_span = null )

Operation getVariablesIDWithHttpInfo

Retrieve a variable

Parameters
string$variable_idThe variable ID. (required)
string$zap_trace_spanOpenTracing span context (optional)
Exceptions

InfluxDB2\ApiException on non-2xx response

Exceptions

InvalidArgumentException

Returns
array of \InfluxDB2\Model\Variable|string|string, HTTP status code, HTTP response headers (array of strings)

◆ getVariablesRequest()

InfluxDB2\Service\VariablesService::getVariablesRequest ( $zap_trace_span = null,
$org = null,
$org_id = null )
protected

Create request for operation 'getVariables'

Parameters
string$zap_trace_spanOpenTracing span context (optional)
string$orgThe name of the organization. (optional)
string$org_idThe organization ID. (optional)
Exceptions

InvalidArgumentException

Returns
\Psr\Http\Message\RequestInterface

◆ getVariablesWithHttpInfo()

InfluxDB2\Service\VariablesService::getVariablesWithHttpInfo ( $zap_trace_span = null,
$org = null,
$org_id = null )

Operation getVariablesWithHttpInfo

List all variables

Parameters
string$zap_trace_spanOpenTracing span context (optional)
string$orgThe name of the organization. (optional)
string$org_idThe organization ID. (optional)
Exceptions

InfluxDB2\ApiException on non-2xx response

Exceptions

InvalidArgumentException

Returns
array of \InfluxDB2\Model\Variables|string|string, HTTP status code, HTTP response headers (array of strings)

◆ patchVariablesID()

InfluxDB2\Service\VariablesService::patchVariablesID ( $variable_id,
$variable,
$zap_trace_span = null )

Operation patchVariablesID

Update a variable

Parameters
string$variable_idThe variable ID. (required)
\InfluxDB2\Model\Variable$variableVariable update to apply (required)
string$zap_trace_spanOpenTracing span context (optional)
Exceptions

InfluxDB2\ApiException on non-2xx response

Exceptions

InvalidArgumentException

Returns
\InfluxDB2\Model\Variable|string

◆ patchVariablesIDRequest()

InfluxDB2\Service\VariablesService::patchVariablesIDRequest ( $variable_id,
$variable,
$zap_trace_span = null )
protected

Create request for operation 'patchVariablesID'

Parameters
string$variable_idThe variable ID. (required)
\InfluxDB2\Model\Variable$variableVariable update to apply (required)
string$zap_trace_spanOpenTracing span context (optional)
Exceptions

InvalidArgumentException

Returns
\Psr\Http\Message\RequestInterface

◆ patchVariablesIDWithHttpInfo()

InfluxDB2\Service\VariablesService::patchVariablesIDWithHttpInfo ( $variable_id,
$variable,
$zap_trace_span = null )

Operation patchVariablesIDWithHttpInfo

Update a variable

Parameters
string$variable_idThe variable ID. (required)
\InfluxDB2\Model\Variable$variableVariable update to apply (required)
string$zap_trace_spanOpenTracing span context (optional)
Exceptions

InfluxDB2\ApiException on non-2xx response

Exceptions

InvalidArgumentException

Returns
array of \InfluxDB2\Model\Variable|string, HTTP status code, HTTP response headers (array of strings)

◆ postVariables()

InfluxDB2\Service\VariablesService::postVariables ( $variable,
$zap_trace_span = null )

Operation postVariables

Create a variable

Parameters
\InfluxDB2\Model\Variable$variableVariable to create (required)
string$zap_trace_spanOpenTracing span context (optional)
Exceptions

InfluxDB2\ApiException on non-2xx response

Exceptions

InvalidArgumentException

Returns
\InfluxDB2\Model\Variable|string

◆ postVariablesIDLabels()

InfluxDB2\Service\VariablesService::postVariablesIDLabels ( $variable_id,
$label_mapping,
$zap_trace_span = null )

Operation postVariablesIDLabels

Add a label to a variable

Parameters
string$variable_idThe variable ID. (required)
\InfluxDB2\Model\LabelMapping$label_mappingLabel to add (required)
string$zap_trace_spanOpenTracing span context (optional)
Exceptions

InfluxDB2\ApiException on non-2xx response

Exceptions

InvalidArgumentException

Returns
\InfluxDB2\Model\LabelResponse|\InfluxDB2\Model\Error

◆ postVariablesIDLabelsRequest()

InfluxDB2\Service\VariablesService::postVariablesIDLabelsRequest ( $variable_id,
$label_mapping,
$zap_trace_span = null )
protected

Create request for operation 'postVariablesIDLabels'

Parameters
string$variable_idThe variable ID. (required)
\InfluxDB2\Model\LabelMapping$label_mappingLabel to add (required)
string$zap_trace_spanOpenTracing span context (optional)
Exceptions

InvalidArgumentException

Returns
\Psr\Http\Message\RequestInterface

◆ postVariablesIDLabelsWithHttpInfo()

InfluxDB2\Service\VariablesService::postVariablesIDLabelsWithHttpInfo ( $variable_id,
$label_mapping,
$zap_trace_span = null )

Operation postVariablesIDLabelsWithHttpInfo

Add a label to a variable

Parameters
string$variable_idThe variable ID. (required)
\InfluxDB2\Model\LabelMapping$label_mappingLabel to add (required)
string$zap_trace_spanOpenTracing span context (optional)
Exceptions

InfluxDB2\ApiException on non-2xx response

Exceptions

InvalidArgumentException

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

◆ postVariablesRequest()

InfluxDB2\Service\VariablesService::postVariablesRequest ( $variable,
$zap_trace_span = null )
protected

Create request for operation 'postVariables'

Parameters
\InfluxDB2\Model\Variable$variableVariable to create (required)
string$zap_trace_spanOpenTracing span context (optional)
Exceptions

InvalidArgumentException

Returns
\Psr\Http\Message\RequestInterface

◆ postVariablesWithHttpInfo()

InfluxDB2\Service\VariablesService::postVariablesWithHttpInfo ( $variable,
$zap_trace_span = null )

Operation postVariablesWithHttpInfo

Create a variable

Parameters
\InfluxDB2\Model\Variable$variableVariable to create (required)
string$zap_trace_spanOpenTracing span context (optional)
Exceptions

InfluxDB2\ApiException on non-2xx response

Exceptions

InvalidArgumentException

Returns
array of \InfluxDB2\Model\Variable|string, HTTP status code, HTTP response headers (array of strings)

◆ putVariablesID()

InfluxDB2\Service\VariablesService::putVariablesID ( $variable_id,
$variable,
$zap_trace_span = null )

Operation putVariablesID

Replace a variable

Parameters
string$variable_idThe variable ID. (required)
\InfluxDB2\Model\Variable$variableVariable to replace (required)
string$zap_trace_spanOpenTracing span context (optional)
Exceptions

InfluxDB2\ApiException on non-2xx response

Exceptions

InvalidArgumentException

Returns
\InfluxDB2\Model\Variable|string

◆ putVariablesIDRequest()

InfluxDB2\Service\VariablesService::putVariablesIDRequest ( $variable_id,
$variable,
$zap_trace_span = null )
protected

Create request for operation 'putVariablesID'

Parameters
string$variable_idThe variable ID. (required)
\InfluxDB2\Model\Variable$variableVariable to replace (required)
string$zap_trace_spanOpenTracing span context (optional)
Exceptions

InvalidArgumentException

Returns
\Psr\Http\Message\RequestInterface

◆ putVariablesIDWithHttpInfo()

InfluxDB2\Service\VariablesService::putVariablesIDWithHttpInfo ( $variable_id,
$variable,
$zap_trace_span = null )

Operation putVariablesIDWithHttpInfo

Replace a variable

Parameters
string$variable_idThe variable ID. (required)
\InfluxDB2\Model\Variable$variableVariable to replace (required)
string$zap_trace_spanOpenTracing span context (optional)
Exceptions

InfluxDB2\ApiException on non-2xx response

Exceptions

InvalidArgumentException

Returns
array of \InfluxDB2\Model\Variable|string, HTTP status code, HTTP response headers (array of strings)

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