InfluxDB2\Model\CheckBase Class Reference

Inheritance diagram for InfluxDB2\Model\CheckBase:

Public Member Functions
	getModelName ()
	getLastRunStatusAllowableValues ()
	__construct (?array $data=null)
	listInvalidProperties ()
	valid ()
	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)
	offsetExists ($offset)
	offsetGet ($offset)
	offsetSet ($offset, $value)
	offsetUnset ($offset)
	__toString ()

Static Public Member Functions
static	openAPITypes ()
static	openAPIFormats ()
static	attributeMap ()
static	setters ()
static	getters ()

Public Attributes
const	DISCRIMINATOR = null
const	LAST_RUN_STATUS_FAILED = 'failed'
const	LAST_RUN_STATUS_SUCCESS = 'success'
const	LAST_RUN_STATUS_CANCELED = 'canceled'

Protected Attributes
	$container = []

Static Protected Attributes
static	$openAPIModelName = 'CheckBase'
static	$openAPITypes
static	$openAPIFormats
static	$attributeMap
static	$setters
static	$getters

Constructor & Destructor Documentation

__construct()

InfluxDB2\Model\CheckBase::__construct

(

?array

$data = null

)

Constructor

Parameters

mixed[]

$data

Associated array of property values initializing the model

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

Member Function Documentation

__toString()

InfluxDB2\Model\CheckBase::__toString

(

)

Gets the string presentation of the object

Returns

string

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

attributeMap()

static InfluxDB2\Model\CheckBase::attributeMap ( )

static

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

Returns

array

Implements InfluxDB2\Model\ModelInterface.

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

getCreatedAt()

InfluxDB2\Model\CheckBase::getCreatedAt

(

)

Gets created_at

Returns

\DateTime|null

getDescription()

InfluxDB2\Model\CheckBase::getDescription

(

)

Gets description

Returns

string|null

getId()

InfluxDB2\Model\CheckBase::getId

(

)

Gets id

Returns

string|null

getLabels()

InfluxDB2\Model\CheckBase::getLabels

(

)

Gets labels

Returns

\InfluxDB2\Model\Label[]|null

getLastRunError()

InfluxDB2\Model\CheckBase::getLastRunError

(

)

Gets last_run_error

Returns

string|null

getLastRunStatus()

InfluxDB2\Model\CheckBase::getLastRunStatus

(

)

Gets last_run_status

Returns

string|null

getLastRunStatusAllowableValues()

InfluxDB2\Model\CheckBase::getLastRunStatusAllowableValues

(

)

Gets allowable values of the enum

Returns

string[]

getLatestCompleted()

InfluxDB2\Model\CheckBase::getLatestCompleted

(

)

Gets latest_completed

Returns

\DateTime|null

getLinks()

InfluxDB2\Model\CheckBase::getLinks

(

)

Gets links

Returns

\InfluxDB2\Model\CheckBaseLinks|null

getModelName()

InfluxDB2\Model\CheckBase::getModelName

(

)

The original name of the model.

Returns

string

Implements InfluxDB2\Model\ModelInterface.

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

getName()

InfluxDB2\Model\CheckBase::getName

(

)

Gets name

Returns

string

getOrgId()

InfluxDB2\Model\CheckBase::getOrgId

(

)

Gets org_id

Returns

string

getOwnerId()

InfluxDB2\Model\CheckBase::getOwnerId

(

)

Gets owner_id

Returns

string|null

getQuery()

InfluxDB2\Model\CheckBase::getQuery

(

)

Gets query

Returns

\InfluxDB2\Model\DashboardQuery

getStatus()

InfluxDB2\Model\CheckBase::getStatus

(

)

Gets status

Returns

\InfluxDB2\Model\TaskStatusType|null

getTaskId()

InfluxDB2\Model\CheckBase::getTaskId

(

)

Gets task_id

Returns

string|null

getters()

static InfluxDB2\Model\CheckBase::getters ( )

static

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

Returns

array

Implements InfluxDB2\Model\ModelInterface.

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

getUpdatedAt()

InfluxDB2\Model\CheckBase::getUpdatedAt

(

)

Gets updated_at

Returns

\DateTime|null

listInvalidProperties()

InfluxDB2\Model\CheckBase::listInvalidProperties

(

)

Show all the invalid properties with reasons.

Returns

array invalid properties with reasons

Implements InfluxDB2\Model\ModelInterface.

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

offsetExists()

InfluxDB2\Model\CheckBase::offsetExists

(

$offset

)

Returns true if offset exists. False otherwise.

Parameters

integer

$offset

Offset

Returns

boolean

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

offsetGet()

InfluxDB2\Model\CheckBase::offsetGet

(

$offset

)

Gets offset.

Parameters

integer

$offset

Offset

Returns

mixed

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

offsetSet()

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

Sets value based on offset.

Parameters

integer	$offset	Offset
mixed	$value	Value to be set

Returns

void

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

offsetUnset()

InfluxDB2\Model\CheckBase::offsetUnset

(

$offset

)

Unsets offset.

Parameters

integer

$offset

Offset

Returns

void

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

openAPIFormats()

static InfluxDB2\Model\CheckBase::openAPIFormats ( )

static

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

Returns

array

Implements InfluxDB2\Model\ModelInterface.

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

openAPITypes()

static InfluxDB2\Model\CheckBase::openAPITypes ( )

static

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

Returns

array

Implements InfluxDB2\Model\ModelInterface.

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

setCreatedAt()

InfluxDB2\Model\CheckBase::setCreatedAt

(

$created_at

)

Sets created_at

Parameters

\DateTime | null

$created_at

created_at

Returns

$this

setDescription()

InfluxDB2\Model\CheckBase::setDescription

(

$description

)

Sets description

Parameters

string | null

$description

An optional description of the check.

Returns

$this

setId()

InfluxDB2\Model\CheckBase::setId

(

$id

)

Sets id

Parameters

string | null

$id

id

Returns

$this

setLabels()

InfluxDB2\Model\CheckBase::setLabels

(

$labels

)

Sets labels

Parameters

\InfluxDB2\Model\Label[] | null

$labels

labels

Returns

$this

setLastRunError()

InfluxDB2\Model\CheckBase::setLastRunError

(

$last_run_error

)

Sets last_run_error

Parameters

string | null

$last_run_error

last_run_error

Returns

$this

setLastRunStatus()

InfluxDB2\Model\CheckBase::setLastRunStatus

(

$last_run_status

)

Sets last_run_status

Parameters

string | null

$last_run_status

last_run_status

Returns

$this

setLatestCompleted()

InfluxDB2\Model\CheckBase::setLatestCompleted

(

$latest_completed

)

Sets latest_completed

Parameters

\DateTime | null

$latest_completed

A timestamp (RFC3339 date/time format) of the latest scheduled and completed run.

Returns

$this

setLinks()

InfluxDB2\Model\CheckBase::setLinks

(

$links

)

Sets links

Parameters

\InfluxDB2\Model\CheckBaseLinks | null

$links

links

Returns

$this

setName()

InfluxDB2\Model\CheckBase::setName

(

$name

)

Sets name

Parameters

string

$name

name

Returns

$this

setOrgId()

InfluxDB2\Model\CheckBase::setOrgId

(

$org_id

)

Sets org_id

Parameters

string

$org_id

The ID of the organization that owns this check.

Returns

$this

setOwnerId()

InfluxDB2\Model\CheckBase::setOwnerId

(

$owner_id

)

Sets owner_id

Parameters

string | null

$owner_id

The ID of creator used to create this check.

Returns

$this

setQuery()

InfluxDB2\Model\CheckBase::setQuery

(

$query

)

Sets query

Parameters

\InfluxDB2\Model\DashboardQuery

$query

query

Returns

$this

setStatus()

InfluxDB2\Model\CheckBase::setStatus

(

$status

)

Sets status

Parameters

\InfluxDB2\Model\TaskStatusType | null

$status

status

Returns

$this

setTaskId()

InfluxDB2\Model\CheckBase::setTaskId

(

$task_id

)

Sets task_id

Parameters

string | null

$task_id

The ID of the task associated with this check.

Returns

$this

setters()

static InfluxDB2\Model\CheckBase::setters ( )

static

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

Returns

array

Implements InfluxDB2\Model\ModelInterface.

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

setUpdatedAt()

InfluxDB2\Model\CheckBase::setUpdatedAt

(

$updated_at

)

Sets updated_at

Parameters

\DateTime | null

$updated_at

updated_at

Returns

$this

valid()

InfluxDB2\Model\CheckBase::valid

(

)

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

Returns

bool True if all properties are valid

Implements InfluxDB2\Model\ModelInterface.

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

Member Data Documentation

$attributeMap

InfluxDB2\Model\CheckBase::$attributeMap

staticprotected

Initial value:

= [
        'id' => 'id',
        'name' => 'name',
        'org_id' => 'orgID',
        'task_id' => 'taskID',
        'owner_id' => 'ownerID',
        'created_at' => 'createdAt',
        'updated_at' => 'updatedAt',
        'query' => 'query',
        'status' => 'status',
        'description' => 'description',
        'latest_completed' => 'latestCompleted',
        'last_run_status' => 'lastRunStatus',
        'last_run_error' => 'lastRunError',
        'labels' => 'labels',
        'links' => 'links'
    ]

$getters

InfluxDB2\Model\CheckBase::$getters

staticprotected

Initial value:

= [
        'id' => 'getId',
        'name' => 'getName',
        'org_id' => 'getOrgId',
        'task_id' => 'getTaskId',
        'owner_id' => 'getOwnerId',
        'created_at' => 'getCreatedAt',
        'updated_at' => 'getUpdatedAt',
        'query' => 'getQuery',
        'status' => 'getStatus',
        'description' => 'getDescription',
        'latest_completed' => 'getLatestCompleted',
        'last_run_status' => 'getLastRunStatus',
        'last_run_error' => 'getLastRunError',
        'labels' => 'getLabels',
        'links' => 'getLinks'
    ]

$openAPIFormats

InfluxDB2\Model\CheckBase::$openAPIFormats

staticprotected

Initial value:

= [
        'id' => null,
        'name' => null,
        'org_id' => null,
        'task_id' => null,
        'owner_id' => null,
        'created_at' => 'date-time',
        'updated_at' => 'date-time',
        'query' => null,
        'status' => null,
        'description' => null,
        'latest_completed' => 'date-time',
        'last_run_status' => null,
        'last_run_error' => null,
        'labels' => null,
        'links' => null
    ]

$openAPITypes

InfluxDB2\Model\CheckBase::$openAPITypes

staticprotected

Initial value:

= [
        'id' => 'string',
        'name' => 'string',
        'org_id' => 'string',
        'task_id' => 'string',
        'owner_id' => 'string',
        'created_at' => '\DateTime',
        'updated_at' => '\DateTime',
        'query' => '\InfluxDB2\Model\DashboardQuery',
        'status' => '\InfluxDB2\Model\TaskStatusType',
        'description' => 'string',
        'latest_completed' => '\DateTime',
        'last_run_status' => 'string',
        'last_run_error' => 'string',
        'labels' => '\InfluxDB2\Model\Label[]',
        'links' => '\InfluxDB2\Model\CheckBaseLinks'
    ]

$setters

InfluxDB2\Model\CheckBase::$setters

staticprotected

Initial value:

= [
        'id' => 'setId',
        'name' => 'setName',
        'org_id' => 'setOrgId',
        'task_id' => 'setTaskId',
        'owner_id' => 'setOwnerId',
        'created_at' => 'setCreatedAt',
        'updated_at' => 'setUpdatedAt',
        'query' => 'setQuery',
        'status' => 'setStatus',
        'description' => 'setDescription',
        'latest_completed' => 'setLatestCompleted',
        'last_run_status' => 'setLastRunStatus',
        'last_run_error' => 'setLastRunError',
        'labels' => 'setLabels',
        'links' => 'setLinks'
    ]

---

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

• src/InfluxDB2/Model/CheckBase.php