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

Public Member Functions

 getModelName ()
 
 getAnnotationsAllowableValues ()
 
 getDateTimeFormatAllowableValues ()
 
 __construct (array $data=null)
 
 listInvalidProperties ()
 
 valid ()
 
 getHeader ()
 
 setHeader ($header)
 
 getDelimiter ()
 
 setDelimiter ($delimiter)
 
 getAnnotations ()
 
 setAnnotations ($annotations)
 
 getCommentPrefix ()
 
 setCommentPrefix ($comment_prefix)
 
 getDateTimeFormat ()
 
 setDateTimeFormat ($date_time_format)
 
 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 ANNOTATIONS_GROUP = 'group'
 
const ANNOTATIONS_DATATYPE = 'datatype'
 
const ANNOTATIONS__DEFAULT = 'default'
 
const DATE_TIME_FORMAT_RFC3339 = 'RFC3339'
 
const DATE_TIME_FORMAT_RFC3339_NANO = 'RFC3339Nano'
 

Protected Attributes

 $container = []
 

Static Protected Attributes

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

Constructor & Destructor Documentation

◆ __construct()

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

Constructor

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

Member Function Documentation

◆ __toString()

InfluxDB2\Model\Dialect::__toString ( )

Gets the string presentation of the object

Returns
string

◆ attributeMap()

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

◆ getAnnotations()

InfluxDB2\Model\Dialect::getAnnotations ( )

Gets annotations

Returns
string[]|null

◆ getAnnotationsAllowableValues()

InfluxDB2\Model\Dialect::getAnnotationsAllowableValues ( )

Gets allowable values of the enum

Returns
string[]

◆ getCommentPrefix()

InfluxDB2\Model\Dialect::getCommentPrefix ( )

Gets comment_prefix

Returns
string|null

◆ getDateTimeFormat()

InfluxDB2\Model\Dialect::getDateTimeFormat ( )

Gets date_time_format

Returns
string|null

◆ getDateTimeFormatAllowableValues()

InfluxDB2\Model\Dialect::getDateTimeFormatAllowableValues ( )

Gets allowable values of the enum

Returns
string[]

◆ getDelimiter()

InfluxDB2\Model\Dialect::getDelimiter ( )

Gets delimiter

Returns
string|null

◆ getHeader()

InfluxDB2\Model\Dialect::getHeader ( )

Gets header

Returns
bool|null

◆ getModelName()

InfluxDB2\Model\Dialect::getModelName ( )

The original name of the model.

Returns
string

Implements InfluxDB2\Model\ModelInterface.

◆ getters()

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

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

Returns
array

Implements InfluxDB2\Model\ModelInterface.

◆ listInvalidProperties()

InfluxDB2\Model\Dialect::listInvalidProperties ( )

Show all the invalid properties with reasons.

Returns
array invalid properties with reasons

Implements InfluxDB2\Model\ModelInterface.

◆ offsetExists()

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

Returns true if offset exists. False otherwise.

Parameters
integer$offsetOffset
Returns
boolean

◆ offsetGet()

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

Gets offset.

Parameters
integer$offsetOffset
Returns
mixed

◆ offsetSet()

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

Sets value based on offset.

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

◆ offsetUnset()

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

Unsets offset.

Parameters
integer$offsetOffset
Returns
void

◆ openAPIFormats()

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

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

Returns
array

Implements InfluxDB2\Model\ModelInterface.

◆ openAPITypes()

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

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

Returns
array

Implements InfluxDB2\Model\ModelInterface.

◆ setAnnotations()

InfluxDB2\Model\Dialect::setAnnotations ( $annotations)

Sets annotations

Parameters
string[] | null$annotationsAnnotation rows to include in the results. An annotation is metadata associated with an object (column) in the data model. #### Related guides - See Annotated CSV annotations for examples and more information. For more information about annotations in tabular data, see W3 metadata vocabulary for tabular data.
Returns
$this

◆ setCommentPrefix()

InfluxDB2\Model\Dialect::setCommentPrefix ( $comment_prefix)

Sets comment_prefix

Parameters
string | null$comment_prefixThe character prefixed to comment strings. Default is a number sign (#).
Returns
$this

◆ setDateTimeFormat()

InfluxDB2\Model\Dialect::setDateTimeFormat ( $date_time_format)

Sets date_time_format

Parameters
string | null$date_time_formatThe format for timestamps in results. Default is RFC3339 date/time format. To include nanoseconds in timestamps, use RFC3339Nano. #### Example formatted date/time values | Format | Value | |:---------—|:-------------------------—| | RFC3339 | "2006-01-02T15:04:05Z07:00" | | RFC3339Nano | "2006-01-02T15:04:05.999999999Z07:00" |
Returns
$this

◆ setDelimiter()

InfluxDB2\Model\Dialect::setDelimiter ( $delimiter)

Sets delimiter

Parameters
string | null$delimiterThe separator used between cells. Default is a comma (,).
Returns
$this

◆ setHeader()

InfluxDB2\Model\Dialect::setHeader ( $header)

Sets header

Parameters
bool | null$headerIf true, the results contain a header row.
Returns
$this

◆ setters()

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

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

Returns
array

Implements InfluxDB2\Model\ModelInterface.

◆ valid()

InfluxDB2\Model\Dialect::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\Dialect::$attributeMap
staticprotected
Initial value:
= [
'header' => 'header',
'delimiter' => 'delimiter',
'annotations' => 'annotations',
'comment_prefix' => 'commentPrefix',
'date_time_format' => 'dateTimeFormat'
]

◆ $getters

InfluxDB2\Model\Dialect::$getters
staticprotected
Initial value:
= [
'header' => 'getHeader',
'delimiter' => 'getDelimiter',
'annotations' => 'getAnnotations',
'comment_prefix' => 'getCommentPrefix',
'date_time_format' => 'getDateTimeFormat'
]

◆ $openAPIFormats

InfluxDB2\Model\Dialect::$openAPIFormats
staticprotected
Initial value:
= [
'header' => null,
'delimiter' => null,
'annotations' => null,
'comment_prefix' => null,
'date_time_format' => null
]

◆ $openAPITypes

InfluxDB2\Model\Dialect::$openAPITypes
staticprotected
Initial value:
= [
'header' => 'bool',
'delimiter' => 'string',
'annotations' => 'string[]',
'comment_prefix' => 'string',
'date_time_format' => 'string'
]

◆ $setters

InfluxDB2\Model\Dialect::$setters
staticprotected
Initial value:
= [
'header' => 'setHeader',
'delimiter' => 'setDelimiter',
'annotations' => 'setAnnotations',
'comment_prefix' => 'setCommentPrefix',
'date_time_format' => 'setDateTimeFormat'
]
The documentation for this class was generated from the following file:
Generated by doxygen 1.10.0