Public Member Functions
	__construct (DefaultApi $defaultApi)

	createCheck ($check)

	createCheckWithHttpInfo ($check)

	deleteChecksID ($check_id, $zap_trace_span=null)

	deleteChecksIDWithHttpInfo ($check_id, $zap_trace_span=null)

	deleteChecksIDLabelsID ($check_id, $label_id, $zap_trace_span=null)

	deleteChecksIDLabelsIDWithHttpInfo ($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)

	getChecksID ($check_id, $zap_trace_span=null)

	getChecksIDWithHttpInfo ($check_id, $zap_trace_span=null)

	getChecksIDLabels ($check_id, $zap_trace_span=null)

	getChecksIDLabelsWithHttpInfo ($check_id, $zap_trace_span=null)

	getChecksIDQuery ($check_id, $zap_trace_span=null)

	getChecksIDQueryWithHttpInfo ($check_id, $zap_trace_span=null)

	patchChecksID ($check_id, $check_patch, $zap_trace_span=null)

	patchChecksIDWithHttpInfo ($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)

	putChecksID ($check_id, $check, $zap_trace_span=null)

	putChecksIDWithHttpInfo ($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)

Protected Attributes
	$defaultApi

	$headerSelector

Constructor & Destructor Documentation

◆ __construct()

InfluxDB2\Service\ChecksService::__construct ( DefaultApi $defaultApi )

Parameters

DefaultApi	$defaultApi
HeaderSelector	$selector

Member Function Documentation

◆ createCheck()

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

Operation createCheck

Add new check

Parameters

\InfluxDB2\Model\Check $check Check to create (required)

Exceptions

InfluxDB2\ApiException on non-2xx response

Exceptions

InvalidArgumentException

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

◆ createCheckRequest()

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

protected

Create request for operation 'createCheck'

Parameters

\InfluxDB2\Model\Check $check Check to create (required)

Exceptions

InvalidArgumentException

Returns: \Psr\Http\Message\RequestInterface

◆ createCheckWithHttpInfo()

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

Operation createCheckWithHttpInfo

Add new check

Parameters

\InfluxDB2\Model\Check $check Check 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)

◆ deleteChecksID()

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

Operation deleteChecksID

Delete a check

Parameters

string	$check_id	The check ID. (required)
string	$zap_trace_span	OpenTracing span context (optional)

Exceptions

InfluxDB2\ApiException on non-2xx response

Exceptions

InvalidArgumentException

Returns: void

◆ deleteChecksIDLabelsID()

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

Operation deleteChecksIDLabelsID

Delete label from a check

Parameters

string	$check_id	The check ID. (required)
string	$label_id	The ID of the label to delete. (required)
string	$zap_trace_span	OpenTracing span context (optional)

Exceptions

InfluxDB2\ApiException on non-2xx response

Exceptions

InvalidArgumentException

Returns: void

◆ deleteChecksIDLabelsIDRequest()

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

protected

Create request for operation 'deleteChecksIDLabelsID'

Parameters

string	$check_id	The check ID. (required)
string	$label_id	The ID of the label to delete. (required)
string	$zap_trace_span	OpenTracing span context (optional)

Exceptions

InvalidArgumentException

Returns: \Psr\Http\Message\RequestInterface

◆ deleteChecksIDLabelsIDWithHttpInfo()

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

Operation deleteChecksIDLabelsIDWithHttpInfo

Delete label from a check

Parameters

string	$check_id	The check ID. (required)
string	$label_id	The ID of the label to delete. (required)
string	$zap_trace_span	OpenTracing 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_id	The check ID. (required)
string	$zap_trace_span	OpenTracing span context (optional)

Exceptions

InvalidArgumentException

Returns: \Psr\Http\Message\RequestInterface

◆ deleteChecksIDWithHttpInfo()

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

Operation deleteChecksIDWithHttpInfo

Delete a check

Parameters

string	$check_id	The check ID. (required)
string	$zap_trace_span	OpenTracing 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_id	Only show checks that belong to a specific organization ID. (required)
string	$zap_trace_span	OpenTracing span context (optional)
int	$offset	The offset for pagination. The number of records to skip. (optional)
int	$limit	Limits the number of records returned. Default is `20`. (optional, default to 20)

Exceptions

InfluxDB2\ApiException on non-2xx response

Exceptions

InvalidArgumentException

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

◆ getChecksID()

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

Operation getChecksID

Retrieve a check

Parameters

string	$check_id	The check ID. (required)
string	$zap_trace_span	OpenTracing span context (optional)

Exceptions

InfluxDB2\ApiException on non-2xx response

Exceptions

InvalidArgumentException

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

◆ getChecksIDLabels()

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

Operation getChecksIDLabels

List all labels for a check

Parameters

string	$check_id	The check ID. (required)
string	$zap_trace_span	OpenTracing span context (optional)

Exceptions

InfluxDB2\ApiException on non-2xx response

Exceptions

InvalidArgumentException

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

◆ getChecksIDLabelsRequest()

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

protected

Create request for operation 'getChecksIDLabels'

Parameters

string	$check_id	The check ID. (required)
string	$zap_trace_span	OpenTracing span context (optional)

Exceptions

InvalidArgumentException

Returns: \Psr\Http\Message\RequestInterface

◆ getChecksIDLabelsWithHttpInfo()

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

Operation getChecksIDLabelsWithHttpInfo

List all labels for a check

Parameters

string	$check_id	The check ID. (required)
string	$zap_trace_span	OpenTracing 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_id	The check ID. (required)
string	$zap_trace_span	OpenTracing 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

◆ getChecksIDQueryRequest()

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

protected

Create request for operation 'getChecksIDQuery'

Parameters

string	$check_id	The check ID. (required)
string	$zap_trace_span	OpenTracing span context (optional)

Exceptions

InvalidArgumentException

Returns: \Psr\Http\Message\RequestInterface

◆ getChecksIDQueryWithHttpInfo()

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

Operation getChecksIDQueryWithHttpInfo

Retrieve a check query

Parameters

string	$check_id	The check ID. (required)
string	$zap_trace_span	OpenTracing 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_id	The check ID. (required)
string	$zap_trace_span	OpenTracing span context (optional)

Exceptions

InvalidArgumentException

Returns: \Psr\Http\Message\RequestInterface

◆ getChecksIDWithHttpInfo()

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

Operation getChecksIDWithHttpInfo

Retrieve a check

Parameters

string	$check_id	The check ID. (required)
string	$zap_trace_span	OpenTracing 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_id	Only show checks that belong to a specific organization ID. (required)
string	$zap_trace_span	OpenTracing span context (optional)
int	$offset	The offset for pagination. The number of records to skip. (optional)
int	$limit	Limits the number of records returned. Default is `20`. (optional, default to 20)

Exceptions

InvalidArgumentException

Returns: \Psr\Http\Message\RequestInterface

◆ getChecksWithHttpInfo()

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

Operation getChecksWithHttpInfo

List all checks

Parameters

string	$org_id	Only show checks that belong to a specific organization ID. (required)
string	$zap_trace_span	OpenTracing span context (optional)
int	$offset	The offset for pagination. The number of records to skip. (optional)
int	$limit	Limits the number of records returned. Default is `20`. (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)

◆ patchChecksID()

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

Operation patchChecksID

Update a check

Parameters

string	$check_id	The check ID. (required)
\InfluxDB2\Model\CheckPatch	$check_patch	Check update to apply (required)
string	$zap_trace_span	OpenTracing span context (optional)

Exceptions

InfluxDB2\ApiException on non-2xx response

Exceptions

InvalidArgumentException

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

◆ patchChecksIDRequest()

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

protected

Create request for operation 'patchChecksID'

Parameters

string	$check_id	The check ID. (required)
\InfluxDB2\Model\CheckPatch	$check_patch	Check update to apply (required)
string	$zap_trace_span	OpenTracing span context (optional)

Exceptions

InvalidArgumentException

Returns: \Psr\Http\Message\RequestInterface

◆ patchChecksIDWithHttpInfo()

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

Operation patchChecksIDWithHttpInfo

Update a check

Parameters

string	$check_id	The check ID. (required)
\InfluxDB2\Model\CheckPatch	$check_patch	Check update to apply (required)
string	$zap_trace_span	OpenTracing 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_id	The check ID. (required)
\InfluxDB2\Model\LabelMapping	$label_mapping	Label to add (required)
string	$zap_trace_span	OpenTracing span context (optional)

Exceptions

InfluxDB2\ApiException on non-2xx response

Exceptions

InvalidArgumentException

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

◆ postChecksIDLabelsRequest()

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

protected

Create request for operation 'postChecksIDLabels'

Parameters

string	$check_id	The check ID. (required)
\InfluxDB2\Model\LabelMapping	$label_mapping	Label to add (required)
string	$zap_trace_span	OpenTracing span context (optional)

Exceptions

InvalidArgumentException

Returns: \Psr\Http\Message\RequestInterface

◆ postChecksIDLabelsWithHttpInfo()

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

Operation postChecksIDLabelsWithHttpInfo

Add a label to a check

Parameters

string	$check_id	The check ID. (required)
\InfluxDB2\Model\LabelMapping	$label_mapping	Label to add (required)
string	$zap_trace_span	OpenTracing 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_id	The check ID. (required)
\InfluxDB2\Model\Check	$check	Check update to apply (required)
string	$zap_trace_span	OpenTracing span context (optional)

Exceptions

InfluxDB2\ApiException on non-2xx response

Exceptions

InvalidArgumentException

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

◆ putChecksIDRequest()

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

protected

Create request for operation 'putChecksID'

Parameters

string	$check_id	The check ID. (required)
\InfluxDB2\Model\Check	$check	Check update to apply (required)
string	$zap_trace_span	OpenTracing span context (optional)

Exceptions

InvalidArgumentException

Returns: \Psr\Http\Message\RequestInterface

◆ putChecksIDWithHttpInfo()

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

Operation putChecksIDWithHttpInfo

Update a check

Parameters

string	$check_id	The check ID. (required)
\InfluxDB2\Model\Check	$check	Check update to apply (required)
string	$zap_trace_span	OpenTracing 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:

src/InfluxDB2/Service/ChecksService.php

Public Member Functions

Protected Member Functions

Protected Attributes

Constructor & Destructor Documentation

◆ __construct()

Member Function Documentation

◆ createCheck()

◆ createCheckRequest()

◆ createCheckWithHttpInfo()

◆ deleteChecksID()

◆ deleteChecksIDLabelsID()

◆ deleteChecksIDLabelsIDRequest()

◆ deleteChecksIDLabelsIDWithHttpInfo()

◆ deleteChecksIDRequest()

◆ deleteChecksIDWithHttpInfo()

◆ getChecks()

◆ getChecksID()

◆ getChecksIDLabels()

◆ getChecksIDLabelsRequest()

◆ getChecksIDLabelsWithHttpInfo()

◆ getChecksIDQuery()

◆ getChecksIDQueryRequest()

◆ getChecksIDQueryWithHttpInfo()

◆ getChecksIDRequest()

◆ getChecksIDWithHttpInfo()

◆ getChecksRequest()

◆ getChecksWithHttpInfo()

◆ patchChecksID()

◆ patchChecksIDRequest()

◆ patchChecksIDWithHttpInfo()

◆ postChecksIDLabels()

◆ postChecksIDLabelsRequest()

◆ postChecksIDLabelsWithHttpInfo()

◆ putChecksID()

◆ putChecksIDRequest()

◆ putChecksIDWithHttpInfo()