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

Public Member Functions

 __construct (ClientInterface $client=null, Configuration $config=null, HeaderSelector $selector=null)
 
 getConfig ()
 
 deleteVariablesID ($variable_id, $zap_trace_span=null)
 
 deleteVariablesIDWithHttpInfo ($variable_id, $zap_trace_span=null)
 
 deleteVariablesIDAsync ($variable_id, $zap_trace_span=null)
 
 deleteVariablesIDAsyncWithHttpInfo ($variable_id, $zap_trace_span=null)
 
 deleteVariablesIDLabelsID ($variable_id, $label_id, $zap_trace_span=null)
 
 deleteVariablesIDLabelsIDWithHttpInfo ($variable_id, $label_id, $zap_trace_span=null)
 
 deleteVariablesIDLabelsIDAsync ($variable_id, $label_id, $zap_trace_span=null)
 
 deleteVariablesIDLabelsIDAsyncWithHttpInfo ($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)
 
 getVariablesAsync ($zap_trace_span=null, $org=null, $org_id=null)
 
 getVariablesAsyncWithHttpInfo ($zap_trace_span=null, $org=null, $org_id=null)
 
 getVariablesID ($variable_id, $zap_trace_span=null)
 
 getVariablesIDWithHttpInfo ($variable_id, $zap_trace_span=null)
 
 getVariablesIDAsync ($variable_id, $zap_trace_span=null)
 
 getVariablesIDAsyncWithHttpInfo ($variable_id, $zap_trace_span=null)
 
 getVariablesIDLabels ($variable_id, $zap_trace_span=null)
 
 getVariablesIDLabelsWithHttpInfo ($variable_id, $zap_trace_span=null)
 
 getVariablesIDLabelsAsync ($variable_id, $zap_trace_span=null)
 
 getVariablesIDLabelsAsyncWithHttpInfo ($variable_id, $zap_trace_span=null)
 
 patchVariablesID ($variable_id, $variable, $zap_trace_span=null)
 
 patchVariablesIDWithHttpInfo ($variable_id, $variable, $zap_trace_span=null)
 
 patchVariablesIDAsync ($variable_id, $variable, $zap_trace_span=null)
 
 patchVariablesIDAsyncWithHttpInfo ($variable_id, $variable, $zap_trace_span=null)
 
 postVariables ($variable, $zap_trace_span=null)
 
 postVariablesWithHttpInfo ($variable, $zap_trace_span=null)
 
 postVariablesAsync ($variable, $zap_trace_span=null)
 
 postVariablesAsyncWithHttpInfo ($variable, $zap_trace_span=null)
 
 postVariablesIDLabels ($variable_id, $label_mapping, $zap_trace_span=null)
 
 postVariablesIDLabelsWithHttpInfo ($variable_id, $label_mapping, $zap_trace_span=null)
 
 postVariablesIDLabelsAsync ($variable_id, $label_mapping, $zap_trace_span=null)
 
 postVariablesIDLabelsAsyncWithHttpInfo ($variable_id, $label_mapping, $zap_trace_span=null)
 
 putVariablesID ($variable_id, $variable, $zap_trace_span=null)
 
 putVariablesIDWithHttpInfo ($variable_id, $variable, $zap_trace_span=null)
 
 putVariablesIDAsync ($variable_id, $variable, $zap_trace_span=null)
 
 putVariablesIDAsyncWithHttpInfo ($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)
 
 createHttpClientOption ()
 

Protected Attributes

 $client
 
 $config
 
 $headerSelector
 

Constructor & Destructor Documentation

◆ __construct()

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

Member Function Documentation

◆ createHttpClientOption()

InfluxDB2\Service\VariablesService::createHttpClientOption ( )
protected

Create http client option

Exceptions

RuntimeException on file opening failure

Returns
array of http client options

◆ 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

◆ deleteVariablesIDAsync()

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

Operation deleteVariablesIDAsync

Delete a variable

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

InvalidArgumentException

Returns
\GuzzleHttp\Promise\PromiseInterface

◆ deleteVariablesIDAsyncWithHttpInfo()

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

Operation deleteVariablesIDAsyncWithHttpInfo

Delete a variable

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

InvalidArgumentException

Returns
\GuzzleHttp\Promise\PromiseInterface

◆ 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

◆ deleteVariablesIDLabelsIDAsync()

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

Operation deleteVariablesIDLabelsIDAsync

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

InvalidArgumentException

Returns
\GuzzleHttp\Promise\PromiseInterface

◆ deleteVariablesIDLabelsIDAsyncWithHttpInfo()

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

Operation deleteVariablesIDLabelsIDAsyncWithHttpInfo

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

InvalidArgumentException

Returns
\GuzzleHttp\Promise\PromiseInterface

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

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

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

◆ getConfig()

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

◆ 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|\InfluxDB2\Model\Error|\InfluxDB2\Model\Error

◆ getVariablesAsync()

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

Operation getVariablesAsync

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

InvalidArgumentException

Returns
\GuzzleHttp\Promise\PromiseInterface

◆ getVariablesAsyncWithHttpInfo()

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

Operation getVariablesAsyncWithHttpInfo

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

InvalidArgumentException

Returns
\GuzzleHttp\Promise\PromiseInterface

◆ 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|\InfluxDB2\Model\Error|\InfluxDB2\Model\Error

◆ getVariablesIDAsync()

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

Operation getVariablesIDAsync

Retrieve a variable

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

InvalidArgumentException

Returns
\GuzzleHttp\Promise\PromiseInterface

◆ getVariablesIDAsyncWithHttpInfo()

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

Operation getVariablesIDAsyncWithHttpInfo

Retrieve a variable

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

InvalidArgumentException

Returns
\GuzzleHttp\Promise\PromiseInterface

◆ 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

◆ getVariablesIDLabelsAsync()

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

Operation getVariablesIDLabelsAsync

List all labels for a variable

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

InvalidArgumentException

Returns
\GuzzleHttp\Promise\PromiseInterface

◆ getVariablesIDLabelsAsyncWithHttpInfo()

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

Operation getVariablesIDLabelsAsyncWithHttpInfo

List all labels for a variable

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

InvalidArgumentException

Returns
\GuzzleHttp\Promise\PromiseInterface

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

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

◆ 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|\InfluxDB2\Model\Error|\InfluxDB2\Model\Error, 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
\GuzzleHttp\Psr7\Request

◆ 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|\InfluxDB2\Model\Error|\InfluxDB2\Model\Error, 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|\InfluxDB2\Model\Error

◆ patchVariablesIDAsync()

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

Operation patchVariablesIDAsync

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

InvalidArgumentException

Returns
\GuzzleHttp\Promise\PromiseInterface

◆ patchVariablesIDAsyncWithHttpInfo()

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

Operation patchVariablesIDAsyncWithHttpInfo

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

InvalidArgumentException

Returns
\GuzzleHttp\Promise\PromiseInterface

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

◆ 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|\InfluxDB2\Model\Error, 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|\InfluxDB2\Model\Error

◆ postVariablesAsync()

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

Operation postVariablesAsync

Create a variable

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

InvalidArgumentException

Returns
\GuzzleHttp\Promise\PromiseInterface

◆ postVariablesAsyncWithHttpInfo()

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

Operation postVariablesAsyncWithHttpInfo

Create a variable

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

InvalidArgumentException

Returns
\GuzzleHttp\Promise\PromiseInterface

◆ 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

◆ postVariablesIDLabelsAsync()

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

Operation postVariablesIDLabelsAsync

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

InvalidArgumentException

Returns
\GuzzleHttp\Promise\PromiseInterface

◆ postVariablesIDLabelsAsyncWithHttpInfo()

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

Operation postVariablesIDLabelsAsyncWithHttpInfo

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

InvalidArgumentException

Returns
\GuzzleHttp\Promise\PromiseInterface

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

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

◆ 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|\InfluxDB2\Model\Error, 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|\InfluxDB2\Model\Error

◆ putVariablesIDAsync()

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

Operation putVariablesIDAsync

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

InvalidArgumentException

Returns
\GuzzleHttp\Promise\PromiseInterface

◆ putVariablesIDAsyncWithHttpInfo()

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

Operation putVariablesIDAsyncWithHttpInfo

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

InvalidArgumentException

Returns
\GuzzleHttp\Promise\PromiseInterface

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

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

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