InfluxDB PHP Client
Loading...
Searching...
No Matches
Public Member Functions | Static Public Member Functions | Public Attributes | Protected Attributes | Static Protected Attributes | List of all members
InfluxDB2\Model\NotificationRuleBase Class Reference
Inheritance diagram for InfluxDB2\Model\NotificationRuleBase:
InfluxDB2\Model\ModelInterface InfluxDB2\Model\NotificationRuleDiscriminator InfluxDB2\Model\NotificationRule InfluxDB2\Model\HTTPNotificationRuleBase InfluxDB2\Model\PagerDutyNotificationRuleBase InfluxDB2\Model\SMTPNotificationRuleBase InfluxDB2\Model\SlackNotificationRuleBase InfluxDB2\Model\TelegramNotificationRuleBase InfluxDB2\Model\HTTPNotificationRule InfluxDB2\Model\PagerDutyNotificationRule InfluxDB2\Model\SMTPNotificationRule InfluxDB2\Model\SlackNotificationRule InfluxDB2\Model\TelegramNotificationRule

Public Member Functions

 getModelName ()
 
 getLastRunStatusAllowableValues ()
 
 __construct (array $data=null)
 
 listInvalidProperties ()
 
 valid ()
 
 getLatestCompleted ()
 
 setLatestCompleted ($latest_completed)
 
 getLastRunStatus ()
 
 setLastRunStatus ($last_run_status)
 
 getLastRunError ()
 
 setLastRunError ($last_run_error)
 
 getId ()
 
 setId ($id)
 
 getEndpointId ()
 
 setEndpointId ($endpoint_id)
 
 getOrgId ()
 
 setOrgId ($org_id)
 
 getTaskId ()
 
 setTaskId ($task_id)
 
 getOwnerId ()
 
 setOwnerId ($owner_id)
 
 getCreatedAt ()
 
 setCreatedAt ($created_at)
 
 getUpdatedAt ()
 
 setUpdatedAt ($updated_at)
 
 getStatus ()
 
 setStatus ($status)
 
 getName ()
 
 setName ($name)
 
 getSleepUntil ()
 
 setSleepUntil ($sleep_until)
 
 getEvery ()
 
 setEvery ($every)
 
 getOffset ()
 
 setOffset ($offset)
 
 getRunbookLink ()
 
 setRunbookLink ($runbook_link)
 
 getLimitEvery ()
 
 setLimitEvery ($limit_every)
 
 getLimit ()
 
 setLimit ($limit)
 
 getTagRules ()
 
 setTagRules ($tag_rules)
 
 getDescription ()
 
 setDescription ($description)
 
 getStatusRules ()
 
 setStatusRules ($status_rules)
 
 getLabels ()
 
 setLabels ($labels)
 
 getLinks ()
 
 setLinks ($links)
 
 offsetExists ($offset)
 
 offsetGet ($offset)
 
 offsetSet ($offset, $value)
 
 offsetUnset ($offset)
 
 __toString ()
 
 getModelName ()
 
 listInvalidProperties ()
 
 valid ()
 

Static Public Member Functions

static openAPITypes ()
 
static openAPIFormats ()
 
static attributeMap ()
 
static setters ()
 
static getters ()
 
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 = 'NotificationRuleBase'
 
static $openAPITypes
 
static $openAPIFormats
 
static $attributeMap
 
static $setters
 
static $getters
 

Constructor & Destructor Documentation

◆ __construct()

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

Member Function Documentation

◆ __toString()

InfluxDB2\Model\NotificationRuleBase::__toString ( )

◆ attributeMap()

static InfluxDB2\Model\NotificationRuleBase::attributeMap ( )
static

◆ getCreatedAt()

InfluxDB2\Model\NotificationRuleBase::getCreatedAt ( )

Gets created_at

Returns
\DateTime|null

◆ getDescription()

InfluxDB2\Model\NotificationRuleBase::getDescription ( )

Gets description

Returns
string|null

◆ getEndpointId()

InfluxDB2\Model\NotificationRuleBase::getEndpointId ( )

Gets endpoint_id

Returns
string

◆ getEvery()

InfluxDB2\Model\NotificationRuleBase::getEvery ( )

Gets every

Returns
string|null

◆ getId()

InfluxDB2\Model\NotificationRuleBase::getId ( )

Gets id

Returns
string|null

◆ getLabels()

InfluxDB2\Model\NotificationRuleBase::getLabels ( )

Gets labels

Returns
\InfluxDB2\Model\Label[]|null

◆ getLastRunError()

InfluxDB2\Model\NotificationRuleBase::getLastRunError ( )

Gets last_run_error

Returns
string|null

◆ getLastRunStatus()

InfluxDB2\Model\NotificationRuleBase::getLastRunStatus ( )

Gets last_run_status

Returns
string|null

◆ getLastRunStatusAllowableValues()

InfluxDB2\Model\NotificationRuleBase::getLastRunStatusAllowableValues ( )

Gets allowable values of the enum

Returns
string[]

◆ getLatestCompleted()

InfluxDB2\Model\NotificationRuleBase::getLatestCompleted ( )

Gets latest_completed

Returns
\DateTime|null

◆ getLimit()

InfluxDB2\Model\NotificationRuleBase::getLimit ( )

Gets limit

Returns
int|null

◆ getLimitEvery()

InfluxDB2\Model\NotificationRuleBase::getLimitEvery ( )

Gets limit_every

Returns
int|null

◆ getLinks()

InfluxDB2\Model\NotificationRuleBase::getLinks ( )

Gets links

Returns
\InfluxDB2\Model\NotificationRuleBaseLinks|null

◆ getModelName()

InfluxDB2\Model\NotificationRuleBase::getModelName ( )

◆ getName()

InfluxDB2\Model\NotificationRuleBase::getName ( )

Gets name

Returns
string

◆ getOffset()

InfluxDB2\Model\NotificationRuleBase::getOffset ( )

Gets offset

Returns
string|null

◆ getOrgId()

InfluxDB2\Model\NotificationRuleBase::getOrgId ( )

Gets org_id

Returns
string

◆ getOwnerId()

InfluxDB2\Model\NotificationRuleBase::getOwnerId ( )

Gets owner_id

Returns
string|null

◆ getRunbookLink()

InfluxDB2\Model\NotificationRuleBase::getRunbookLink ( )

Gets runbook_link

Returns
string|null

◆ getSleepUntil()

InfluxDB2\Model\NotificationRuleBase::getSleepUntil ( )

Gets sleep_until

Returns
string|null

◆ getStatus()

InfluxDB2\Model\NotificationRuleBase::getStatus ( )

Gets status

Returns
\InfluxDB2\Model\TaskStatusType

◆ getStatusRules()

InfluxDB2\Model\NotificationRuleBase::getStatusRules ( )

Gets status_rules

Returns
\InfluxDB2\Model\StatusRule[]

◆ getTagRules()

InfluxDB2\Model\NotificationRuleBase::getTagRules ( )

Gets tag_rules

Returns
\InfluxDB2\Model\TagRule[]|null

◆ getTaskId()

InfluxDB2\Model\NotificationRuleBase::getTaskId ( )

Gets task_id

Returns
string|null

◆ getters()

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

◆ getUpdatedAt()

InfluxDB2\Model\NotificationRuleBase::getUpdatedAt ( )

Gets updated_at

Returns
\DateTime|null

◆ listInvalidProperties()

InfluxDB2\Model\NotificationRuleBase::listInvalidProperties ( )

◆ offsetExists()

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

◆ offsetGet()

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

◆ offsetSet()

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

◆ offsetUnset()

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

◆ openAPIFormats()

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

◆ openAPITypes()

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

◆ setCreatedAt()

InfluxDB2\Model\NotificationRuleBase::setCreatedAt (   $created_at)

Sets created_at

Parameters
\DateTime | null$created_atcreated_at
Returns
$this

◆ setDescription()

InfluxDB2\Model\NotificationRuleBase::setDescription (   $description)

Sets description

Parameters
string | null$descriptionAn optional description of the notification rule.
Returns
$this

◆ setEndpointId()

InfluxDB2\Model\NotificationRuleBase::setEndpointId (   $endpoint_id)

Sets endpoint_id

Parameters
string$endpoint_idendpoint_id
Returns
$this

◆ setEvery()

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

Sets every

Parameters
string | null$everyThe notification repetition interval.
Returns
$this

◆ setId()

InfluxDB2\Model\NotificationRuleBase::setId (   $id)

Sets id

Parameters
string | null$idid
Returns
$this

◆ setLabels()

InfluxDB2\Model\NotificationRuleBase::setLabels (   $labels)

Sets labels

Parameters
\InfluxDB2\Model\Label[] | null$labelslabels
Returns
$this

◆ setLastRunError()

InfluxDB2\Model\NotificationRuleBase::setLastRunError (   $last_run_error)

Sets last_run_error

Parameters
string | null$last_run_errorlast_run_error
Returns
$this

◆ setLastRunStatus()

InfluxDB2\Model\NotificationRuleBase::setLastRunStatus (   $last_run_status)

Sets last_run_status

Parameters
string | null$last_run_statuslast_run_status
Returns
$this

◆ setLatestCompleted()

InfluxDB2\Model\NotificationRuleBase::setLatestCompleted (   $latest_completed)

Sets latest_completed

Parameters
\DateTime | null$latest_completedA timestamp (RFC3339 date/time format) of the latest scheduled and completed run.
Returns
$this

◆ setLimit()

InfluxDB2\Model\NotificationRuleBase::setLimit (   $limit)

Sets limit

Parameters
int | null$limitDon't notify me more than <limit> times every <limitEvery> seconds. If set, limitEvery cannot be empty.
Returns
$this

◆ setLimitEvery()

InfluxDB2\Model\NotificationRuleBase::setLimitEvery (   $limit_every)

Sets limit_every

Parameters
int | null$limit_everyDon't notify me more than <limit> times every <limitEvery> seconds. If set, limit cannot be empty.
Returns
$this

◆ setLinks()

InfluxDB2\Model\NotificationRuleBase::setLinks (   $links)

Sets links

Parameters
\InfluxDB2\Model\NotificationRuleBaseLinks | null$linkslinks
Returns
$this

◆ setName()

InfluxDB2\Model\NotificationRuleBase::setName (   $name)

Sets name

Parameters
string$nameHuman-readable name describing the notification rule.
Returns
$this

◆ setOffset()

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

Sets offset

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

◆ setOrgId()

InfluxDB2\Model\NotificationRuleBase::setOrgId (   $org_id)

Sets org_id

Parameters
string$org_idThe ID of the organization that owns this notification rule.
Returns
$this

◆ setOwnerId()

InfluxDB2\Model\NotificationRuleBase::setOwnerId (   $owner_id)

Sets owner_id

Parameters
string | null$owner_idThe ID of creator used to create this notification rule.
Returns
$this

◆ setRunbookLink()

InfluxDB2\Model\NotificationRuleBase::setRunbookLink (   $runbook_link)

Sets runbook_link

Parameters
string | null$runbook_linkrunbook_link
Returns
$this

◆ setSleepUntil()

InfluxDB2\Model\NotificationRuleBase::setSleepUntil (   $sleep_until)

Sets sleep_until

Parameters
string | null$sleep_untilsleep_until
Returns
$this

◆ setStatus()

InfluxDB2\Model\NotificationRuleBase::setStatus (   $status)

Sets status

Parameters
\InfluxDB2\Model\TaskStatusType$statusstatus
Returns
$this

◆ setStatusRules()

InfluxDB2\Model\NotificationRuleBase::setStatusRules (   $status_rules)

Sets status_rules

Parameters
\InfluxDB2\Model\StatusRule[]$status_rulesList of status rules the notification rule attempts to match.
Returns
$this

◆ setTagRules()

InfluxDB2\Model\NotificationRuleBase::setTagRules (   $tag_rules)

Sets tag_rules

Parameters
\InfluxDB2\Model\TagRule[] | null$tag_rulesList of tag rules the notification rule attempts to match.
Returns
$this

◆ setTaskId()

InfluxDB2\Model\NotificationRuleBase::setTaskId (   $task_id)

Sets task_id

Parameters
string | null$task_idThe ID of the task associated with this notification rule.
Returns
$this

◆ setters()

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

◆ setUpdatedAt()

InfluxDB2\Model\NotificationRuleBase::setUpdatedAt (   $updated_at)

Sets updated_at

Parameters
\DateTime | null$updated_atupdated_at
Returns
$this

◆ valid()

InfluxDB2\Model\NotificationRuleBase::valid ( )

Member Data Documentation

◆ $attributeMap

InfluxDB2\Model\NotificationRuleBase::$attributeMap
staticprotected
Initial value:
= [
'latest_completed' => 'latestCompleted',
'last_run_status' => 'lastRunStatus',
'last_run_error' => 'lastRunError',
'id' => 'id',
'endpoint_id' => 'endpointID',
'org_id' => 'orgID',
'task_id' => 'taskID',
'owner_id' => 'ownerID',
'created_at' => 'createdAt',
'updated_at' => 'updatedAt',
'status' => 'status',
'name' => 'name',
'sleep_until' => 'sleepUntil',
'every' => 'every',
'offset' => 'offset',
'runbook_link' => 'runbookLink',
'limit_every' => 'limitEvery',
'limit' => 'limit',
'tag_rules' => 'tagRules',
'description' => 'description',
'status_rules' => 'statusRules',
'labels' => 'labels',
'links' => 'links'
]

◆ $getters

InfluxDB2\Model\NotificationRuleBase::$getters
staticprotected
Initial value:
= [
'latest_completed' => 'getLatestCompleted',
'last_run_status' => 'getLastRunStatus',
'last_run_error' => 'getLastRunError',
'id' => 'getId',
'endpoint_id' => 'getEndpointId',
'org_id' => 'getOrgId',
'task_id' => 'getTaskId',
'owner_id' => 'getOwnerId',
'created_at' => 'getCreatedAt',
'updated_at' => 'getUpdatedAt',
'status' => 'getStatus',
'name' => 'getName',
'sleep_until' => 'getSleepUntil',
'every' => 'getEvery',
'offset' => 'getOffset',
'runbook_link' => 'getRunbookLink',
'limit_every' => 'getLimitEvery',
'limit' => 'getLimit',
'tag_rules' => 'getTagRules',
'description' => 'getDescription',
'status_rules' => 'getStatusRules',
'labels' => 'getLabels',
'links' => 'getLinks'
]

◆ $openAPIFormats

InfluxDB2\Model\NotificationRuleBase::$openAPIFormats
staticprotected
Initial value:
= [
'latest_completed' => 'date-time',
'last_run_status' => null,
'last_run_error' => null,
'id' => null,
'endpoint_id' => null,
'org_id' => null,
'task_id' => null,
'owner_id' => null,
'created_at' => 'date-time',
'updated_at' => 'date-time',
'status' => null,
'name' => null,
'sleep_until' => null,
'every' => null,
'offset' => null,
'runbook_link' => null,
'limit_every' => 'int32',
'limit' => 'int32',
'tag_rules' => null,
'description' => null,
'status_rules' => null,
'labels' => null,
'links' => null
]

◆ $openAPITypes

InfluxDB2\Model\NotificationRuleBase::$openAPITypes
staticprotected
Initial value:
= [
'latest_completed' => '\DateTime',
'last_run_status' => 'string',
'last_run_error' => 'string',
'id' => 'string',
'endpoint_id' => 'string',
'org_id' => 'string',
'task_id' => 'string',
'owner_id' => 'string',
'created_at' => '\DateTime',
'updated_at' => '\DateTime',
'status' => '\InfluxDB2\Model\TaskStatusType',
'name' => 'string',
'sleep_until' => 'string',
'every' => 'string',
'offset' => 'string',
'runbook_link' => 'string',
'limit_every' => 'int',
'limit' => 'int',
'tag_rules' => '\InfluxDB2\Model\TagRule[]',
'description' => 'string',
'status_rules' => '\InfluxDB2\Model\StatusRule[]',
'labels' => '\InfluxDB2\Model\Label[]',
'links' => '\InfluxDB2\Model\NotificationRuleBaseLinks'
]

◆ $setters

InfluxDB2\Model\NotificationRuleBase::$setters
staticprotected
Initial value:
= [
'latest_completed' => 'setLatestCompleted',
'last_run_status' => 'setLastRunStatus',
'last_run_error' => 'setLastRunError',
'id' => 'setId',
'endpoint_id' => 'setEndpointId',
'org_id' => 'setOrgId',
'task_id' => 'setTaskId',
'owner_id' => 'setOwnerId',
'created_at' => 'setCreatedAt',
'updated_at' => 'setUpdatedAt',
'status' => 'setStatus',
'name' => 'setName',
'sleep_until' => 'setSleepUntil',
'every' => 'setEvery',
'offset' => 'setOffset',
'runbook_link' => 'setRunbookLink',
'limit_every' => 'setLimitEvery',
'limit' => 'setLimit',
'tag_rules' => 'setTagRules',
'description' => 'setDescription',
'status_rules' => 'setStatusRules',
'labels' => 'setLabels',
'links' => 'setLinks'
]

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