InfluxDB2\Model\Error Class Reference

Inheritance diagram for InfluxDB2\Model\Error:

Public Member Functions
	getModelName ()
	getCodeAllowableValues ()
	__construct (array $data=null)
	listInvalidProperties ()
	valid ()
	getCode ()
	setCode ($code)
	getMessage ()
	setMessage ($message)
	getOp ()
	setOp ($op)
	getErr ()
	setErr ($err)
	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	CODE_INTERNAL_ERROR = 'internal error'
const	CODE_NOT_FOUND = 'not found'
const	CODE_CONFLICT = 'conflict'
const	CODE_INVALID = 'invalid'
const	CODE_UNPROCESSABLE_ENTITY = 'unprocessable entity'
const	CODE_EMPTY_VALUE = 'empty value'
const	CODE_UNAVAILABLE = 'unavailable'
const	CODE_FORBIDDEN = 'forbidden'
const	CODE_TOO_MANY_REQUESTS = 'too many requests'
const	CODE_UNAUTHORIZED = 'unauthorized'
const	CODE_METHOD_NOT_ALLOWED = 'method not allowed'
const	CODE_REQUEST_TOO_LARGE = 'request too large'
const	CODE_UNSUPPORTED_MEDIA_TYPE = 'unsupported media type'

Protected Attributes
	$container = []

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

Constructor & Destructor Documentation

__construct()

InfluxDB2\Model\Error::__construct

(

array

$data = null

)

Constructor

Parameters

mixed[]

$data

Associated array of property values initializing the model

Member Function Documentation

__toString()

InfluxDB2\Model\Error::__toString

(

)

Gets the string presentation of the object

Returns

string

attributeMap()

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

getCode()

InfluxDB2\Model\Error::getCode

(

)

Gets code

Returns

string

getCodeAllowableValues()

InfluxDB2\Model\Error::getCodeAllowableValues

(

)

Gets allowable values of the enum

Returns

string[]

getErr()

InfluxDB2\Model\Error::getErr

(

)

Gets err

Returns

string|null

getMessage()

InfluxDB2\Model\Error::getMessage

(

)

Gets message

Returns

string|null

getModelName()

InfluxDB2\Model\Error::getModelName

(

)

The original name of the model.

Returns

string

Implements InfluxDB2\Model\ModelInterface.

getOp()

InfluxDB2\Model\Error::getOp

(

)

Gets op

Returns

string|null

getters()

static InfluxDB2\Model\Error::getters ( )

static

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

Returns

array

Implements InfluxDB2\Model\ModelInterface.

listInvalidProperties()

InfluxDB2\Model\Error::listInvalidProperties

(

)

Show all the invalid properties with reasons.

Returns

array invalid properties with reasons

Implements InfluxDB2\Model\ModelInterface.

offsetExists()

InfluxDB2\Model\Error::offsetExists

(

$offset

)

Returns true if offset exists. False otherwise.

Parameters

integer

$offset

Offset

Returns

boolean

offsetGet()

InfluxDB2\Model\Error::offsetGet

(

$offset

)

Gets offset.

Parameters

integer

$offset

Offset

Returns

mixed

offsetSet()

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

Sets value based on offset.

Parameters

integer	$offset	Offset
mixed	$value	Value to be set

Returns

void

offsetUnset()

InfluxDB2\Model\Error::offsetUnset

(

$offset

)

Unsets offset.

Parameters

integer

$offset

Offset

Returns

void

openAPIFormats()

static InfluxDB2\Model\Error::openAPIFormats ( )

static

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

Returns

array

Implements InfluxDB2\Model\ModelInterface.

openAPITypes()

static InfluxDB2\Model\Error::openAPITypes ( )

static

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

Returns

array

Implements InfluxDB2\Model\ModelInterface.

setCode()

InfluxDB2\Model\Error::setCode

(

$code

)

Sets code

Parameters

string

$code

code is the machine-readable error code.

Returns

$this

setErr()

InfluxDB2\Model\Error::setErr

(

$err

)

Sets err

Parameters

string | null

$err

Stack of errors that occurred during processing of the request. Useful for debugging.

Returns

$this

setMessage()

InfluxDB2\Model\Error::setMessage

(

$message

)

Sets message

Parameters

string | null

$message

Human-readable message.

Returns

$this

setOp()

InfluxDB2\Model\Error::setOp

(

$op

)

Sets op

Parameters

string | null

$op

Describes the logical code operation when the error occurred. Useful for debugging.

Returns

$this

setters()

static InfluxDB2\Model\Error::setters ( )

static

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

Returns

array

Implements InfluxDB2\Model\ModelInterface.

valid()

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

staticprotected

Initial value:

= [
        'code' => 'code',
        'message' => 'message',
        'op' => 'op',
        'err' => 'err'
    ]

$getters

InfluxDB2\Model\Error::$getters

staticprotected

Initial value:

= [
        'code' => 'getCode',
        'message' => 'getMessage',
        'op' => 'getOp',
        'err' => 'getErr'
    ]

$openAPIFormats

InfluxDB2\Model\Error::$openAPIFormats

staticprotected

Initial value:

= [
        'code' => null,
        'message' => null,
        'op' => null,
        'err' => null
    ]

$openAPITypes

InfluxDB2\Model\Error::$openAPITypes

staticprotected

Initial value:

= [
        'code' => 'string',
        'message' => 'string',
        'op' => 'string',
        'err' => 'string'
    ]

$setters

InfluxDB2\Model\Error::$setters

staticprotected

Initial value:

= [
        'code' => 'setCode',
        'message' => 'setMessage',
        'op' => 'setOp',
        'err' => 'setErr'
    ]

---

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

• src/InfluxDB2/Model/Error.php