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\CreateDashboardRequest Class Reference
Inheritance diagram for InfluxDB2\Model\CreateDashboardRequest:
InfluxDB2\Model\ModelInterface InfluxDB2\Model\Dashboard InfluxDB2\Model\DashboardWithViewProperties

Public Member Functions

 getModelName ()
 
 __construct (array $data=null)
 
 listInvalidProperties ()
 
 valid ()
 
 getOrgId ()
 
 setOrgId ($org_id)
 
 getName ()
 
 setName ($name)
 
 getDescription ()
 
 setDescription ($description)
 
 offsetExists ($offset)
 
 offsetGet ($offset)
 
 offsetSet ($offset, $value)
 
 offsetUnset ($offset)
 
 __toString ()
 

Static Public Member Functions

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

Public Attributes

const DISCRIMINATOR = null
 

Protected Attributes

 $container = []
 

Static Protected Attributes

static $openAPIModelName = 'CreateDashboardRequest'
 
static $openAPITypes
 
static $openAPIFormats
 
static $attributeMap
 
static $setters
 
static $getters
 

Constructor & Destructor Documentation

◆ __construct()

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

Constructor

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

Reimplemented in InfluxDB2\Model\Dashboard, and InfluxDB2\Model\DashboardWithViewProperties.

Member Function Documentation

◆ __toString()

InfluxDB2\Model\CreateDashboardRequest::__toString ( )

Gets the string presentation of the object

Returns
string

Reimplemented in InfluxDB2\Model\Dashboard, and InfluxDB2\Model\DashboardWithViewProperties.

◆ attributeMap()

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

Array of attributes where the key is the local name, and the value is the original name

Returns
array

Implements InfluxDB2\Model\ModelInterface.

Reimplemented in InfluxDB2\Model\Dashboard, and InfluxDB2\Model\DashboardWithViewProperties.

◆ getDescription()

InfluxDB2\Model\CreateDashboardRequest::getDescription ( )

Gets description

Returns
string|null

◆ getModelName()

InfluxDB2\Model\CreateDashboardRequest::getModelName ( )

The original name of the model.

Returns
string

Implements InfluxDB2\Model\ModelInterface.

Reimplemented in InfluxDB2\Model\Dashboard, and InfluxDB2\Model\DashboardWithViewProperties.

◆ getName()

InfluxDB2\Model\CreateDashboardRequest::getName ( )

Gets name

Returns
string

◆ getOrgId()

InfluxDB2\Model\CreateDashboardRequest::getOrgId ( )

Gets org_id

Returns
string

◆ getters()

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

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

Returns
array

Implements InfluxDB2\Model\ModelInterface.

Reimplemented in InfluxDB2\Model\Dashboard, and InfluxDB2\Model\DashboardWithViewProperties.

◆ listInvalidProperties()

InfluxDB2\Model\CreateDashboardRequest::listInvalidProperties ( )

Show all the invalid properties with reasons.

Returns
array invalid properties with reasons

Implements InfluxDB2\Model\ModelInterface.

Reimplemented in InfluxDB2\Model\Dashboard, and InfluxDB2\Model\DashboardWithViewProperties.

◆ offsetExists()

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

Returns true if offset exists. False otherwise.

Parameters
integer$offsetOffset
Returns
boolean

Reimplemented in InfluxDB2\Model\Dashboard, and InfluxDB2\Model\DashboardWithViewProperties.

◆ offsetGet()

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

Gets offset.

Parameters
integer$offsetOffset
Returns
mixed

Reimplemented in InfluxDB2\Model\Dashboard, and InfluxDB2\Model\DashboardWithViewProperties.

◆ offsetSet()

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

Sets value based on offset.

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

Reimplemented in InfluxDB2\Model\Dashboard, and InfluxDB2\Model\DashboardWithViewProperties.

◆ offsetUnset()

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

Unsets offset.

Parameters
integer$offsetOffset
Returns
void

Reimplemented in InfluxDB2\Model\Dashboard, and InfluxDB2\Model\DashboardWithViewProperties.

◆ openAPIFormats()

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

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

Returns
array

Implements InfluxDB2\Model\ModelInterface.

Reimplemented in InfluxDB2\Model\Dashboard, and InfluxDB2\Model\DashboardWithViewProperties.

◆ openAPITypes()

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

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

Returns
array

Implements InfluxDB2\Model\ModelInterface.

Reimplemented in InfluxDB2\Model\Dashboard, and InfluxDB2\Model\DashboardWithViewProperties.

◆ setDescription()

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

Sets description

Parameters
string | null$descriptionThe user-facing description of the dashboard.
Returns
$this

◆ setName()

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

Sets name

Parameters
string$nameThe user-facing name of the dashboard.
Returns
$this

◆ setOrgId()

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

Sets org_id

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

◆ setters()

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

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

Returns
array

Implements InfluxDB2\Model\ModelInterface.

Reimplemented in InfluxDB2\Model\Dashboard, and InfluxDB2\Model\DashboardWithViewProperties.

◆ valid()

InfluxDB2\Model\CreateDashboardRequest::valid ( )

Validate all the properties in the model return true if all passed

Returns
bool True if all properties are valid

Implements InfluxDB2\Model\ModelInterface.

Reimplemented in InfluxDB2\Model\Dashboard, and InfluxDB2\Model\DashboardWithViewProperties.

Member Data Documentation

◆ $attributeMap

InfluxDB2\Model\CreateDashboardRequest::$attributeMap
staticprotected
Initial value:
= [
'org_id' => 'orgID',
'name' => 'name',
'description' => 'description'
]

◆ $getters

InfluxDB2\Model\CreateDashboardRequest::$getters
staticprotected
Initial value:
= [
'org_id' => 'getOrgId',
'name' => 'getName',
'description' => 'getDescription'
]

◆ $openAPIFormats

InfluxDB2\Model\CreateDashboardRequest::$openAPIFormats
staticprotected
Initial value:
= [
'org_id' => null,
'name' => null,
'description' => null
]

◆ $openAPITypes

InfluxDB2\Model\CreateDashboardRequest::$openAPITypes
staticprotected
Initial value:
= [
'org_id' => 'string',
'name' => 'string',
'description' => 'string'
]

◆ $setters

InfluxDB2\Model\CreateDashboardRequest::$setters
staticprotected
Initial value:
= [
'org_id' => 'setOrgId',
'name' => 'setName',
'description' => 'setDescription'
]

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