InfluxDB PHP Client: InfluxDB2\Model\Check Class Reference

InfluxDB PHP Client

Loading...

Searching...

No Matches

Inheritance diagram for InfluxDB2\Model\Check:

Public Member Functions
	getModelName ()

	__construct (array $data=null)

	listInvalidProperties ()

	valid ()

	offsetExists ($offset)

	offsetGet ($offset)

	offsetSet ($offset, $value)

	offsetUnset ($offset)

	__toString ()

Public Member Functions inherited from InfluxDB2\Model\CheckBase
	getLastRunStatusAllowableValues ()

	getId ()

	setId ($id)

	getName ()

	setName ($name)

	getOrgId ()

	setOrgId ($org_id)

	getTaskId ()

	setTaskId ($task_id)

	getOwnerId ()

	setOwnerId ($owner_id)

	getCreatedAt ()

	setCreatedAt ($created_at)

	getUpdatedAt ()

	setUpdatedAt ($updated_at)

	getQuery ()

	setQuery ($query)

	getStatus ()

	setStatus ($status)

	getDescription ()

	setDescription ($description)

	getLatestCompleted ()

	setLatestCompleted ($latest_completed)

	getLastRunStatus ()

	setLastRunStatus ($last_run_status)

	getLastRunError ()

	setLastRunError ($last_run_error)

	getLabels ()

	setLabels ($labels)

	getLinks ()

	setLinks ($links)

Static Public Member Functions
static	openAPITypes ()

static	openAPIFormats ()

static	attributeMap ()

static	setters ()

static	getters ()

Public Attributes
const	DISCRIMINATOR = 'type'

Public Attributes inherited from InfluxDB2\Model\CheckDiscriminator
const	DISCRIMINATOR = 'type'

Public Attributes inherited from InfluxDB2\Model\CheckBase
const	DISCRIMINATOR = null

const	LAST_RUN_STATUS_FAILED = 'failed'

const	LAST_RUN_STATUS_SUCCESS = 'success'

const	LAST_RUN_STATUS_CANCELED = 'canceled'

Static Protected Attributes
static	$openAPIModelName = 'Check'

static	$openAPITypes

static	$openAPIFormats

static	$attributeMap

static	$setters

static	$getters

Static Protected Attributes inherited from InfluxDB2\Model\CheckDiscriminator
static	$openAPIModelName = 'CheckDiscriminator'

static	$openAPITypes

static	$openAPIFormats

static	$attributeMap

static	$setters

static	$getters

Static Protected Attributes inherited from InfluxDB2\Model\CheckBase
static	$openAPIModelName = 'CheckBase'

static	$openAPITypes

static	$openAPIFormats

static	$attributeMap

static	$setters

static	$getters

Additional Inherited Members
Protected Attributes inherited from InfluxDB2\Model\CheckBase
	$container = []

Constructor & Destructor Documentation

◆ __construct()

InfluxDB2\Model\Check::__construct ( array $data = null )

Constructor

Parameters

mixed[] $data Associated array of property values initializing the model

Reimplemented from InfluxDB2\Model\CheckDiscriminator.

Reimplemented in InfluxDB2\Model\CustomCheck, InfluxDB2\Model\DeadmanCheck, and InfluxDB2\Model\ThresholdCheck.

Member Function Documentation

◆ __toString()

InfluxDB2\Model\Check::__toString ( )

Gets the string presentation of the object

Returns: string

Reimplemented from InfluxDB2\Model\CheckDiscriminator.

Reimplemented in InfluxDB2\Model\CustomCheck, InfluxDB2\Model\DeadmanCheck, and InfluxDB2\Model\ThresholdCheck.

◆ attributeMap()

static InfluxDB2\Model\Check::attributeMap ( )

static

Array of attributes where the key is the local name, and the value is the original name

Returns: array

Reimplemented from InfluxDB2\Model\CheckDiscriminator.

Reimplemented in InfluxDB2\Model\CustomCheck, InfluxDB2\Model\DeadmanCheck, and InfluxDB2\Model\ThresholdCheck.

◆ getModelName()

InfluxDB2\Model\Check::getModelName ( )

The original name of the model.

Returns: string

Reimplemented from InfluxDB2\Model\CheckDiscriminator.

Reimplemented in InfluxDB2\Model\CustomCheck, InfluxDB2\Model\DeadmanCheck, and InfluxDB2\Model\ThresholdCheck.

◆ getters()

static InfluxDB2\Model\Check::getters ( )

static

Array of attributes to getter functions (for serialization of requests)

Returns: array

Reimplemented from InfluxDB2\Model\CheckDiscriminator.

Reimplemented in InfluxDB2\Model\CustomCheck, InfluxDB2\Model\DeadmanCheck, and InfluxDB2\Model\ThresholdCheck.

◆ listInvalidProperties()

InfluxDB2\Model\Check::listInvalidProperties ( )

Show all the invalid properties with reasons.

Returns: array invalid properties with reasons

Reimplemented from InfluxDB2\Model\CheckDiscriminator.

Reimplemented in InfluxDB2\Model\CustomCheck, InfluxDB2\Model\DeadmanCheck, and InfluxDB2\Model\ThresholdCheck.

◆ offsetExists()

InfluxDB2\Model\Check::offsetExists ( $offset )

Returns true if offset exists. False otherwise.

Parameters

integer $offset Offset

Returns: boolean

Reimplemented from InfluxDB2\Model\CheckDiscriminator.

Reimplemented in InfluxDB2\Model\CustomCheck, InfluxDB2\Model\DeadmanCheck, and InfluxDB2\Model\ThresholdCheck.

◆ offsetGet()

InfluxDB2\Model\Check::offsetGet ( $offset )

Gets offset.

Parameters

integer $offset Offset

Returns: mixed

Reimplemented from InfluxDB2\Model\CheckDiscriminator.

Reimplemented in InfluxDB2\Model\CustomCheck, InfluxDB2\Model\DeadmanCheck, and InfluxDB2\Model\ThresholdCheck.

◆ offsetSet()

InfluxDB2\Model\Check::offsetSet	(		$offset,
			$value )

Sets value based on offset.

Parameters

integer	$offset	Offset
mixed	$value	Value to be set

Returns: void

Reimplemented from InfluxDB2\Model\CheckDiscriminator.

Reimplemented in InfluxDB2\Model\CustomCheck, InfluxDB2\Model\DeadmanCheck, and InfluxDB2\Model\ThresholdCheck.

◆ offsetUnset()

InfluxDB2\Model\Check::offsetUnset ( $offset )

Unsets offset.

Parameters

integer $offset Offset

Returns: void

Reimplemented from InfluxDB2\Model\CheckDiscriminator.

Reimplemented in InfluxDB2\Model\CustomCheck, InfluxDB2\Model\DeadmanCheck, and InfluxDB2\Model\ThresholdCheck.

◆ openAPIFormats()

static InfluxDB2\Model\Check::openAPIFormats ( )

static

Array of property to format mappings. Used for (de)serialization

Returns: array

Reimplemented from InfluxDB2\Model\CheckDiscriminator.

Reimplemented in InfluxDB2\Model\CustomCheck, InfluxDB2\Model\DeadmanCheck, and InfluxDB2\Model\ThresholdCheck.

◆ openAPITypes()

static InfluxDB2\Model\Check::openAPITypes ( )

static

Array of property to type mappings. Used for (de)serialization

Returns: array

Reimplemented from InfluxDB2\Model\CheckDiscriminator.

Reimplemented in InfluxDB2\Model\CustomCheck, InfluxDB2\Model\DeadmanCheck, and InfluxDB2\Model\ThresholdCheck.

◆ setters()

static InfluxDB2\Model\Check::setters ( )

static

Array of attributes to setter functions (for deserialization of responses)

Returns: array

Reimplemented from InfluxDB2\Model\CheckDiscriminator.

Reimplemented in InfluxDB2\Model\CustomCheck, InfluxDB2\Model\DeadmanCheck, and InfluxDB2\Model\ThresholdCheck.

◆ valid()

InfluxDB2\Model\Check::valid ( )

Validate all the properties in the model return true if all passed

Returns: bool True if all properties are valid

Reimplemented from InfluxDB2\Model\CheckDiscriminator.

Reimplemented in InfluxDB2\Model\CustomCheck, InfluxDB2\Model\DeadmanCheck, and InfluxDB2\Model\ThresholdCheck.

Member Data Documentation

◆ $attributeMap

InfluxDB2\Model\Check::$attributeMap

staticprotected

Initial value:

= [
        
    ]

◆ $getters

InfluxDB2\Model\Check::$getters

staticprotected

Initial value:

= [
        
    ]

◆ $openAPIFormats

InfluxDB2\Model\Check::$openAPIFormats

staticprotected

Initial value:

= [
        
    ]

◆ $openAPITypes

InfluxDB2\Model\Check::$openAPITypes

staticprotected

Initial value:

= [
        
    ]

◆ $setters

InfluxDB2\Model\Check::$setters

staticprotected

Initial value:

= [
        
    ]

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

src/InfluxDB2/Model/Check.php