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

Public Member Functions

 __construct (ClientInterface $client=null, Configuration $config=null, HeaderSelector $selector=null)
 
 getConfig ()
 
 deleteLabelsID ($label_id, $zap_trace_span=null)
 
 deleteLabelsIDWithHttpInfo ($label_id, $zap_trace_span=null)
 
 deleteLabelsIDAsync ($label_id, $zap_trace_span=null)
 
 deleteLabelsIDAsyncWithHttpInfo ($label_id, $zap_trace_span=null)
 
 getLabels ($zap_trace_span=null, $org_id=null)
 
 getLabelsWithHttpInfo ($zap_trace_span=null, $org_id=null)
 
 getLabelsAsync ($zap_trace_span=null, $org_id=null)
 
 getLabelsAsyncWithHttpInfo ($zap_trace_span=null, $org_id=null)
 
 getLabelsID ($label_id, $zap_trace_span=null)
 
 getLabelsIDWithHttpInfo ($label_id, $zap_trace_span=null)
 
 getLabelsIDAsync ($label_id, $zap_trace_span=null)
 
 getLabelsIDAsyncWithHttpInfo ($label_id, $zap_trace_span=null)
 
 patchLabelsID ($label_id, $label_update, $zap_trace_span=null)
 
 patchLabelsIDWithHttpInfo ($label_id, $label_update, $zap_trace_span=null)
 
 patchLabelsIDAsync ($label_id, $label_update, $zap_trace_span=null)
 
 patchLabelsIDAsyncWithHttpInfo ($label_id, $label_update, $zap_trace_span=null)
 
 postLabels ($label_create_request)
 
 postLabelsWithHttpInfo ($label_create_request)
 
 postLabelsAsync ($label_create_request)
 
 postLabelsAsyncWithHttpInfo ($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)
 
 createHttpClientOption ()
 

Protected Attributes

 $client
 
 $config
 
 $headerSelector
 

Constructor & Destructor Documentation

◆ __construct()

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

Member Function Documentation

◆ createHttpClientOption()

InfluxDB2\Service\LabelsService::createHttpClientOption ( )
protected

Create http client option

Exceptions

RuntimeException on file opening failure

Returns
array of http client options

◆ 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

◆ deleteLabelsIDAsync()

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

Operation deleteLabelsIDAsync

Delete a label

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

InvalidArgumentException

Returns
\GuzzleHttp\Promise\PromiseInterface

◆ deleteLabelsIDAsyncWithHttpInfo()

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

Operation deleteLabelsIDAsyncWithHttpInfo

Delete a label

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

InvalidArgumentException

Returns
\GuzzleHttp\Promise\PromiseInterface

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

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

◆ getConfig()

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

◆ 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

◆ getLabelsAsync()

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

Operation getLabelsAsync

List all labels

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

InvalidArgumentException

Returns
\GuzzleHttp\Promise\PromiseInterface

◆ getLabelsAsyncWithHttpInfo()

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

Operation getLabelsAsyncWithHttpInfo

List all labels

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

InvalidArgumentException

Returns
\GuzzleHttp\Promise\PromiseInterface

◆ 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

◆ getLabelsIDAsync()

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

Operation getLabelsIDAsync

Retrieve a label

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

InvalidArgumentException

Returns
\GuzzleHttp\Promise\PromiseInterface

◆ getLabelsIDAsyncWithHttpInfo()

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

Operation getLabelsIDAsyncWithHttpInfo

Retrieve a label

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

InvalidArgumentException

Returns
\GuzzleHttp\Promise\PromiseInterface

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

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

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

◆ patchLabelsIDAsync()

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

Operation patchLabelsIDAsync

Update a label

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

InvalidArgumentException

Returns
\GuzzleHttp\Promise\PromiseInterface

◆ patchLabelsIDAsyncWithHttpInfo()

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

Operation patchLabelsIDAsyncWithHttpInfo

Update a label

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

InvalidArgumentException

Returns
\GuzzleHttp\Promise\PromiseInterface

◆ 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_updateLabel update (required)
string$zap_trace_spanOpenTracing span context (optional)
Exceptions

InvalidArgumentException

Returns
\GuzzleHttp\Psr7\Request

◆ 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_updateLabel 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|\InfluxDB2\Model\Error, 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_requestLabel to create (required)
Exceptions

InfluxDB2\ApiException on non-2xx response

Exceptions

InvalidArgumentException

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

◆ postLabelsAsync()

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

Operation postLabelsAsync

Create a label

Parameters
\InfluxDB2\Model\LabelCreateRequest$label_create_requestLabel to create (required)
Exceptions

InvalidArgumentException

Returns
\GuzzleHttp\Promise\PromiseInterface

◆ postLabelsAsyncWithHttpInfo()

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

Operation postLabelsAsyncWithHttpInfo

Create a label

Parameters
\InfluxDB2\Model\LabelCreateRequest$label_create_requestLabel to create (required)
Exceptions

InvalidArgumentException

Returns
\GuzzleHttp\Promise\PromiseInterface

◆ postLabelsRequest()

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

Create request for operation 'postLabels'

Parameters
\InfluxDB2\Model\LabelCreateRequest$label_create_requestLabel to create (required)
Exceptions

InvalidArgumentException

Returns
\GuzzleHttp\Psr7\Request

◆ postLabelsWithHttpInfo()

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

Operation postLabelsWithHttpInfo

Create a label

Parameters
\InfluxDB2\Model\LabelCreateRequest$label_create_requestLabel to create (required)
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)

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