InfluxDB2\Model\Axis Class Reference

Inheritance diagram for InfluxDB2\Model\Axis:

Public Member Functions
	getModelName ()
	getBaseAllowableValues ()
	__construct (array $data=null)
	listInvalidProperties ()
	valid ()
	getBounds ()
	setBounds ($bounds)
	getLabel ()
	setLabel ($label)
	getPrefix ()
	setPrefix ($prefix)
	getSuffix ()
	setSuffix ($suffix)
	getBase ()
	setBase ($base)
	getScale ()
	setScale ($scale)
	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	BASE_EMPTY = ''
const	BASE__2 = '2'
const	BASE__10 = '10'

Protected Attributes
	$container = []

Static Protected Attributes
static	$openAPIModelName = 'Axis'
static	$openAPITypes
static	$openAPIFormats
static	$attributeMap
static	$setters
static	$getters

Constructor & Destructor Documentation

__construct()

InfluxDB2\Model\Axis::__construct

(

array

$data = null

)

Constructor

Parameters

mixed[]

$data

Associated array of property values initializing the model

Member Function Documentation

__toString()

InfluxDB2\Model\Axis::__toString

(

)

Gets the string presentation of the object

Returns

string

attributeMap()

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

getBase()

InfluxDB2\Model\Axis::getBase

(

)

Gets base

Returns

string|null

getBaseAllowableValues()

InfluxDB2\Model\Axis::getBaseAllowableValues

(

)

Gets allowable values of the enum

Returns

string[]

getBounds()

InfluxDB2\Model\Axis::getBounds

(

)

Gets bounds

Returns

string[]|null

getLabel()

InfluxDB2\Model\Axis::getLabel

(

)

Gets label

Returns

string|null

getModelName()

InfluxDB2\Model\Axis::getModelName

(

)

The original name of the model.

Returns

string

Implements InfluxDB2\Model\ModelInterface.

getPrefix()

InfluxDB2\Model\Axis::getPrefix

(

)

Gets prefix

Returns

string|null

getScale()

InfluxDB2\Model\Axis::getScale

(

)

Gets scale

Returns

\InfluxDB2\Model\AxisScale|null

getSuffix()

InfluxDB2\Model\Axis::getSuffix

(

)

Gets suffix

Returns

string|null

getters()

static InfluxDB2\Model\Axis::getters ( )

static

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

Returns

array

Implements InfluxDB2\Model\ModelInterface.

listInvalidProperties()

InfluxDB2\Model\Axis::listInvalidProperties

(

)

Show all the invalid properties with reasons.

Returns

array invalid properties with reasons

Implements InfluxDB2\Model\ModelInterface.

offsetExists()

InfluxDB2\Model\Axis::offsetExists

(

$offset

)

Returns true if offset exists. False otherwise.

Parameters

integer

$offset

Offset

Returns

boolean

offsetGet()

InfluxDB2\Model\Axis::offsetGet

(

$offset

)

Gets offset.

Parameters

integer

$offset

Offset

Returns

mixed

offsetSet()

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

Sets value based on offset.

Parameters

integer	$offset	Offset
mixed	$value	Value to be set

Returns

void

offsetUnset()

InfluxDB2\Model\Axis::offsetUnset

(

$offset

)

Unsets offset.

Parameters

integer

$offset

Offset

Returns

void

openAPIFormats()

static InfluxDB2\Model\Axis::openAPIFormats ( )

static

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

Returns

array

Implements InfluxDB2\Model\ModelInterface.

openAPITypes()

static InfluxDB2\Model\Axis::openAPITypes ( )

static

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

Returns

array

Implements InfluxDB2\Model\ModelInterface.

setBase()

InfluxDB2\Model\Axis::setBase

(

$base

)

Sets base

Parameters

string | null

$base

Radix for formatting axis values.

Returns

$this

setBounds()

InfluxDB2\Model\Axis::setBounds

(

$bounds

)

Sets bounds

Parameters

string[] | null

$bounds

The extents of the axis in the form [lower, upper]. Clients determine whether bounds are inclusive or exclusive of their limits.

Returns

$this

setLabel()

InfluxDB2\Model\Axis::setLabel

(

$label

)

Sets label

Parameters

string | null

$label

Description of the axis.

Returns

$this

setPrefix()

InfluxDB2\Model\Axis::setPrefix

(

$prefix

)

Sets prefix

Parameters

string | null

$prefix

Label prefix for formatting axis values.

Returns

$this

setScale()

InfluxDB2\Model\Axis::setScale

(

$scale

)

Sets scale

Parameters

\InfluxDB2\Model\AxisScale | null

$scale

scale

Returns

$this

setSuffix()

InfluxDB2\Model\Axis::setSuffix

(

$suffix

)

Sets suffix

Parameters

string | null

$suffix

Label suffix for formatting axis values.

Returns

$this

setters()

static InfluxDB2\Model\Axis::setters ( )

static

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

Returns

array

Implements InfluxDB2\Model\ModelInterface.

valid()

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

Member Data Documentation

$attributeMap

InfluxDB2\Model\Axis::$attributeMap

staticprotected

Initial value:

= [
        'bounds' => 'bounds',
        'label' => 'label',
        'prefix' => 'prefix',
        'suffix' => 'suffix',
        'base' => 'base',
        'scale' => 'scale'
    ]

$getters

InfluxDB2\Model\Axis::$getters

staticprotected

Initial value:

= [
        'bounds' => 'getBounds',
        'label' => 'getLabel',
        'prefix' => 'getPrefix',
        'suffix' => 'getSuffix',
        'base' => 'getBase',
        'scale' => 'getScale'
    ]

$openAPIFormats

InfluxDB2\Model\Axis::$openAPIFormats

staticprotected

Initial value:

= [
        'bounds' => null,
        'label' => null,
        'prefix' => null,
        'suffix' => null,
        'base' => null,
        'scale' => null
    ]

$openAPITypes

InfluxDB2\Model\Axis::$openAPITypes

staticprotected

Initial value:

= [
        'bounds' => 'string[]',
        'label' => 'string',
        'prefix' => 'string',
        'suffix' => 'string',
        'base' => 'string',
        'scale' => '\InfluxDB2\Model\AxisScale'
    ]

$setters

InfluxDB2\Model\Axis::$setters

staticprotected

Initial value:

= [
        'bounds' => 'setBounds',
        'label' => 'setLabel',
        'prefix' => 'setPrefix',
        'suffix' => 'setSuffix',
        'base' => 'setBase',
        'scale' => 'setScale'
    ]

---

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

• src/InfluxDB2/Model/Axis.php