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

Public Member Functions

 __construct (DefaultApi $defaultApi)
 
 deleteLabelsID ($label_id, $zap_trace_span=null)
 
 deleteLabelsIDWithHttpInfo ($label_id, $zap_trace_span=null)
 
 getLabels ($zap_trace_span=null, $org_id=null)
 
 getLabelsWithHttpInfo ($zap_trace_span=null, $org_id=null)
 
 getLabelsID ($label_id, $zap_trace_span=null)
 
 getLabelsIDWithHttpInfo ($label_id, $zap_trace_span=null)
 
 patchLabelsID ($label_id, $label_update, $zap_trace_span=null)
 
 patchLabelsIDWithHttpInfo ($label_id, $label_update, $zap_trace_span=null)
 
 postLabels ($label_create_request)
 
 postLabelsWithHttpInfo ($label_create_request)
 

Protected Member Functions

 deleteLabelsIDRequest ($label_id, $zap_trace_span=null)
 
 getLabelsRequest ($zap_trace_span=null, $org_id=null)
 
 getLabelsIDRequest ($label_id, $zap_trace_span=null)
 
 patchLabelsIDRequest ($label_id, $label_update, $zap_trace_span=null)
 
 postLabelsRequest ($label_create_request)
 

Protected Attributes

 $defaultApi
 
 $headerSelector
 

Constructor & Destructor Documentation

◆ __construct()

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

Member Function Documentation

◆ deleteLabelsID()

InfluxDB2\Service\LabelsService::deleteLabelsID ( $label_id,
$zap_trace_span = null )

Operation deleteLabelsID

Delete a label

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

InfluxDB2\ApiException on non-2xx response

Exceptions

InvalidArgumentException

Returns
void

◆ deleteLabelsIDRequest()

InfluxDB2\Service\LabelsService::deleteLabelsIDRequest ( $label_id,
$zap_trace_span = null )
protected

Create request for operation 'deleteLabelsID'

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

InvalidArgumentException

Returns
\Psr\Http\Message\RequestInterface

◆ deleteLabelsIDWithHttpInfo()

InfluxDB2\Service\LabelsService::deleteLabelsIDWithHttpInfo ( $label_id,
$zap_trace_span = null )

Operation deleteLabelsIDWithHttpInfo

Delete a label

Parameters
string$label_idThe ID of the label 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)

◆ getLabels()

InfluxDB2\Service\LabelsService::getLabels ( $zap_trace_span = null,
$org_id = null )

Operation getLabels

List all labels

Parameters
string$zap_trace_spanOpenTracing span context (optional)
string$org_idThe organization ID. (optional)
Exceptions

InfluxDB2\ApiException on non-2xx response

Exceptions

InvalidArgumentException

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

◆ getLabelsID()

InfluxDB2\Service\LabelsService::getLabelsID ( $label_id,
$zap_trace_span = null )

Operation getLabelsID

Retrieve a label

Parameters
string$label_idThe ID of the label to update. (required)
string$zap_trace_spanOpenTracing span context (optional)
Exceptions

InfluxDB2\ApiException on non-2xx response

Exceptions

InvalidArgumentException

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

◆ getLabelsIDRequest()

InfluxDB2\Service\LabelsService::getLabelsIDRequest ( $label_id,
$zap_trace_span = null )
protected

Create request for operation 'getLabelsID'

Parameters
string$label_idThe ID of the label to update. (required)
string$zap_trace_spanOpenTracing span context (optional)
Exceptions

InvalidArgumentException

Returns
\Psr\Http\Message\RequestInterface

◆ getLabelsIDWithHttpInfo()

InfluxDB2\Service\LabelsService::getLabelsIDWithHttpInfo ( $label_id,
$zap_trace_span = null )

Operation getLabelsIDWithHttpInfo

Retrieve a label

Parameters
string$label_idThe ID of the label to update. (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|string, HTTP status code, HTTP response headers (array of strings)

◆ getLabelsRequest()

InfluxDB2\Service\LabelsService::getLabelsRequest ( $zap_trace_span = null,
$org_id = null )
protected

Create request for operation 'getLabels'

Parameters
string$zap_trace_spanOpenTracing span context (optional)
string$org_idThe organization ID. (optional)
Exceptions

InvalidArgumentException

Returns
\Psr\Http\Message\RequestInterface

◆ getLabelsWithHttpInfo()

InfluxDB2\Service\LabelsService::getLabelsWithHttpInfo ( $zap_trace_span = null,
$org_id = null )

Operation getLabelsWithHttpInfo

List all labels

Parameters
string$zap_trace_spanOpenTracing span context (optional)
string$org_idThe organization ID. (optional)
Exceptions

InfluxDB2\ApiException on non-2xx response

Exceptions

InvalidArgumentException

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

◆ patchLabelsID()

InfluxDB2\Service\LabelsService::patchLabelsID ( $label_id,
$label_update,
$zap_trace_span = null )

Operation patchLabelsID

Update a label

Parameters
string$label_idThe ID of the label to update. (required)
\InfluxDB2\Model\LabelUpdate$label_updateA label update. (required)
string$zap_trace_spanOpenTracing span context (optional)
Exceptions

InfluxDB2\ApiException on non-2xx response

Exceptions

InvalidArgumentException

Returns
\InfluxDB2\Model\LabelResponse|object|\InfluxDB2\Model\Error|\InfluxDB2\Model\Error|string

◆ patchLabelsIDRequest()

InfluxDB2\Service\LabelsService::patchLabelsIDRequest ( $label_id,
$label_update,
$zap_trace_span = null )
protected

Create request for operation 'patchLabelsID'

Parameters
string$label_idThe ID of the label to update. (required)
\InfluxDB2\Model\LabelUpdate$label_updateA label update. (required)
string$zap_trace_spanOpenTracing span context (optional)
Exceptions

InvalidArgumentException

Returns
\Psr\Http\Message\RequestInterface

◆ patchLabelsIDWithHttpInfo()

InfluxDB2\Service\LabelsService::patchLabelsIDWithHttpInfo ( $label_id,
$label_update,
$zap_trace_span = null )

Operation patchLabelsIDWithHttpInfo

Update a label

Parameters
string$label_idThe ID of the label to update. (required)
\InfluxDB2\Model\LabelUpdate$label_updateA label update. (required)
string$zap_trace_spanOpenTracing span context (optional)
Exceptions

InfluxDB2\ApiException on non-2xx response

Exceptions

InvalidArgumentException

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

◆ postLabels()

InfluxDB2\Service\LabelsService::postLabels ( $label_create_request)

Operation postLabels

Create a label

Parameters
\InfluxDB2\Model\LabelCreateRequest$label_create_requestThe label to create. (required)
Exceptions

InfluxDB2\ApiException on non-2xx response

Exceptions

InvalidArgumentException

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

◆ postLabelsRequest()

InfluxDB2\Service\LabelsService::postLabelsRequest ( $label_create_request)
protected

Create request for operation 'postLabels'

Parameters
\InfluxDB2\Model\LabelCreateRequest$label_create_requestThe label to create. (required)
Exceptions

InvalidArgumentException

Returns
\Psr\Http\Message\RequestInterface

◆ postLabelsWithHttpInfo()

InfluxDB2\Service\LabelsService::postLabelsWithHttpInfo ( $label_create_request)

Operation postLabelsWithHttpInfo

Create a label

Parameters
\InfluxDB2\Model\LabelCreateRequest$label_create_requestThe label to create. (required)
Exceptions

InfluxDB2\ApiException on non-2xx response

Exceptions

InvalidArgumentException

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