InfluxDB2\Model\TelegramNotificationRuleBase Class Reference

Inheritance diagram for InfluxDB2\Model\TelegramNotificationRuleBase:

Public Member Functions
	getModelName ()
	getTypeAllowableValues ()
	getParseModeAllowableValues ()
	__construct (array $data=null)
	listInvalidProperties ()
	valid ()
	getType ()
	setType ($type)
	getMessageTemplate ()
	setMessageTemplate ($message_template)
	getParseMode ()
	setParseMode ($parse_mode)
	getDisableWebPagePreview ()
	setDisableWebPagePreview ($disable_web_page_preview)
	offsetExists ($offset)
	offsetGet ($offset)
	offsetSet ($offset, $value)
	offsetUnset ($offset)
	__toString ()
Public Member Functions inherited from InfluxDB2\Model\NotificationRuleBase
	getLastRunStatusAllowableValues ()
	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)

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

Public Attributes
const	DISCRIMINATOR = null
const	TYPE_TELEGRAM = 'telegram'
const	PARSE_MODE_MARKDOWN_V2 = 'MarkdownV2'
const	PARSE_MODE_HTML = 'HTML'
const	PARSE_MODE_MARKDOWN = 'Markdown'
Public Attributes inherited from InfluxDB2\Model\NotificationRule
const	DISCRIMINATOR = 'type'
Public Attributes inherited from InfluxDB2\Model\NotificationRuleDiscriminator
const	DISCRIMINATOR = 'type'
Public Attributes inherited from InfluxDB2\Model\NotificationRuleBase
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 = 'TelegramNotificationRuleBase'
static	$openAPITypes
static	$openAPIFormats
static	$attributeMap
static	$setters
static	$getters
Static Protected Attributes inherited from InfluxDB2\Model\NotificationRule
static	$openAPIModelName = 'NotificationRule'
static	$openAPITypes
static	$openAPIFormats
static	$attributeMap
static	$setters
static	$getters
Static Protected Attributes inherited from InfluxDB2\Model\NotificationRuleDiscriminator
static	$openAPIModelName = 'NotificationRuleDiscriminator'
static	$openAPITypes
static	$openAPIFormats
static	$attributeMap
static	$setters
static	$getters
Static Protected Attributes inherited from InfluxDB2\Model\NotificationRuleBase
static	$openAPIModelName = 'NotificationRuleBase'
static	$openAPITypes
static	$openAPIFormats
static	$attributeMap
static	$setters
static	$getters

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

Constructor & Destructor Documentation

__construct()

InfluxDB2\Model\TelegramNotificationRuleBase::__construct

(

array

$data = null

)

Constructor

Parameters

mixed[]

$data

Associated array of property values initializing the model

Reimplemented from InfluxDB2\Model\NotificationRule.

Reimplemented in InfluxDB2\Model\TelegramNotificationRule.

Member Function Documentation

__toString()

InfluxDB2\Model\TelegramNotificationRuleBase::__toString

(

)

Gets the string presentation of the object

Returns

string

Reimplemented from InfluxDB2\Model\NotificationRule.

Reimplemented in InfluxDB2\Model\TelegramNotificationRule.

attributeMap()

static InfluxDB2\Model\TelegramNotificationRuleBase::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\NotificationRule.

Reimplemented in InfluxDB2\Model\TelegramNotificationRule.

getDisableWebPagePreview()

InfluxDB2\Model\TelegramNotificationRuleBase::getDisableWebPagePreview

(

)

Gets disable_web_page_preview

Returns

bool|null

getMessageTemplate()

InfluxDB2\Model\TelegramNotificationRuleBase::getMessageTemplate

(

)

Gets message_template

Returns

string

getModelName()

InfluxDB2\Model\TelegramNotificationRuleBase::getModelName

(

)

The original name of the model.

Returns

string

Reimplemented from InfluxDB2\Model\NotificationRule.

Reimplemented in InfluxDB2\Model\TelegramNotificationRule.

getParseMode()

InfluxDB2\Model\TelegramNotificationRuleBase::getParseMode

(

)

Gets parse_mode

Returns

string|null

getParseModeAllowableValues()

InfluxDB2\Model\TelegramNotificationRuleBase::getParseModeAllowableValues

(

)

Gets allowable values of the enum

Returns

string[]

getters()

static InfluxDB2\Model\TelegramNotificationRuleBase::getters ( )

static

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

Returns

array

Reimplemented from InfluxDB2\Model\NotificationRule.

Reimplemented in InfluxDB2\Model\TelegramNotificationRule.

getType()

InfluxDB2\Model\TelegramNotificationRuleBase::getType

(

)

Gets type

Returns

string

getTypeAllowableValues()

InfluxDB2\Model\TelegramNotificationRuleBase::getTypeAllowableValues

(

)

Gets allowable values of the enum

Returns

string[]

listInvalidProperties()

InfluxDB2\Model\TelegramNotificationRuleBase::listInvalidProperties

(

)

Show all the invalid properties with reasons.

Returns

array invalid properties with reasons

Reimplemented from InfluxDB2\Model\NotificationRule.

Reimplemented in InfluxDB2\Model\TelegramNotificationRule.

offsetExists()

InfluxDB2\Model\TelegramNotificationRuleBase::offsetExists

(

$offset

)

Returns true if offset exists. False otherwise.

Parameters

integer

$offset

Offset

Returns

boolean

Reimplemented from InfluxDB2\Model\NotificationRule.

Reimplemented in InfluxDB2\Model\TelegramNotificationRule.

offsetGet()

InfluxDB2\Model\TelegramNotificationRuleBase::offsetGet

(

$offset

)

Gets offset.

Parameters

integer

$offset

Offset

Returns

mixed

Reimplemented from InfluxDB2\Model\NotificationRule.

Reimplemented in InfluxDB2\Model\TelegramNotificationRule.

offsetSet()

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

Sets value based on offset.

Parameters

integer	$offset	Offset
mixed	$value	Value to be set

Returns

void

Reimplemented from InfluxDB2\Model\NotificationRule.

Reimplemented in InfluxDB2\Model\TelegramNotificationRule.

offsetUnset()

InfluxDB2\Model\TelegramNotificationRuleBase::offsetUnset

(

$offset

)

Unsets offset.

Parameters

integer

$offset

Offset

Returns

void

Reimplemented from InfluxDB2\Model\NotificationRule.

Reimplemented in InfluxDB2\Model\TelegramNotificationRule.

openAPIFormats()

static InfluxDB2\Model\TelegramNotificationRuleBase::openAPIFormats ( )

static

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

Returns

array

Reimplemented from InfluxDB2\Model\NotificationRule.

Reimplemented in InfluxDB2\Model\TelegramNotificationRule.

openAPITypes()

static InfluxDB2\Model\TelegramNotificationRuleBase::openAPITypes ( )

static

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

Returns

array

Reimplemented from InfluxDB2\Model\NotificationRule.

Reimplemented in InfluxDB2\Model\TelegramNotificationRule.

setDisableWebPagePreview()

InfluxDB2\Model\TelegramNotificationRuleBase::setDisableWebPagePreview

(

$disable_web_page_preview

)

Sets disable_web_page_preview

Parameters

bool | null

$disable_web_page_preview

Disables preview of web links in the sent messages when "true". Defaults to "false".

Returns

$this

setMessageTemplate()

InfluxDB2\Model\TelegramNotificationRuleBase::setMessageTemplate

(

$message_template

)

Sets message_template

Parameters

string

$message_template

The message template as a flux interpolated string.

Returns

$this

setParseMode()

InfluxDB2\Model\TelegramNotificationRuleBase::setParseMode

(

$parse_mode

)

Sets parse_mode

Parameters

string | null

$parse_mode

Parse mode of the message text per https://core.telegram.org/bots/api#formatting-options. Defaults to "MarkdownV2".

Returns

$this

setters()

static InfluxDB2\Model\TelegramNotificationRuleBase::setters ( )

static

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

Returns

array

Reimplemented from InfluxDB2\Model\NotificationRule.

Reimplemented in InfluxDB2\Model\TelegramNotificationRule.

setType()

InfluxDB2\Model\TelegramNotificationRuleBase::setType

(

$type

)

Sets type

Parameters

string

$type

The discriminator between other types of notification rules is "telegram".

Returns

$this

valid()

InfluxDB2\Model\TelegramNotificationRuleBase::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\NotificationRule.

Reimplemented in InfluxDB2\Model\TelegramNotificationRule.

Member Data Documentation

$attributeMap

InfluxDB2\Model\TelegramNotificationRuleBase::$attributeMap

staticprotected

Initial value:

= [
        'type' => 'type',
        'message_template' => 'messageTemplate',
        'parse_mode' => 'parseMode',
        'disable_web_page_preview' => 'disableWebPagePreview'
    ]

$getters

InfluxDB2\Model\TelegramNotificationRuleBase::$getters

staticprotected

Initial value:

= [
        'type' => 'getType',
        'message_template' => 'getMessageTemplate',
        'parse_mode' => 'getParseMode',
        'disable_web_page_preview' => 'getDisableWebPagePreview'
    ]

$openAPIFormats

InfluxDB2\Model\TelegramNotificationRuleBase::$openAPIFormats

staticprotected

Initial value:

= [
        'type' => null,
        'message_template' => null,
        'parse_mode' => null,
        'disable_web_page_preview' => null
    ]

$openAPITypes

InfluxDB2\Model\TelegramNotificationRuleBase::$openAPITypes

staticprotected

Initial value:

= [
        'type' => 'string',
        'message_template' => 'string',
        'parse_mode' => 'string',
        'disable_web_page_preview' => 'bool'
    ]

$setters

InfluxDB2\Model\TelegramNotificationRuleBase::$setters

staticprotected

Initial value:

= [
        'type' => 'setType',
        'message_template' => 'setMessageTemplate',
        'parse_mode' => 'setParseMode',
        'disable_web_page_preview' => 'setDisableWebPagePreview'
    ]

---

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

• src/InfluxDB2/Model/TelegramNotificationRuleBase.php