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\HTTPNotificationEndpoint Class Reference
Inheritance diagram for InfluxDB2\Model\HTTPNotificationEndpoint:
InfluxDB2\Model\NotificationEndpoint InfluxDB2\Model\NotificationEndpointDiscriminator InfluxDB2\Model\NotificationEndpointBase InfluxDB2\Model\ModelInterface

Public Member Functions

 getModelName ()
 
 getMethodAllowableValues ()
 
 getAuthMethodAllowableValues ()
 
 __construct (array $data=null)
 
 listInvalidProperties ()
 
 valid ()
 
 getUrl ()
 
 setUrl ($url)
 
 getUsername ()
 
 setUsername ($username)
 
 getPassword ()
 
 setPassword ($password)
 
 getToken ()
 
 setToken ($token)
 
 getMethod ()
 
 setMethod ($method)
 
 getAuthMethod ()
 
 setAuthMethod ($auth_method)
 
 getContentTemplate ()
 
 setContentTemplate ($content_template)
 
 getHeaders ()
 
 setHeaders ($headers)
 
 offsetExists ($offset)
 
 offsetGet ($offset)
 
 offsetSet ($offset, $value)
 
 offsetUnset ($offset)
 
 __toString ()
 
- Public Member Functions inherited from InfluxDB2\Model\NotificationEndpointBase
 getStatusAllowableValues ()
 
 getId ()
 
 setId ($id)
 
 getOrgId ()
 
 setOrgId ($org_id)
 
 getUserId ()
 
 setUserId ($user_id)
 
 getCreatedAt ()
 
 setCreatedAt ($created_at)
 
 getUpdatedAt ()
 
 setUpdatedAt ($updated_at)
 
 getDescription ()
 
 setDescription ($description)
 
 getName ()
 
 setName ($name)
 
 getStatus ()
 
 setStatus ($status)
 
 getLabels ()
 
 setLabels ($labels)
 
 getLinks ()
 
 setLinks ($links)
 
 getType ()
 
 setType ($type)
 

Static Public Member Functions

static openAPITypes ()
 
static openAPIFormats ()
 
static attributeMap ()
 
static setters ()
 
static getters ()
 

Public Attributes

const DISCRIMINATOR = null
 
const METHOD_POST = 'POST'
 
const METHOD_GET = 'GET'
 
const METHOD_PUT = 'PUT'
 
const AUTH_METHOD_NONE = 'none'
 
const AUTH_METHOD_BASIC = 'basic'
 
const AUTH_METHOD_BEARER = 'bearer'
 
- Public Attributes inherited from InfluxDB2\Model\NotificationEndpoint
const DISCRIMINATOR = 'type'
 
- Public Attributes inherited from InfluxDB2\Model\NotificationEndpointDiscriminator
const DISCRIMINATOR = 'type'
 
- Public Attributes inherited from InfluxDB2\Model\NotificationEndpointBase
const DISCRIMINATOR = null
 
const STATUS_ACTIVE = 'active'
 
const STATUS_INACTIVE = 'inactive'
 

Static Protected Attributes

static $openAPIModelName = 'HTTPNotificationEndpoint'
 
static $openAPITypes
 
static $openAPIFormats
 
static $attributeMap
 
static $setters
 
static $getters
 
- Static Protected Attributes inherited from InfluxDB2\Model\NotificationEndpoint
static $openAPIModelName = 'NotificationEndpoint'
 
static $openAPITypes
 
static $openAPIFormats
 
static $attributeMap
 
static $setters
 
static $getters
 
- Static Protected Attributes inherited from InfluxDB2\Model\NotificationEndpointDiscriminator
static $openAPIModelName = 'NotificationEndpointDiscriminator'
 
static $openAPITypes
 
static $openAPIFormats
 
static $attributeMap
 
static $setters
 
static $getters
 
- Static Protected Attributes inherited from InfluxDB2\Model\NotificationEndpointBase
static $openAPIModelName = 'NotificationEndpointBase'
 
static $openAPITypes
 
static $openAPIFormats
 
static $attributeMap
 
static $setters
 
static $getters
 

Additional Inherited Members

- Protected Attributes inherited from InfluxDB2\Model\NotificationEndpointBase
 $container = []
 

Constructor & Destructor Documentation

◆ __construct()

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

Constructor

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

Reimplemented from InfluxDB2\Model\NotificationEndpoint.

Member Function Documentation

◆ __toString()

InfluxDB2\Model\HTTPNotificationEndpoint::__toString ( )

Gets the string presentation of the object

Returns
string

Reimplemented from InfluxDB2\Model\NotificationEndpoint.

◆ attributeMap()

static InfluxDB2\Model\HTTPNotificationEndpoint::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\NotificationEndpoint.

◆ getAuthMethod()

InfluxDB2\Model\HTTPNotificationEndpoint::getAuthMethod ( )

Gets auth_method

Returns
string

◆ getAuthMethodAllowableValues()

InfluxDB2\Model\HTTPNotificationEndpoint::getAuthMethodAllowableValues ( )

Gets allowable values of the enum

Returns
string[]

◆ getContentTemplate()

InfluxDB2\Model\HTTPNotificationEndpoint::getContentTemplate ( )

Gets content_template

Returns
string|null

◆ getHeaders()

InfluxDB2\Model\HTTPNotificationEndpoint::getHeaders ( )

Gets headers

Returns
map[string,string]|null

◆ getMethod()

InfluxDB2\Model\HTTPNotificationEndpoint::getMethod ( )

Gets method

Returns
string

◆ getMethodAllowableValues()

InfluxDB2\Model\HTTPNotificationEndpoint::getMethodAllowableValues ( )

Gets allowable values of the enum

Returns
string[]

◆ getModelName()

InfluxDB2\Model\HTTPNotificationEndpoint::getModelName ( )

The original name of the model.

Returns
string

Reimplemented from InfluxDB2\Model\NotificationEndpoint.

◆ getPassword()

InfluxDB2\Model\HTTPNotificationEndpoint::getPassword ( )

Gets password

Returns
string|null

◆ getters()

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

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

Returns
array

Reimplemented from InfluxDB2\Model\NotificationEndpoint.

◆ getToken()

InfluxDB2\Model\HTTPNotificationEndpoint::getToken ( )

Gets token

Returns
string|null

◆ getUrl()

InfluxDB2\Model\HTTPNotificationEndpoint::getUrl ( )

Gets url

Returns
string

◆ getUsername()

InfluxDB2\Model\HTTPNotificationEndpoint::getUsername ( )

Gets username

Returns
string|null

◆ listInvalidProperties()

InfluxDB2\Model\HTTPNotificationEndpoint::listInvalidProperties ( )

Show all the invalid properties with reasons.

Returns
array invalid properties with reasons

Reimplemented from InfluxDB2\Model\NotificationEndpoint.

◆ offsetExists()

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

Returns true if offset exists. False otherwise.

Parameters
integer$offsetOffset
Returns
boolean

Reimplemented from InfluxDB2\Model\NotificationEndpoint.

◆ offsetGet()

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

Gets offset.

Parameters
integer$offsetOffset
Returns
mixed

Reimplemented from InfluxDB2\Model\NotificationEndpoint.

◆ offsetSet()

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

Sets value based on offset.

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

Reimplemented from InfluxDB2\Model\NotificationEndpoint.

◆ offsetUnset()

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

Unsets offset.

Parameters
integer$offsetOffset
Returns
void

Reimplemented from InfluxDB2\Model\NotificationEndpoint.

◆ openAPIFormats()

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

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

Returns
array

Reimplemented from InfluxDB2\Model\NotificationEndpoint.

◆ openAPITypes()

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

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

Returns
array

Reimplemented from InfluxDB2\Model\NotificationEndpoint.

◆ setAuthMethod()

InfluxDB2\Model\HTTPNotificationEndpoint::setAuthMethod ( $auth_method)

Sets auth_method

Parameters
string$auth_methodauth_method
Returns
$this

◆ setContentTemplate()

InfluxDB2\Model\HTTPNotificationEndpoint::setContentTemplate ( $content_template)

Sets content_template

Parameters
string | null$content_templatecontent_template
Returns
$this

◆ setHeaders()

InfluxDB2\Model\HTTPNotificationEndpoint::setHeaders ( $headers)

Sets headers

Parameters
map[string,string]|null$headers Customized headers.
Returns
$this

◆ setMethod()

InfluxDB2\Model\HTTPNotificationEndpoint::setMethod ( $method)

Sets method

Parameters
string$methodmethod
Returns
$this

◆ setPassword()

InfluxDB2\Model\HTTPNotificationEndpoint::setPassword ( $password)

Sets password

Parameters
string | null$passwordpassword
Returns
$this

◆ setters()

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

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

Returns
array

Reimplemented from InfluxDB2\Model\NotificationEndpoint.

◆ setToken()

InfluxDB2\Model\HTTPNotificationEndpoint::setToken ( $token)

Sets token

Parameters
string | null$tokentoken
Returns
$this

◆ setUrl()

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

Sets url

Parameters
string$urlurl
Returns
$this

◆ setUsername()

InfluxDB2\Model\HTTPNotificationEndpoint::setUsername ( $username)

Sets username

Parameters
string | null$usernameusername
Returns
$this

◆ valid()

InfluxDB2\Model\HTTPNotificationEndpoint::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\NotificationEndpoint.

Member Data Documentation

◆ $attributeMap

InfluxDB2\Model\HTTPNotificationEndpoint::$attributeMap
staticprotected
Initial value:
= [
'url' => 'url',
'username' => 'username',
'password' => 'password',
'token' => 'token',
'method' => 'method',
'auth_method' => 'authMethod',
'content_template' => 'contentTemplate',
'headers' => 'headers'
]

◆ $getters

InfluxDB2\Model\HTTPNotificationEndpoint::$getters
staticprotected
Initial value:
= [
'url' => 'getUrl',
'username' => 'getUsername',
'password' => 'getPassword',
'token' => 'getToken',
'method' => 'getMethod',
'auth_method' => 'getAuthMethod',
'content_template' => 'getContentTemplate',
'headers' => 'getHeaders'
]

◆ $openAPIFormats

InfluxDB2\Model\HTTPNotificationEndpoint::$openAPIFormats
staticprotected
Initial value:
= [
'url' => null,
'username' => null,
'password' => null,
'token' => null,
'method' => null,
'auth_method' => null,
'content_template' => null,
'headers' => null
]

◆ $openAPITypes

InfluxDB2\Model\HTTPNotificationEndpoint::$openAPITypes
staticprotected
Initial value:
= [
'url' => 'string',
'username' => 'string',
'password' => 'string',
'token' => 'string',
'method' => 'string',
'auth_method' => 'string',
'content_template' => 'string',
'headers' => 'map[string,string]'
]

◆ $setters

InfluxDB2\Model\HTTPNotificationEndpoint::$setters
staticprotected
Initial value:
= [
'url' => 'setUrl',
'username' => 'setUsername',
'password' => 'setPassword',
'token' => 'setToken',
'method' => 'setMethod',
'auth_method' => 'setAuthMethod',
'content_template' => 'setContentTemplate',
'headers' => 'setHeaders'
]

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