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

Public Member Functions

 __construct (ClientInterface $client=null, Configuration $config=null, HeaderSelector $selector=null)
 
 getConfig ()
 
 createCheck ($check)
 
 createCheckWithHttpInfo ($check)
 
 createCheckAsync ($check)
 
 createCheckAsyncWithHttpInfo ($check)
 
 deleteChecksID ($check_id, $zap_trace_span=null)
 
 deleteChecksIDWithHttpInfo ($check_id, $zap_trace_span=null)
 
 deleteChecksIDAsync ($check_id, $zap_trace_span=null)
 
 deleteChecksIDAsyncWithHttpInfo ($check_id, $zap_trace_span=null)
 
 deleteChecksIDLabelsID ($check_id, $label_id, $zap_trace_span=null)
 
 deleteChecksIDLabelsIDWithHttpInfo ($check_id, $label_id, $zap_trace_span=null)
 
 deleteChecksIDLabelsIDAsync ($check_id, $label_id, $zap_trace_span=null)
 
 deleteChecksIDLabelsIDAsyncWithHttpInfo ($check_id, $label_id, $zap_trace_span=null)
 
 getChecks ($org_id, $zap_trace_span=null, $offset=null, $limit=20)
 
 getChecksWithHttpInfo ($org_id, $zap_trace_span=null, $offset=null, $limit=20)
 
 getChecksAsync ($org_id, $zap_trace_span=null, $offset=null, $limit=20)
 
 getChecksAsyncWithHttpInfo ($org_id, $zap_trace_span=null, $offset=null, $limit=20)
 
 getChecksID ($check_id, $zap_trace_span=null)
 
 getChecksIDWithHttpInfo ($check_id, $zap_trace_span=null)
 
 getChecksIDAsync ($check_id, $zap_trace_span=null)
 
 getChecksIDAsyncWithHttpInfo ($check_id, $zap_trace_span=null)
 
 getChecksIDLabels ($check_id, $zap_trace_span=null)
 
 getChecksIDLabelsWithHttpInfo ($check_id, $zap_trace_span=null)
 
 getChecksIDLabelsAsync ($check_id, $zap_trace_span=null)
 
 getChecksIDLabelsAsyncWithHttpInfo ($check_id, $zap_trace_span=null)
 
 getChecksIDQuery ($check_id, $zap_trace_span=null)
 
 getChecksIDQueryWithHttpInfo ($check_id, $zap_trace_span=null)
 
 getChecksIDQueryAsync ($check_id, $zap_trace_span=null)
 
 getChecksIDQueryAsyncWithHttpInfo ($check_id, $zap_trace_span=null)
 
 patchChecksID ($check_id, $check_patch, $zap_trace_span=null)
 
 patchChecksIDWithHttpInfo ($check_id, $check_patch, $zap_trace_span=null)
 
 patchChecksIDAsync ($check_id, $check_patch, $zap_trace_span=null)
 
 patchChecksIDAsyncWithHttpInfo ($check_id, $check_patch, $zap_trace_span=null)
 
 postChecksIDLabels ($check_id, $label_mapping, $zap_trace_span=null)
 
 postChecksIDLabelsWithHttpInfo ($check_id, $label_mapping, $zap_trace_span=null)
 
 postChecksIDLabelsAsync ($check_id, $label_mapping, $zap_trace_span=null)
 
 postChecksIDLabelsAsyncWithHttpInfo ($check_id, $label_mapping, $zap_trace_span=null)
 
 putChecksID ($check_id, $check, $zap_trace_span=null)
 
 putChecksIDWithHttpInfo ($check_id, $check, $zap_trace_span=null)
 
 putChecksIDAsync ($check_id, $check, $zap_trace_span=null)
 
 putChecksIDAsyncWithHttpInfo ($check_id, $check, $zap_trace_span=null)
 

Protected Member Functions

 createCheckRequest ($check)
 
 deleteChecksIDRequest ($check_id, $zap_trace_span=null)
 
 deleteChecksIDLabelsIDRequest ($check_id, $label_id, $zap_trace_span=null)
 
 getChecksRequest ($org_id, $zap_trace_span=null, $offset=null, $limit=20)
 
 getChecksIDRequest ($check_id, $zap_trace_span=null)
 
 getChecksIDLabelsRequest ($check_id, $zap_trace_span=null)
 
 getChecksIDQueryRequest ($check_id, $zap_trace_span=null)
 
 patchChecksIDRequest ($check_id, $check_patch, $zap_trace_span=null)
 
 postChecksIDLabelsRequest ($check_id, $label_mapping, $zap_trace_span=null)
 
 putChecksIDRequest ($check_id, $check, $zap_trace_span=null)
 
 createHttpClientOption ()
 

Protected Attributes

 $client
 
 $config
 
 $headerSelector
 

Constructor & Destructor Documentation

◆ __construct()

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

Member Function Documentation

◆ createCheck()

InfluxDB2\Service\ChecksService::createCheck (   $check)

Operation createCheck

Add new check

Parameters
\InfluxDB2\Model\Check$checkCheck to create (required)
Exceptions

InfluxDB2\ApiException on non-2xx response

Exceptions

InvalidArgumentException

Returns
\InfluxDB2\Model\Check|\InfluxDB2\Model\Error

◆ createCheckAsync()

InfluxDB2\Service\ChecksService::createCheckAsync (   $check)

Operation createCheckAsync

Add new check

Parameters
\InfluxDB2\Model\Check$checkCheck to create (required)
Exceptions

InvalidArgumentException

Returns
\GuzzleHttp\Promise\PromiseInterface

◆ createCheckAsyncWithHttpInfo()

InfluxDB2\Service\ChecksService::createCheckAsyncWithHttpInfo (   $check)

Operation createCheckAsyncWithHttpInfo

Add new check

Parameters
\InfluxDB2\Model\Check$checkCheck to create (required)
Exceptions

InvalidArgumentException

Returns
\GuzzleHttp\Promise\PromiseInterface

◆ createCheckRequest()

InfluxDB2\Service\ChecksService::createCheckRequest (   $check)
protected

Create request for operation 'createCheck'

Parameters
\InfluxDB2\Model\Check$checkCheck to create (required)
Exceptions

InvalidArgumentException

Returns
\GuzzleHttp\Psr7\Request

◆ createCheckWithHttpInfo()

InfluxDB2\Service\ChecksService::createCheckWithHttpInfo (   $check)

Operation createCheckWithHttpInfo

Add new check

Parameters
\InfluxDB2\Model\Check$checkCheck to create (required)
Exceptions

InfluxDB2\ApiException on non-2xx response

Exceptions

InvalidArgumentException

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

◆ createHttpClientOption()

InfluxDB2\Service\ChecksService::createHttpClientOption ( )
protected

Create http client option

Exceptions

RuntimeException on file opening failure

Returns
array of http client options

◆ deleteChecksID()

InfluxDB2\Service\ChecksService::deleteChecksID (   $check_id,
  $zap_trace_span = null 
)

Operation deleteChecksID

Delete a check

Parameters
string$check_idThe check ID. (required)
string$zap_trace_spanOpenTracing span context (optional)
Exceptions

InfluxDB2\ApiException on non-2xx response

Exceptions

InvalidArgumentException

Returns
void

◆ deleteChecksIDAsync()

InfluxDB2\Service\ChecksService::deleteChecksIDAsync (   $check_id,
  $zap_trace_span = null 
)

Operation deleteChecksIDAsync

Delete a check

Parameters
string$check_idThe check ID. (required)
string$zap_trace_spanOpenTracing span context (optional)
Exceptions

InvalidArgumentException

Returns
\GuzzleHttp\Promise\PromiseInterface

◆ deleteChecksIDAsyncWithHttpInfo()

InfluxDB2\Service\ChecksService::deleteChecksIDAsyncWithHttpInfo (   $check_id,
  $zap_trace_span = null 
)

Operation deleteChecksIDAsyncWithHttpInfo

Delete a check

Parameters
string$check_idThe check ID. (required)
string$zap_trace_spanOpenTracing span context (optional)
Exceptions

InvalidArgumentException

Returns
\GuzzleHttp\Promise\PromiseInterface

◆ deleteChecksIDLabelsID()

InfluxDB2\Service\ChecksService::deleteChecksIDLabelsID (   $check_id,
  $label_id,
  $zap_trace_span = null 
)

Operation deleteChecksIDLabelsID

Delete label from a check

Parameters
string$check_idThe check ID. (required)
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

◆ deleteChecksIDLabelsIDAsync()

InfluxDB2\Service\ChecksService::deleteChecksIDLabelsIDAsync (   $check_id,
  $label_id,
  $zap_trace_span = null 
)

Operation deleteChecksIDLabelsIDAsync

Delete label from a check

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

InvalidArgumentException

Returns
\GuzzleHttp\Promise\PromiseInterface

◆ deleteChecksIDLabelsIDAsyncWithHttpInfo()

InfluxDB2\Service\ChecksService::deleteChecksIDLabelsIDAsyncWithHttpInfo (   $check_id,
  $label_id,
  $zap_trace_span = null 
)

Operation deleteChecksIDLabelsIDAsyncWithHttpInfo

Delete label from a check

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

InvalidArgumentException

Returns
\GuzzleHttp\Promise\PromiseInterface

◆ deleteChecksIDLabelsIDRequest()

InfluxDB2\Service\ChecksService::deleteChecksIDLabelsIDRequest (   $check_id,
  $label_id,
  $zap_trace_span = null 
)
protected

Create request for operation 'deleteChecksIDLabelsID'

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

InvalidArgumentException

Returns
\GuzzleHttp\Psr7\Request

◆ deleteChecksIDLabelsIDWithHttpInfo()

InfluxDB2\Service\ChecksService::deleteChecksIDLabelsIDWithHttpInfo (   $check_id,
  $label_id,
  $zap_trace_span = null 
)

Operation deleteChecksIDLabelsIDWithHttpInfo

Delete label from a check

Parameters
string$check_idThe check ID. (required)
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)

◆ deleteChecksIDRequest()

InfluxDB2\Service\ChecksService::deleteChecksIDRequest (   $check_id,
  $zap_trace_span = null 
)
protected

Create request for operation 'deleteChecksID'

Parameters
string$check_idThe check ID. (required)
string$zap_trace_spanOpenTracing span context (optional)
Exceptions

InvalidArgumentException

Returns
\GuzzleHttp\Psr7\Request

◆ deleteChecksIDWithHttpInfo()

InfluxDB2\Service\ChecksService::deleteChecksIDWithHttpInfo (   $check_id,
  $zap_trace_span = null 
)

Operation deleteChecksIDWithHttpInfo

Delete a check

Parameters
string$check_idThe check 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)

◆ getChecks()

InfluxDB2\Service\ChecksService::getChecks (   $org_id,
  $zap_trace_span = null,
  $offset = null,
  $limit = 20 
)

Operation getChecks

List all checks

Parameters
string$org_idOnly show checks that belong to a specific organization ID. (required)
string$zap_trace_spanOpenTracing span context (optional)
int$offsetoffset (optional)
int$limitlimit (optional, default to 20)
Exceptions

InfluxDB2\ApiException on non-2xx response

Exceptions

InvalidArgumentException

Returns
\InfluxDB2\Model\Checks|\InfluxDB2\Model\Error

◆ getChecksAsync()

InfluxDB2\Service\ChecksService::getChecksAsync (   $org_id,
  $zap_trace_span = null,
  $offset = null,
  $limit = 20 
)

Operation getChecksAsync

List all checks

Parameters
string$org_idOnly show checks that belong to a specific organization ID. (required)
string$zap_trace_spanOpenTracing span context (optional)
int$offset(optional)
int$limit(optional, default to 20)
Exceptions

InvalidArgumentException

Returns
\GuzzleHttp\Promise\PromiseInterface

◆ getChecksAsyncWithHttpInfo()

InfluxDB2\Service\ChecksService::getChecksAsyncWithHttpInfo (   $org_id,
  $zap_trace_span = null,
  $offset = null,
  $limit = 20 
)

Operation getChecksAsyncWithHttpInfo

List all checks

Parameters
string$org_idOnly show checks that belong to a specific organization ID. (required)
string$zap_trace_spanOpenTracing span context (optional)
int$offset(optional)
int$limit(optional, default to 20)
Exceptions

InvalidArgumentException

Returns
\GuzzleHttp\Promise\PromiseInterface

◆ getChecksID()

InfluxDB2\Service\ChecksService::getChecksID (   $check_id,
  $zap_trace_span = null 
)

Operation getChecksID

Retrieve a check

Parameters
string$check_idThe check ID. (required)
string$zap_trace_spanOpenTracing span context (optional)
Exceptions

InfluxDB2\ApiException on non-2xx response

Exceptions

InvalidArgumentException

Returns
\InfluxDB2\Model\Check|\InfluxDB2\Model\Error

◆ getChecksIDAsync()

InfluxDB2\Service\ChecksService::getChecksIDAsync (   $check_id,
  $zap_trace_span = null 
)

Operation getChecksIDAsync

Retrieve a check

Parameters
string$check_idThe check ID. (required)
string$zap_trace_spanOpenTracing span context (optional)
Exceptions

InvalidArgumentException

Returns
\GuzzleHttp\Promise\PromiseInterface

◆ getChecksIDAsyncWithHttpInfo()

InfluxDB2\Service\ChecksService::getChecksIDAsyncWithHttpInfo (   $check_id,
  $zap_trace_span = null 
)

Operation getChecksIDAsyncWithHttpInfo

Retrieve a check

Parameters
string$check_idThe check ID. (required)
string$zap_trace_spanOpenTracing span context (optional)
Exceptions

InvalidArgumentException

Returns
\GuzzleHttp\Promise\PromiseInterface

◆ getChecksIDLabels()

InfluxDB2\Service\ChecksService::getChecksIDLabels (   $check_id,
  $zap_trace_span = null 
)

Operation getChecksIDLabels

List all labels for a check

Parameters
string$check_idThe check 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

◆ getChecksIDLabelsAsync()

InfluxDB2\Service\ChecksService::getChecksIDLabelsAsync (   $check_id,
  $zap_trace_span = null 
)

Operation getChecksIDLabelsAsync

List all labels for a check

Parameters
string$check_idThe check ID. (required)
string$zap_trace_spanOpenTracing span context (optional)
Exceptions

InvalidArgumentException

Returns
\GuzzleHttp\Promise\PromiseInterface

◆ getChecksIDLabelsAsyncWithHttpInfo()

InfluxDB2\Service\ChecksService::getChecksIDLabelsAsyncWithHttpInfo (   $check_id,
  $zap_trace_span = null 
)

Operation getChecksIDLabelsAsyncWithHttpInfo

List all labels for a check

Parameters
string$check_idThe check ID. (required)
string$zap_trace_spanOpenTracing span context (optional)
Exceptions

InvalidArgumentException

Returns
\GuzzleHttp\Promise\PromiseInterface

◆ getChecksIDLabelsRequest()

InfluxDB2\Service\ChecksService::getChecksIDLabelsRequest (   $check_id,
  $zap_trace_span = null 
)
protected

Create request for operation 'getChecksIDLabels'

Parameters
string$check_idThe check ID. (required)
string$zap_trace_spanOpenTracing span context (optional)
Exceptions

InvalidArgumentException

Returns
\GuzzleHttp\Psr7\Request

◆ getChecksIDLabelsWithHttpInfo()

InfluxDB2\Service\ChecksService::getChecksIDLabelsWithHttpInfo (   $check_id,
  $zap_trace_span = null 
)

Operation getChecksIDLabelsWithHttpInfo

List all labels for a check

Parameters
string$check_idThe check 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)

◆ getChecksIDQuery()

InfluxDB2\Service\ChecksService::getChecksIDQuery (   $check_id,
  $zap_trace_span = null 
)

Operation getChecksIDQuery

Retrieve a check query

Parameters
string$check_idThe check ID. (required)
string$zap_trace_spanOpenTracing span context (optional)
Exceptions

InfluxDB2\ApiException on non-2xx response

Exceptions

InvalidArgumentException

Returns
\InfluxDB2\Model\FluxResponse|\InfluxDB2\Model\Error|\InfluxDB2\Model\Error|\InfluxDB2\Model\Error

◆ getChecksIDQueryAsync()

InfluxDB2\Service\ChecksService::getChecksIDQueryAsync (   $check_id,
  $zap_trace_span = null 
)

Operation getChecksIDQueryAsync

Retrieve a check query

Parameters
string$check_idThe check ID. (required)
string$zap_trace_spanOpenTracing span context (optional)
Exceptions

InvalidArgumentException

Returns
\GuzzleHttp\Promise\PromiseInterface

◆ getChecksIDQueryAsyncWithHttpInfo()

InfluxDB2\Service\ChecksService::getChecksIDQueryAsyncWithHttpInfo (   $check_id,
  $zap_trace_span = null 
)

Operation getChecksIDQueryAsyncWithHttpInfo

Retrieve a check query

Parameters
string$check_idThe check ID. (required)
string$zap_trace_spanOpenTracing span context (optional)
Exceptions

InvalidArgumentException

Returns
\GuzzleHttp\Promise\PromiseInterface

◆ getChecksIDQueryRequest()

InfluxDB2\Service\ChecksService::getChecksIDQueryRequest (   $check_id,
  $zap_trace_span = null 
)
protected

Create request for operation 'getChecksIDQuery'

Parameters
string$check_idThe check ID. (required)
string$zap_trace_spanOpenTracing span context (optional)
Exceptions

InvalidArgumentException

Returns
\GuzzleHttp\Psr7\Request

◆ getChecksIDQueryWithHttpInfo()

InfluxDB2\Service\ChecksService::getChecksIDQueryWithHttpInfo (   $check_id,
  $zap_trace_span = null 
)

Operation getChecksIDQueryWithHttpInfo

Retrieve a check query

Parameters
string$check_idThe check ID. (required)
string$zap_trace_spanOpenTracing span context (optional)
Exceptions

InfluxDB2\ApiException on non-2xx response

Exceptions

InvalidArgumentException

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

◆ getChecksIDRequest()

InfluxDB2\Service\ChecksService::getChecksIDRequest (   $check_id,
  $zap_trace_span = null 
)
protected

Create request for operation 'getChecksID'

Parameters
string$check_idThe check ID. (required)
string$zap_trace_spanOpenTracing span context (optional)
Exceptions

InvalidArgumentException

Returns
\GuzzleHttp\Psr7\Request

◆ getChecksIDWithHttpInfo()

InfluxDB2\Service\ChecksService::getChecksIDWithHttpInfo (   $check_id,
  $zap_trace_span = null 
)

Operation getChecksIDWithHttpInfo

Retrieve a check

Parameters
string$check_idThe check ID. (required)
string$zap_trace_spanOpenTracing span context (optional)
Exceptions

InfluxDB2\ApiException on non-2xx response

Exceptions

InvalidArgumentException

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

◆ getChecksRequest()

InfluxDB2\Service\ChecksService::getChecksRequest (   $org_id,
  $zap_trace_span = null,
  $offset = null,
  $limit = 20 
)
protected

Create request for operation 'getChecks'

Parameters
string$org_idOnly show checks that belong to a specific organization ID. (required)
string$zap_trace_spanOpenTracing span context (optional)
int$offset(optional)
int$limit(optional, default to 20)
Exceptions

InvalidArgumentException

Returns
\GuzzleHttp\Psr7\Request

◆ getChecksWithHttpInfo()

InfluxDB2\Service\ChecksService::getChecksWithHttpInfo (   $org_id,
  $zap_trace_span = null,
  $offset = null,
  $limit = 20 
)

Operation getChecksWithHttpInfo

List all checks

Parameters
string$org_idOnly show checks that belong to a specific organization ID. (required)
string$zap_trace_spanOpenTracing span context (optional)
int$offset(optional)
int$limit(optional, default to 20)
Exceptions

InfluxDB2\ApiException on non-2xx response

Exceptions

InvalidArgumentException

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

◆ getConfig()

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

◆ patchChecksID()

InfluxDB2\Service\ChecksService::patchChecksID (   $check_id,
  $check_patch,
  $zap_trace_span = null 
)

Operation patchChecksID

Update a check

Parameters
string$check_idThe check ID. (required)
\InfluxDB2\Model\CheckPatch$check_patchCheck update to apply (required)
string$zap_trace_spanOpenTracing span context (optional)
Exceptions

InfluxDB2\ApiException on non-2xx response

Exceptions

InvalidArgumentException

Returns
\InfluxDB2\Model\Check|\InfluxDB2\Model\Error|\InfluxDB2\Model\Error

◆ patchChecksIDAsync()

InfluxDB2\Service\ChecksService::patchChecksIDAsync (   $check_id,
  $check_patch,
  $zap_trace_span = null 
)

Operation patchChecksIDAsync

Update a check

Parameters
string$check_idThe check ID. (required)
\InfluxDB2\Model\CheckPatch$check_patchCheck update to apply (required)
string$zap_trace_spanOpenTracing span context (optional)
Exceptions

InvalidArgumentException

Returns
\GuzzleHttp\Promise\PromiseInterface

◆ patchChecksIDAsyncWithHttpInfo()

InfluxDB2\Service\ChecksService::patchChecksIDAsyncWithHttpInfo (   $check_id,
  $check_patch,
  $zap_trace_span = null 
)

Operation patchChecksIDAsyncWithHttpInfo

Update a check

Parameters
string$check_idThe check ID. (required)
\InfluxDB2\Model\CheckPatch$check_patchCheck update to apply (required)
string$zap_trace_spanOpenTracing span context (optional)
Exceptions

InvalidArgumentException

Returns
\GuzzleHttp\Promise\PromiseInterface

◆ patchChecksIDRequest()

InfluxDB2\Service\ChecksService::patchChecksIDRequest (   $check_id,
  $check_patch,
  $zap_trace_span = null 
)
protected

Create request for operation 'patchChecksID'

Parameters
string$check_idThe check ID. (required)
\InfluxDB2\Model\CheckPatch$check_patchCheck update to apply (required)
string$zap_trace_spanOpenTracing span context (optional)
Exceptions

InvalidArgumentException

Returns
\GuzzleHttp\Psr7\Request

◆ patchChecksIDWithHttpInfo()

InfluxDB2\Service\ChecksService::patchChecksIDWithHttpInfo (   $check_id,
  $check_patch,
  $zap_trace_span = null 
)

Operation patchChecksIDWithHttpInfo

Update a check

Parameters
string$check_idThe check ID. (required)
\InfluxDB2\Model\CheckPatch$check_patchCheck 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\Check|\InfluxDB2\Model\Error|\InfluxDB2\Model\Error, HTTP status code, HTTP response headers (array of strings)

◆ postChecksIDLabels()

InfluxDB2\Service\ChecksService::postChecksIDLabels (   $check_id,
  $label_mapping,
  $zap_trace_span = null 
)

Operation postChecksIDLabels

Add a label to a check

Parameters
string$check_idThe check 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

◆ postChecksIDLabelsAsync()

InfluxDB2\Service\ChecksService::postChecksIDLabelsAsync (   $check_id,
  $label_mapping,
  $zap_trace_span = null 
)

Operation postChecksIDLabelsAsync

Add a label to a check

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

InvalidArgumentException

Returns
\GuzzleHttp\Promise\PromiseInterface

◆ postChecksIDLabelsAsyncWithHttpInfo()

InfluxDB2\Service\ChecksService::postChecksIDLabelsAsyncWithHttpInfo (   $check_id,
  $label_mapping,
  $zap_trace_span = null 
)

Operation postChecksIDLabelsAsyncWithHttpInfo

Add a label to a check

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

InvalidArgumentException

Returns
\GuzzleHttp\Promise\PromiseInterface

◆ postChecksIDLabelsRequest()

InfluxDB2\Service\ChecksService::postChecksIDLabelsRequest (   $check_id,
  $label_mapping,
  $zap_trace_span = null 
)
protected

Create request for operation 'postChecksIDLabels'

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

InvalidArgumentException

Returns
\GuzzleHttp\Psr7\Request

◆ postChecksIDLabelsWithHttpInfo()

InfluxDB2\Service\ChecksService::postChecksIDLabelsWithHttpInfo (   $check_id,
  $label_mapping,
  $zap_trace_span = null 
)

Operation postChecksIDLabelsWithHttpInfo

Add a label to a check

Parameters
string$check_idThe check 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)

◆ putChecksID()

InfluxDB2\Service\ChecksService::putChecksID (   $check_id,
  $check,
  $zap_trace_span = null 
)

Operation putChecksID

Update a check

Parameters
string$check_idThe check ID. (required)
\InfluxDB2\Model\Check$checkCheck update to apply (required)
string$zap_trace_spanOpenTracing span context (optional)
Exceptions

InfluxDB2\ApiException on non-2xx response

Exceptions

InvalidArgumentException

Returns
\InfluxDB2\Model\Check|\InfluxDB2\Model\Error|\InfluxDB2\Model\Error

◆ putChecksIDAsync()

InfluxDB2\Service\ChecksService::putChecksIDAsync (   $check_id,
  $check,
  $zap_trace_span = null 
)

Operation putChecksIDAsync

Update a check

Parameters
string$check_idThe check ID. (required)
\InfluxDB2\Model\Check$checkCheck update to apply (required)
string$zap_trace_spanOpenTracing span context (optional)
Exceptions

InvalidArgumentException

Returns
\GuzzleHttp\Promise\PromiseInterface

◆ putChecksIDAsyncWithHttpInfo()

InfluxDB2\Service\ChecksService::putChecksIDAsyncWithHttpInfo (   $check_id,
  $check,
  $zap_trace_span = null 
)

Operation putChecksIDAsyncWithHttpInfo

Update a check

Parameters
string$check_idThe check ID. (required)
\InfluxDB2\Model\Check$checkCheck update to apply (required)
string$zap_trace_spanOpenTracing span context (optional)
Exceptions

InvalidArgumentException

Returns
\GuzzleHttp\Promise\PromiseInterface

◆ putChecksIDRequest()

InfluxDB2\Service\ChecksService::putChecksIDRequest (   $check_id,
  $check,
  $zap_trace_span = null 
)
protected

Create request for operation 'putChecksID'

Parameters
string$check_idThe check ID. (required)
\InfluxDB2\Model\Check$checkCheck update to apply (required)
string$zap_trace_spanOpenTracing span context (optional)
Exceptions

InvalidArgumentException

Returns
\GuzzleHttp\Psr7\Request

◆ putChecksIDWithHttpInfo()

InfluxDB2\Service\ChecksService::putChecksIDWithHttpInfo (   $check_id,
  $check,
  $zap_trace_span = null 
)

Operation putChecksIDWithHttpInfo

Update a check

Parameters
string$check_idThe check ID. (required)
\InfluxDB2\Model\Check$checkCheck 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\Check|\InfluxDB2\Model\Error|\InfluxDB2\Model\Error, HTTP status code, HTTP response headers (array of strings)

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