InfluxDB2\Model\Query Class Reference

Inheritance diagram for InfluxDB2\Model\Query:

Public Member Functions
	getModelName ()
	getTypeAllowableValues ()
	__construct (array $data=null)
	listInvalidProperties ()
	valid ()
	getExtern ()
	setExtern ($extern)
	getQuery ()
	setQuery ($query)
	getType ()
	setType ($type)
	getParams ()
	setParams ($params)
	getDialect ()
	setDialect ($dialect)
	getNow ()
	setNow ($now)
	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_FLUX = 'flux'

Protected Attributes
	$container = []

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

Constructor & Destructor Documentation

__construct()

InfluxDB2\Model\Query::__construct

(

array

$data = null

)

Constructor

Parameters

mixed[]

$data

Associated array of property values initializing the model

Member Function Documentation

__toString()

InfluxDB2\Model\Query::__toString

(

)

Gets the string presentation of the object

Returns

string

attributeMap()

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

getDialect()

InfluxDB2\Model\Query::getDialect

(

)

Gets dialect

Returns

\InfluxDB2\Model\Dialect|null

getExtern()

InfluxDB2\Model\Query::getExtern

(

)

Gets extern

Returns

\InfluxDB2\Model\File|null

getModelName()

InfluxDB2\Model\Query::getModelName

(

)

The original name of the model.

Returns

string

Implements InfluxDB2\Model\ModelInterface.

getNow()

InfluxDB2\Model\Query::getNow

(

)

Gets now

Returns

\DateTime|null

getParams()

InfluxDB2\Model\Query::getParams

(

)

Gets params

Returns

map[string,object]|null

getQuery()

InfluxDB2\Model\Query::getQuery

(

)

Gets query

Returns

string

getters()

static InfluxDB2\Model\Query::getters ( )

static

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

Returns

array

Implements InfluxDB2\Model\ModelInterface.

getType()

InfluxDB2\Model\Query::getType

(

)

Gets type

Returns

string|null

getTypeAllowableValues()

InfluxDB2\Model\Query::getTypeAllowableValues

(

)

Gets allowable values of the enum

Returns

string[]

listInvalidProperties()

InfluxDB2\Model\Query::listInvalidProperties

(

)

Show all the invalid properties with reasons.

Returns

array invalid properties with reasons

Implements InfluxDB2\Model\ModelInterface.

offsetExists()

InfluxDB2\Model\Query::offsetExists

(

$offset

)

Returns true if offset exists. False otherwise.

Parameters

integer

$offset

Offset

Returns

boolean

offsetGet()

InfluxDB2\Model\Query::offsetGet

(

$offset

)

Gets offset.

Parameters

integer

$offset

Offset

Returns

mixed

offsetSet()

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

Sets value based on offset.

Parameters

integer	$offset	Offset
mixed	$value	Value to be set

Returns

void

offsetUnset()

InfluxDB2\Model\Query::offsetUnset

(

$offset

)

Unsets offset.

Parameters

integer

$offset

Offset

Returns

void

openAPIFormats()

static InfluxDB2\Model\Query::openAPIFormats ( )

static

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

Returns

array

Implements InfluxDB2\Model\ModelInterface.

openAPITypes()

static InfluxDB2\Model\Query::openAPITypes ( )

static

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

Returns

array

Implements InfluxDB2\Model\ModelInterface.

setDialect()

InfluxDB2\Model\Query::setDialect

(

$dialect

)

Sets dialect

Parameters

\InfluxDB2\Model\Dialect | null

$dialect

dialect

Returns

$this

setExtern()

InfluxDB2\Model\Query::setExtern

(

$extern

)

Sets extern

Parameters

\InfluxDB2\Model\File | null

$extern

extern

Returns

$this

setNow()

InfluxDB2\Model\Query::setNow

(

$now

)

Sets now

Parameters

\DateTime | null

$now

Specifies the time that should be reported as now in the query. Default is the server now time.

Returns

$this

setParams()

InfluxDB2\Model\Query::setParams

(

$params

)

Sets params

Parameters

map[string,object]|null

$params Key-value pairs passed as parameters during query execution. To use parameters in your query, pass a _query_ with params references (in dot notation)–for example: json query: "from(bucket: params.mybucket) |> range(start: params.rangeStart) |> limit(n:1)" and pass _params_ with the key-value pairs–for example: json params: { "mybucket": "environment", "rangeStart": "-30d" } During query execution, InfluxDB passes _params_ to your script and substitutes the values. #### Limitations - If you use _params_, you can't use _extern_.

Returns

$this

setQuery()

InfluxDB2\Model\Query::setQuery

(

$query

)

Sets query

Parameters

string

$query

The query script to execute.

Returns

$this

setters()

static InfluxDB2\Model\Query::setters ( )

static

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

Returns

array

Implements InfluxDB2\Model\ModelInterface.

setType()

InfluxDB2\Model\Query::setType

(

$type

)

Sets type

Parameters

string | null

$type

The type of query. Must be "flux".

Returns

$this

valid()

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

staticprotected

Initial value:

= [
        'extern' => 'extern',
        'query' => 'query',
        'type' => 'type',
        'params' => 'params',
        'dialect' => 'dialect',
        'now' => 'now'
    ]

$getters

InfluxDB2\Model\Query::$getters

staticprotected

Initial value:

= [
        'extern' => 'getExtern',
        'query' => 'getQuery',
        'type' => 'getType',
        'params' => 'getParams',
        'dialect' => 'getDialect',
        'now' => 'getNow'
    ]

$openAPIFormats

InfluxDB2\Model\Query::$openAPIFormats

staticprotected

Initial value:

= [
        'extern' => null,
        'query' => null,
        'type' => null,
        'params' => null,
        'dialect' => null,
        'now' => 'date-time'
    ]

$openAPITypes

InfluxDB2\Model\Query::$openAPITypes

staticprotected

Initial value:

= [
        'extern' => '\InfluxDB2\Model\File',
        'query' => 'string',
        'type' => 'string',
        'params' => 'map[string,object]',
        'dialect' => '\InfluxDB2\Model\Dialect',
        'now' => '\DateTime'
    ]

$setters

InfluxDB2\Model\Query::$setters

staticprotected

Initial value:

= [
        'extern' => 'setExtern',
        'query' => 'setQuery',
        'type' => 'setType',
        'params' => 'setParams',
        'dialect' => 'setDialect',
        'now' => 'setNow'
    ]

---

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

• src/InfluxDB2/Model/Query.php