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\HTTPNotificationRuleBase Class Reference
Inheritance diagram for InfluxDB2\Model\HTTPNotificationRuleBase:
InfluxDB2\Model\NotificationRule InfluxDB2\Model\NotificationRuleDiscriminator InfluxDB2\Model\NotificationRuleBase InfluxDB2\Model\ModelInterface InfluxDB2\Model\HTTPNotificationRule

Public Member Functions

 getModelName ()
 
 getTypeAllowableValues ()
 
 __construct (array $data=null)
 
 listInvalidProperties ()
 
 valid ()
 
 getType ()
 
 setType ($type)
 
 getUrl ()
 
 setUrl ($url)
 
 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_HTTP = 'http'
 
- 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 = 'HTTPNotificationRuleBase'
 
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\HTTPNotificationRuleBase::__construct ( array $data = null)

Constructor

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

Reimplemented from InfluxDB2\Model\NotificationRule.

Reimplemented in InfluxDB2\Model\HTTPNotificationRule.

Member Function Documentation

◆ __toString()

InfluxDB2\Model\HTTPNotificationRuleBase::__toString ( )

Gets the string presentation of the object

Returns
string

Reimplemented from InfluxDB2\Model\NotificationRule.

Reimplemented in InfluxDB2\Model\HTTPNotificationRule.

◆ attributeMap()

static InfluxDB2\Model\HTTPNotificationRuleBase::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\HTTPNotificationRule.

◆ getModelName()

InfluxDB2\Model\HTTPNotificationRuleBase::getModelName ( )

The original name of the model.

Returns
string

Reimplemented from InfluxDB2\Model\NotificationRule.

Reimplemented in InfluxDB2\Model\HTTPNotificationRule.

◆ getters()

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

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

Returns
array

Reimplemented from InfluxDB2\Model\NotificationRule.

Reimplemented in InfluxDB2\Model\HTTPNotificationRule.

◆ getType()

InfluxDB2\Model\HTTPNotificationRuleBase::getType ( )

Gets type

Returns
string

◆ getTypeAllowableValues()

InfluxDB2\Model\HTTPNotificationRuleBase::getTypeAllowableValues ( )

Gets allowable values of the enum

Returns
string[]

◆ getUrl()

InfluxDB2\Model\HTTPNotificationRuleBase::getUrl ( )

Gets url

Returns
string|null

◆ listInvalidProperties()

InfluxDB2\Model\HTTPNotificationRuleBase::listInvalidProperties ( )

Show all the invalid properties with reasons.

Returns
array invalid properties with reasons

Reimplemented from InfluxDB2\Model\NotificationRule.

Reimplemented in InfluxDB2\Model\HTTPNotificationRule.

◆ offsetExists()

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

Returns true if offset exists. False otherwise.

Parameters
integer$offsetOffset
Returns
boolean

Reimplemented from InfluxDB2\Model\NotificationRule.

Reimplemented in InfluxDB2\Model\HTTPNotificationRule.

◆ offsetGet()

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

Gets offset.

Parameters
integer$offsetOffset
Returns
mixed

Reimplemented from InfluxDB2\Model\NotificationRule.

Reimplemented in InfluxDB2\Model\HTTPNotificationRule.

◆ offsetSet()

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

Sets value based on offset.

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

Reimplemented from InfluxDB2\Model\NotificationRule.

Reimplemented in InfluxDB2\Model\HTTPNotificationRule.

◆ offsetUnset()

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

Unsets offset.

Parameters
integer$offsetOffset
Returns
void

Reimplemented from InfluxDB2\Model\NotificationRule.

Reimplemented in InfluxDB2\Model\HTTPNotificationRule.

◆ openAPIFormats()

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

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

Returns
array

Reimplemented from InfluxDB2\Model\NotificationRule.

Reimplemented in InfluxDB2\Model\HTTPNotificationRule.

◆ openAPITypes()

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

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

Returns
array

Reimplemented from InfluxDB2\Model\NotificationRule.

Reimplemented in InfluxDB2\Model\HTTPNotificationRule.

◆ setters()

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

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

Returns
array

Reimplemented from InfluxDB2\Model\NotificationRule.

Reimplemented in InfluxDB2\Model\HTTPNotificationRule.

◆ setType()

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

Sets type

Parameters
string$typetype
Returns
$this

◆ setUrl()

InfluxDB2\Model\HTTPNotificationRuleBase::setUrl ( $url)

Sets url

Parameters
string | null$urlurl
Returns
$this

◆ valid()

InfluxDB2\Model\HTTPNotificationRuleBase::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\HTTPNotificationRule.

Member Data Documentation

◆ $attributeMap

InfluxDB2\Model\HTTPNotificationRuleBase::$attributeMap
staticprotected
Initial value:
= [
'type' => 'type',
'url' => 'url'
]

◆ $getters

InfluxDB2\Model\HTTPNotificationRuleBase::$getters
staticprotected
Initial value:
= [
'type' => 'getType',
'url' => 'getUrl'
]

◆ $openAPIFormats

InfluxDB2\Model\HTTPNotificationRuleBase::$openAPIFormats
staticprotected
Initial value:
= [
'type' => null,
'url' => null
]

◆ $openAPITypes

InfluxDB2\Model\HTTPNotificationRuleBase::$openAPITypes
staticprotected
Initial value:
= [
'type' => 'string',
'url' => 'string'
]

◆ $setters

InfluxDB2\Model\HTTPNotificationRuleBase::$setters
staticprotected
Initial value:
= [
'type' => 'setType',
'url' => 'setUrl'
]

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