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\GaugeViewProperties Class Reference
Inheritance diagram for InfluxDB2\Model\GaugeViewProperties:
InfluxDB2\Model\ViewProperties InfluxDB2\Model\ModelInterface

Public Member Functions

 getModelName ()
 
 getTypeAllowableValues ()
 
 getShapeAllowableValues ()
 
 __construct (array $data=null)
 
 listInvalidProperties ()
 
 valid ()
 
 getType ()
 
 setType ($type)
 
 getQueries ()
 
 setQueries ($queries)
 
 getColors ()
 
 setColors ($colors)
 
 getShape ()
 
 setShape ($shape)
 
 getNote ()
 
 setNote ($note)
 
 getShowNoteWhenEmpty ()
 
 setShowNoteWhenEmpty ($show_note_when_empty)
 
 getPrefix ()
 
 setPrefix ($prefix)
 
 getTickPrefix ()
 
 setTickPrefix ($tick_prefix)
 
 getSuffix ()
 
 setSuffix ($suffix)
 
 getTickSuffix ()
 
 setTickSuffix ($tick_suffix)
 
 getDecimalPlaces ()
 
 setDecimalPlaces ($decimal_places)
 
 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
 
const TYPE_GAUGE = 'gauge'
 
const SHAPE_CHRONOGRAF_V2 = 'chronograf-v2'
 
- Public Attributes inherited from InfluxDB2\Model\ViewProperties
const DISCRIMINATOR = null
 

Static Protected Attributes

static $openAPIModelName = 'GaugeViewProperties'
 
static $openAPITypes
 
static $openAPIFormats
 
static $attributeMap
 
static $setters
 
static $getters
 
- Static Protected Attributes inherited from InfluxDB2\Model\ViewProperties
static $openAPIModelName = 'ViewProperties'
 
static $openAPITypes
 
static $openAPIFormats
 
static $attributeMap
 
static $setters
 
static $getters
 

Additional Inherited Members

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

Constructor & Destructor Documentation

◆ __construct()

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

Constructor

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

Reimplemented from InfluxDB2\Model\ViewProperties.

Member Function Documentation

◆ __toString()

InfluxDB2\Model\GaugeViewProperties::__toString ( )

Gets the string presentation of the object

Returns
string

Reimplemented from InfluxDB2\Model\ViewProperties.

◆ attributeMap()

static InfluxDB2\Model\GaugeViewProperties::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\ViewProperties.

◆ getColors()

InfluxDB2\Model\GaugeViewProperties::getColors ( )

Gets colors

Returns
\InfluxDB2\Model\DashboardColor[]

◆ getDecimalPlaces()

InfluxDB2\Model\GaugeViewProperties::getDecimalPlaces ( )

Gets decimal_places

Returns
\InfluxDB2\Model\DecimalPlaces

◆ getModelName()

InfluxDB2\Model\GaugeViewProperties::getModelName ( )

The original name of the model.

Returns
string

Reimplemented from InfluxDB2\Model\ViewProperties.

◆ getNote()

InfluxDB2\Model\GaugeViewProperties::getNote ( )

Gets note

Returns
string

◆ getPrefix()

InfluxDB2\Model\GaugeViewProperties::getPrefix ( )

Gets prefix

Returns
string

◆ getQueries()

InfluxDB2\Model\GaugeViewProperties::getQueries ( )

Gets queries

Returns
\InfluxDB2\Model\DashboardQuery[]

◆ getShape()

InfluxDB2\Model\GaugeViewProperties::getShape ( )

Gets shape

Returns
string

◆ getShapeAllowableValues()

InfluxDB2\Model\GaugeViewProperties::getShapeAllowableValues ( )

Gets allowable values of the enum

Returns
string[]

◆ getShowNoteWhenEmpty()

InfluxDB2\Model\GaugeViewProperties::getShowNoteWhenEmpty ( )

Gets show_note_when_empty

Returns
bool

◆ getSuffix()

InfluxDB2\Model\GaugeViewProperties::getSuffix ( )

Gets suffix

Returns
string

◆ getters()

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

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

Returns
array

Reimplemented from InfluxDB2\Model\ViewProperties.

◆ getTickPrefix()

InfluxDB2\Model\GaugeViewProperties::getTickPrefix ( )

Gets tick_prefix

Returns
string

◆ getTickSuffix()

InfluxDB2\Model\GaugeViewProperties::getTickSuffix ( )

Gets tick_suffix

Returns
string

◆ getType()

InfluxDB2\Model\GaugeViewProperties::getType ( )

Gets type

Returns
string

◆ getTypeAllowableValues()

InfluxDB2\Model\GaugeViewProperties::getTypeAllowableValues ( )

Gets allowable values of the enum

Returns
string[]

◆ listInvalidProperties()

InfluxDB2\Model\GaugeViewProperties::listInvalidProperties ( )

Show all the invalid properties with reasons.

Returns
array invalid properties with reasons

Reimplemented from InfluxDB2\Model\ViewProperties.

◆ offsetExists()

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

Returns true if offset exists. False otherwise.

Parameters
integer$offsetOffset
Returns
boolean

Reimplemented from InfluxDB2\Model\ViewProperties.

◆ offsetGet()

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

Gets offset.

Parameters
integer$offsetOffset
Returns
mixed

Reimplemented from InfluxDB2\Model\ViewProperties.

◆ offsetSet()

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

Sets value based on offset.

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

Reimplemented from InfluxDB2\Model\ViewProperties.

◆ offsetUnset()

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

Unsets offset.

Parameters
integer$offsetOffset
Returns
void

Reimplemented from InfluxDB2\Model\ViewProperties.

◆ openAPIFormats()

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

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

Returns
array

Reimplemented from InfluxDB2\Model\ViewProperties.

◆ openAPITypes()

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

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

Returns
array

Reimplemented from InfluxDB2\Model\ViewProperties.

◆ setColors()

InfluxDB2\Model\GaugeViewProperties::setColors ( $colors)

Sets colors

Parameters
\InfluxDB2\Model\DashboardColor[]$colorsColors define color encoding of data into a visualization
Returns
$this

◆ setDecimalPlaces()

InfluxDB2\Model\GaugeViewProperties::setDecimalPlaces ( $decimal_places)

Sets decimal_places

Parameters
\InfluxDB2\Model\DecimalPlaces$decimal_placesdecimal_places
Returns
$this

◆ setNote()

InfluxDB2\Model\GaugeViewProperties::setNote ( $note)

Sets note

Parameters
string$notenote
Returns
$this

◆ setPrefix()

InfluxDB2\Model\GaugeViewProperties::setPrefix ( $prefix)

Sets prefix

Parameters
string$prefixprefix
Returns
$this

◆ setQueries()

InfluxDB2\Model\GaugeViewProperties::setQueries ( $queries)

Sets queries

Parameters
\InfluxDB2\Model\DashboardQuery[]$queriesqueries
Returns
$this

◆ setShape()

InfluxDB2\Model\GaugeViewProperties::setShape ( $shape)

Sets shape

Parameters
string$shapeshape
Returns
$this

◆ setShowNoteWhenEmpty()

InfluxDB2\Model\GaugeViewProperties::setShowNoteWhenEmpty ( $show_note_when_empty)

Sets show_note_when_empty

Parameters
bool$show_note_when_emptyIf true, will display note when empty
Returns
$this

◆ setSuffix()

InfluxDB2\Model\GaugeViewProperties::setSuffix ( $suffix)

Sets suffix

Parameters
string$suffixsuffix
Returns
$this

◆ setters()

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

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

Returns
array

Reimplemented from InfluxDB2\Model\ViewProperties.

◆ setTickPrefix()

InfluxDB2\Model\GaugeViewProperties::setTickPrefix ( $tick_prefix)

Sets tick_prefix

Parameters
string$tick_prefixtick_prefix
Returns
$this

◆ setTickSuffix()

InfluxDB2\Model\GaugeViewProperties::setTickSuffix ( $tick_suffix)

Sets tick_suffix

Parameters
string$tick_suffixtick_suffix
Returns
$this

◆ setType()

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

Sets type

Parameters
string$typetype
Returns
$this

◆ valid()

InfluxDB2\Model\GaugeViewProperties::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\ViewProperties.

Member Data Documentation

◆ $attributeMap

InfluxDB2\Model\GaugeViewProperties::$attributeMap
staticprotected
Initial value:
= [
'type' => 'type',
'queries' => 'queries',
'colors' => 'colors',
'shape' => 'shape',
'note' => 'note',
'show_note_when_empty' => 'showNoteWhenEmpty',
'prefix' => 'prefix',
'tick_prefix' => 'tickPrefix',
'suffix' => 'suffix',
'tick_suffix' => 'tickSuffix',
'decimal_places' => 'decimalPlaces'
]

◆ $getters

InfluxDB2\Model\GaugeViewProperties::$getters
staticprotected
Initial value:
= [
'type' => 'getType',
'queries' => 'getQueries',
'colors' => 'getColors',
'shape' => 'getShape',
'note' => 'getNote',
'show_note_when_empty' => 'getShowNoteWhenEmpty',
'prefix' => 'getPrefix',
'tick_prefix' => 'getTickPrefix',
'suffix' => 'getSuffix',
'tick_suffix' => 'getTickSuffix',
'decimal_places' => 'getDecimalPlaces'
]

◆ $openAPIFormats

InfluxDB2\Model\GaugeViewProperties::$openAPIFormats
staticprotected
Initial value:
= [
'type' => null,
'queries' => null,
'colors' => null,
'shape' => null,
'note' => null,
'show_note_when_empty' => null,
'prefix' => null,
'tick_prefix' => null,
'suffix' => null,
'tick_suffix' => null,
'decimal_places' => null
]

◆ $openAPITypes

InfluxDB2\Model\GaugeViewProperties::$openAPITypes
staticprotected
Initial value:
= [
'type' => 'string',
'queries' => '\InfluxDB2\Model\DashboardQuery[]',
'colors' => '\InfluxDB2\Model\DashboardColor[]',
'shape' => 'string',
'note' => 'string',
'show_note_when_empty' => 'bool',
'prefix' => 'string',
'tick_prefix' => 'string',
'suffix' => 'string',
'tick_suffix' => 'string',
'decimal_places' => '\InfluxDB2\Model\DecimalPlaces'
]

◆ $setters

InfluxDB2\Model\GaugeViewProperties::$setters
staticprotected
Initial value:
= [
'type' => 'setType',
'queries' => 'setQueries',
'colors' => 'setColors',
'shape' => 'setShape',
'note' => 'setNote',
'show_note_when_empty' => 'setShowNoteWhenEmpty',
'prefix' => 'setPrefix',
'tick_prefix' => 'setTickPrefix',
'suffix' => 'setSuffix',
'tick_suffix' => 'setTickSuffix',
'decimal_places' => 'setDecimalPlaces'
]

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