InfluxDB2\Model\DeadmanCheck Class Reference

Inheritance diagram for InfluxDB2\Model\DeadmanCheck:

Public Member Functions
	getModelName ()
	getTypeAllowableValues ()
	__construct (array $data=null)
	listInvalidProperties ()
	valid ()
	getType ()
	setType ($type)
	getTimeSince ()
	setTimeSince ($time_since)
	getStaleTime ()
	setStaleTime ($stale_time)
	getReportZero ()
	setReportZero ($report_zero)
	getLevel ()
	setLevel ($level)
	getEvery ()
	setEvery ($every)
	getOffset ()
	setOffset ($offset)
	getTags ()
	setTags ($tags)
	getStatusMessageTemplate ()
	setStatusMessageTemplate ($status_message_template)
	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 = null
const	TYPE_DEADMAN = 'deadman'
Public Attributes inherited from InfluxDB2\Model\Check
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 = 'DeadmanCheck'
static	$openAPITypes
static	$openAPIFormats
static	$attributeMap
static	$setters
static	$getters
Static Protected Attributes inherited from InfluxDB2\Model\Check
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\DeadmanCheck::__construct

(

array

$data = null

)

Constructor

Parameters

mixed[]

$data

Associated array of property values initializing the model

Reimplemented from InfluxDB2\Model\Check.

Member Function Documentation

__toString()

InfluxDB2\Model\DeadmanCheck::__toString

(

)

Gets the string presentation of the object

Returns

string

Reimplemented from InfluxDB2\Model\Check.

attributeMap()

static InfluxDB2\Model\DeadmanCheck::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\Check.

getEvery()

InfluxDB2\Model\DeadmanCheck::getEvery

(

)

Gets every

Returns

string|null

getLevel()

InfluxDB2\Model\DeadmanCheck::getLevel

(

)

Gets level

Returns

\InfluxDB2\Model\CheckStatusLevel|null

getModelName()

InfluxDB2\Model\DeadmanCheck::getModelName

(

)

The original name of the model.

Returns

string

Reimplemented from InfluxDB2\Model\Check.

getOffset()

InfluxDB2\Model\DeadmanCheck::getOffset

(

)

Gets offset

Returns

string|null

getReportZero()

InfluxDB2\Model\DeadmanCheck::getReportZero

(

)

Gets report_zero

Returns

bool|null

getStaleTime()

InfluxDB2\Model\DeadmanCheck::getStaleTime

(

)

Gets stale_time

Returns

string|null

getStatusMessageTemplate()

InfluxDB2\Model\DeadmanCheck::getStatusMessageTemplate

(

)

Gets status_message_template

Returns

string|null

getTags()

InfluxDB2\Model\DeadmanCheck::getTags

(

)

Gets tags

Returns

\InfluxDB2\Model\ThresholdCheckTags[]|null

getters()

static InfluxDB2\Model\DeadmanCheck::getters ( )

static

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

Returns

array

Reimplemented from InfluxDB2\Model\Check.

getTimeSince()

InfluxDB2\Model\DeadmanCheck::getTimeSince

(

)

Gets time_since

Returns

string|null

getType()

InfluxDB2\Model\DeadmanCheck::getType

(

)

Gets type

Returns

string

getTypeAllowableValues()

InfluxDB2\Model\DeadmanCheck::getTypeAllowableValues

(

)

Gets allowable values of the enum

Returns

string[]

listInvalidProperties()

InfluxDB2\Model\DeadmanCheck::listInvalidProperties

(

)

Show all the invalid properties with reasons.

Returns

array invalid properties with reasons

Reimplemented from InfluxDB2\Model\Check.

offsetExists()

InfluxDB2\Model\DeadmanCheck::offsetExists

(

$offset

)

Returns true if offset exists. False otherwise.

Parameters

integer

$offset

Offset

Returns

boolean

Reimplemented from InfluxDB2\Model\Check.

offsetGet()

InfluxDB2\Model\DeadmanCheck::offsetGet

(

$offset

)

Gets offset.

Parameters

integer

$offset

Offset

Returns

mixed

Reimplemented from InfluxDB2\Model\Check.

offsetSet()

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

Sets value based on offset.

Parameters

integer	$offset	Offset
mixed	$value	Value to be set

Returns

void

Reimplemented from InfluxDB2\Model\Check.

offsetUnset()

InfluxDB2\Model\DeadmanCheck::offsetUnset

(

$offset

)

Unsets offset.

Parameters

integer

$offset

Offset

Returns

void

Reimplemented from InfluxDB2\Model\Check.

openAPIFormats()

static InfluxDB2\Model\DeadmanCheck::openAPIFormats ( )

static

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

Returns

array

Reimplemented from InfluxDB2\Model\Check.

openAPITypes()

static InfluxDB2\Model\DeadmanCheck::openAPITypes ( )

static

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

Returns

array

Reimplemented from InfluxDB2\Model\Check.

setEvery()

InfluxDB2\Model\DeadmanCheck::setEvery

(

$every

)

Sets every

Parameters

string | null

$every

Check repetition interval.

Returns

$this

setLevel()

InfluxDB2\Model\DeadmanCheck::setLevel

(

$level

)

Sets level

Parameters

\InfluxDB2\Model\CheckStatusLevel | null

$level

level

Returns

$this

setOffset()

InfluxDB2\Model\DeadmanCheck::setOffset

(

$offset

)

Sets offset

Parameters

string | null

$offset

Duration to delay after the schedule, before executing check.

Returns

$this

setReportZero()

InfluxDB2\Model\DeadmanCheck::setReportZero

(

$report_zero

)

Sets report_zero

Parameters

bool | null

$report_zero

If only zero values reported since time, trigger an alert

Returns

$this

setStaleTime()

InfluxDB2\Model\DeadmanCheck::setStaleTime

(

$stale_time

)

Sets stale_time

Parameters

string | null

$stale_time

String duration for time that a series is considered stale and should not trigger deadman.

Returns

$this

setStatusMessageTemplate()

InfluxDB2\Model\DeadmanCheck::setStatusMessageTemplate

(

$status_message_template

)

Sets status_message_template

Parameters

string | null

$status_message_template

The template used to generate and write a status message.

Returns

$this

setTags()

InfluxDB2\Model\DeadmanCheck::setTags

(

$tags

)

Sets tags

Parameters

\InfluxDB2\Model\ThresholdCheckTags[] | null

$tags

List of tags to write to each status.

Returns

$this

setters()

static InfluxDB2\Model\DeadmanCheck::setters ( )

static

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

Returns

array

Reimplemented from InfluxDB2\Model\Check.

setTimeSince()

InfluxDB2\Model\DeadmanCheck::setTimeSince

(

$time_since

)

Sets time_since

Parameters

string | null

$time_since

String duration before deadman triggers.

Returns

$this

setType()

InfluxDB2\Model\DeadmanCheck::setType

(

$type

)

Sets type

Parameters

string

$type

type

Returns

$this

valid()

InfluxDB2\Model\DeadmanCheck::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\Check.

Member Data Documentation

$attributeMap

InfluxDB2\Model\DeadmanCheck::$attributeMap

staticprotected

Initial value:

= [
        'type' => 'type',
        'time_since' => 'timeSince',
        'stale_time' => 'staleTime',
        'report_zero' => 'reportZero',
        'level' => 'level',
        'every' => 'every',
        'offset' => 'offset',
        'tags' => 'tags',
        'status_message_template' => 'statusMessageTemplate'
    ]

$getters

InfluxDB2\Model\DeadmanCheck::$getters

staticprotected

Initial value:

= [
        'type' => 'getType',
        'time_since' => 'getTimeSince',
        'stale_time' => 'getStaleTime',
        'report_zero' => 'getReportZero',
        'level' => 'getLevel',
        'every' => 'getEvery',
        'offset' => 'getOffset',
        'tags' => 'getTags',
        'status_message_template' => 'getStatusMessageTemplate'
    ]

$openAPIFormats

InfluxDB2\Model\DeadmanCheck::$openAPIFormats

staticprotected

Initial value:

= [
        'type' => null,
        'time_since' => null,
        'stale_time' => null,
        'report_zero' => null,
        'level' => null,
        'every' => null,
        'offset' => null,
        'tags' => null,
        'status_message_template' => null
    ]

$openAPITypes

InfluxDB2\Model\DeadmanCheck::$openAPITypes

staticprotected

Initial value:

= [
        'type' => 'string',
        'time_since' => 'string',
        'stale_time' => 'string',
        'report_zero' => 'bool',
        'level' => '\InfluxDB2\Model\CheckStatusLevel',
        'every' => 'string',
        'offset' => 'string',
        'tags' => '\InfluxDB2\Model\ThresholdCheckTags[]',
        'status_message_template' => 'string'
    ]

$setters

InfluxDB2\Model\DeadmanCheck::$setters

staticprotected

Initial value:

= [
        'type' => 'setType',
        'time_since' => 'setTimeSince',
        'stale_time' => 'setStaleTime',
        'report_zero' => 'setReportZero',
        'level' => 'setLevel',
        'every' => 'setEvery',
        'offset' => 'setOffset',
        'tags' => 'setTags',
        'status_message_template' => 'setStatusMessageTemplate'
    ]

---

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

• src/InfluxDB2/Model/DeadmanCheck.php