InfluxDB2\Model\Field Class Reference

Inheritance diagram for InfluxDB2\Model\Field:

Public Member Functions
	getModelName ()
	getTypeAllowableValues ()
	__construct (array $data=null)
	listInvalidProperties ()
	valid ()
	getValue ()
	setValue ($value)
	getType ()
	setType ($type)
	getAlias ()
	setAlias ($alias)
	getArgs ()
	setArgs ($args)
	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_FUNC = 'func'
const	TYPE_FIELD = 'field'
const	TYPE_INTEGER = 'integer'
const	TYPE_NUMBER = 'number'
const	TYPE_REGEX = 'regex'
const	TYPE_WILDCARD = 'wildcard'

Protected Attributes
	$container = []

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

Constructor & Destructor Documentation

__construct()

InfluxDB2\Model\Field::__construct

(

array

$data = null

)

Constructor

Parameters

mixed[]

$data

Associated array of property values initializing the model

Member Function Documentation

__toString()

InfluxDB2\Model\Field::__toString

(

)

Gets the string presentation of the object

Returns

string

attributeMap()

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

getAlias()

InfluxDB2\Model\Field::getAlias

(

)

Gets alias

Returns

string|null

getArgs()

InfluxDB2\Model\Field::getArgs

(

)

Gets args

Returns

\InfluxDB2\Model\Field[]|null

getModelName()

InfluxDB2\Model\Field::getModelName

(

)

The original name of the model.

Returns

string

Implements InfluxDB2\Model\ModelInterface.

getters()

static InfluxDB2\Model\Field::getters ( )

static

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

Returns

array

Implements InfluxDB2\Model\ModelInterface.

getType()

InfluxDB2\Model\Field::getType

(

)

Gets type

Returns

string|null

getTypeAllowableValues()

InfluxDB2\Model\Field::getTypeAllowableValues

(

)

Gets allowable values of the enum

Returns

string[]

getValue()

InfluxDB2\Model\Field::getValue

(

)

Gets value

Returns

string|null

listInvalidProperties()

InfluxDB2\Model\Field::listInvalidProperties

(

)

Show all the invalid properties with reasons.

Returns

array invalid properties with reasons

Implements InfluxDB2\Model\ModelInterface.

offsetExists()

InfluxDB2\Model\Field::offsetExists

(

$offset

)

Returns true if offset exists. False otherwise.

Parameters

integer

$offset

Offset

Returns

boolean

offsetGet()

InfluxDB2\Model\Field::offsetGet

(

$offset

)

Gets offset.

Parameters

integer

$offset

Offset

Returns

mixed

offsetSet()

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

Sets value based on offset.

Parameters

integer	$offset	Offset
mixed	$value	Value to be set

Returns

void

offsetUnset()

InfluxDB2\Model\Field::offsetUnset

(

$offset

)

Unsets offset.

Parameters

integer

$offset

Offset

Returns

void

openAPIFormats()

static InfluxDB2\Model\Field::openAPIFormats ( )

static

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

Returns

array

Implements InfluxDB2\Model\ModelInterface.

openAPITypes()

static InfluxDB2\Model\Field::openAPITypes ( )

static

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

Returns

array

Implements InfluxDB2\Model\ModelInterface.

setAlias()

InfluxDB2\Model\Field::setAlias

(

$alias

)

Sets alias

Parameters

string | null

$alias

Alias overrides the field name in the returned response. Applies only if type is func

Returns

$this

setArgs()

InfluxDB2\Model\Field::setArgs

(

$args

)

Sets args

Parameters

\InfluxDB2\Model\Field[] | null

$args

Args are the arguments to the function

Returns

$this

setters()

static InfluxDB2\Model\Field::setters ( )

static

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

Returns

array

Implements InfluxDB2\Model\ModelInterface.

setType()

InfluxDB2\Model\Field::setType

(

$type

)

Sets type

Parameters

string | null

$type

type describes the field type. func is a function. field is a field reference.

Returns

$this

setValue()

InfluxDB2\Model\Field::setValue

(

$value

)

Sets value

Parameters

string | null

$value

value is the value of the field. Meaning of the value is implied by the type key

Returns

$this

valid()

InfluxDB2\Model\Field::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\Field::$attributeMap

staticprotected

Initial value:

= [
        'value' => 'value',
        'type' => 'type',
        'alias' => 'alias',
        'args' => 'args'
    ]

$getters

InfluxDB2\Model\Field::$getters

staticprotected

Initial value:

= [
        'value' => 'getValue',
        'type' => 'getType',
        'alias' => 'getAlias',
        'args' => 'getArgs'
    ]

$openAPIFormats

InfluxDB2\Model\Field::$openAPIFormats

staticprotected

Initial value:

= [
        'value' => null,
        'type' => null,
        'alias' => null,
        'args' => null
    ]

$openAPITypes

InfluxDB2\Model\Field::$openAPITypes

staticprotected

Initial value:

= [
        'value' => 'string',
        'type' => 'string',
        'alias' => 'string',
        'args' => '\InfluxDB2\Model\Field[]'
    ]

$setters

InfluxDB2\Model\Field::$setters

staticprotected

Initial value:

= [
        'value' => 'setValue',
        'type' => 'setType',
        'alias' => 'setAlias',
        'args' => 'setArgs'
    ]

---

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

• src/InfluxDB2/Model/Field.php