InfluxDB PHP Client
Loading...
Searching...
No Matches
Public Member Functions | Static Public Member Functions | Public Attributes | Static Protected Attributes | List of all members
InfluxDB2\Model\ThresholdCheck Class Reference
Inheritance diagram for InfluxDB2\Model\ThresholdCheck:
InfluxDB2\Model\Check InfluxDB2\Model\CheckDiscriminator InfluxDB2\Model\CheckBase InfluxDB2\Model\ModelInterface

Public Member Functions

 getModelName ()
 
 getTypeAllowableValues ()
 
 __construct (array $data=null)
 
 listInvalidProperties ()
 
 valid ()
 
 getType ()
 
 setType ($type)
 
 getThresholds ()
 
 setThresholds ($thresholds)
 
 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_THRESHOLD = 'threshold'
 
- 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 = 'ThresholdCheck'
 
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\ThresholdCheck::__construct ( array $data = null)

Constructor

Parameters
mixed[]$dataAssociated array of property values initializing the model

Reimplemented from InfluxDB2\Model\Check.

Member Function Documentation

◆ __toString()

InfluxDB2\Model\ThresholdCheck::__toString ( )

Gets the string presentation of the object

Returns
string

Reimplemented from InfluxDB2\Model\Check.

◆ attributeMap()

static InfluxDB2\Model\ThresholdCheck::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\ThresholdCheck::getEvery ( )

Gets every

Returns
string|null

◆ getModelName()

InfluxDB2\Model\ThresholdCheck::getModelName ( )

The original name of the model.

Returns
string

Reimplemented from InfluxDB2\Model\Check.

◆ getOffset()

InfluxDB2\Model\ThresholdCheck::getOffset ( )

Gets offset

Returns
string|null

◆ getStatusMessageTemplate()

InfluxDB2\Model\ThresholdCheck::getStatusMessageTemplate ( )

Gets status_message_template

Returns
string|null

◆ getTags()

InfluxDB2\Model\ThresholdCheck::getTags ( )

Gets tags

Returns
\InfluxDB2\Model\ThresholdCheckTags[]|null

◆ getters()

static InfluxDB2\Model\ThresholdCheck::getters ( )
static

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

Returns
array

Reimplemented from InfluxDB2\Model\Check.

◆ getThresholds()

InfluxDB2\Model\ThresholdCheck::getThresholds ( )

Gets thresholds

Returns
\InfluxDB2\Model\Threshold[]|null

◆ getType()

InfluxDB2\Model\ThresholdCheck::getType ( )

Gets type

Returns
string

◆ getTypeAllowableValues()

InfluxDB2\Model\ThresholdCheck::getTypeAllowableValues ( )

Gets allowable values of the enum

Returns
string[]

◆ listInvalidProperties()

InfluxDB2\Model\ThresholdCheck::listInvalidProperties ( )

Show all the invalid properties with reasons.

Returns
array invalid properties with reasons

Reimplemented from InfluxDB2\Model\Check.

◆ offsetExists()

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

Returns true if offset exists. False otherwise.

Parameters
integer$offsetOffset
Returns
boolean

Reimplemented from InfluxDB2\Model\Check.

◆ offsetGet()

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

Gets offset.

Parameters
integer$offsetOffset
Returns
mixed

Reimplemented from InfluxDB2\Model\Check.

◆ offsetSet()

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

Sets value based on offset.

Parameters
integer$offsetOffset
mixed$valueValue to be set
Returns
void

Reimplemented from InfluxDB2\Model\Check.

◆ offsetUnset()

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

Unsets offset.

Parameters
integer$offsetOffset
Returns
void

Reimplemented from InfluxDB2\Model\Check.

◆ openAPIFormats()

static InfluxDB2\Model\ThresholdCheck::openAPIFormats ( )
static

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

Returns
array

Reimplemented from InfluxDB2\Model\Check.

◆ openAPITypes()

static InfluxDB2\Model\ThresholdCheck::openAPITypes ( )
static

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

Returns
array

Reimplemented from InfluxDB2\Model\Check.

◆ setEvery()

InfluxDB2\Model\ThresholdCheck::setEvery ( $every)

Sets every

Parameters
string | null$everyCheck repetition interval.
Returns
$this

◆ setOffset()

InfluxDB2\Model\ThresholdCheck::setOffset ( $offset)

Sets offset

Parameters
string | null$offsetDuration to delay after the schedule, before executing check.
Returns
$this

◆ setStatusMessageTemplate()

InfluxDB2\Model\ThresholdCheck::setStatusMessageTemplate ( $status_message_template)

Sets status_message_template

Parameters
string | null$status_message_templateThe template used to generate and write a status message.
Returns
$this

◆ setTags()

InfluxDB2\Model\ThresholdCheck::setTags ( $tags)

Sets tags

Parameters
\InfluxDB2\Model\ThresholdCheckTags[] | null$tagsList of tags to write to each status.
Returns
$this

◆ setters()

static InfluxDB2\Model\ThresholdCheck::setters ( )
static

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

Returns
array

Reimplemented from InfluxDB2\Model\Check.

◆ setThresholds()

InfluxDB2\Model\ThresholdCheck::setThresholds ( $thresholds)

Sets thresholds

Parameters
\InfluxDB2\Model\Threshold[] | null$thresholdsthresholds
Returns
$this

◆ setType()

InfluxDB2\Model\ThresholdCheck::setType ( $type)

Sets type

Parameters
string$typetype
Returns
$this

◆ valid()

InfluxDB2\Model\ThresholdCheck::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\ThresholdCheck::$attributeMap
staticprotected
Initial value:
= [
'type' => 'type',
'thresholds' => 'thresholds',
'every' => 'every',
'offset' => 'offset',
'tags' => 'tags',
'status_message_template' => 'statusMessageTemplate'
]

◆ $getters

InfluxDB2\Model\ThresholdCheck::$getters
staticprotected
Initial value:
= [
'type' => 'getType',
'thresholds' => 'getThresholds',
'every' => 'getEvery',
'offset' => 'getOffset',
'tags' => 'getTags',
'status_message_template' => 'getStatusMessageTemplate'
]

◆ $openAPIFormats

InfluxDB2\Model\ThresholdCheck::$openAPIFormats
staticprotected
Initial value:
= [
'type' => null,
'thresholds' => null,
'every' => null,
'offset' => null,
'tags' => null,
'status_message_template' => null
]

◆ $openAPITypes

InfluxDB2\Model\ThresholdCheck::$openAPITypes
staticprotected
Initial value:
= [
'type' => 'string',
'thresholds' => '\InfluxDB2\Model\Threshold[]',
'every' => 'string',
'offset' => 'string',
'tags' => '\InfluxDB2\Model\ThresholdCheckTags[]',
'status_message_template' => 'string'
]

◆ $setters

InfluxDB2\Model\ThresholdCheck::$setters
staticprotected
Initial value:
= [
'type' => 'setType',
'thresholds' => 'setThresholds',
'every' => 'setEvery',
'offset' => 'setOffset',
'tags' => 'setTags',
'status_message_template' => 'setStatusMessageTemplate'
]
The documentation for this class was generated from the following file:
Generated by doxygen 1.10.0