InfluxDB2\Model\HealthCheck Class Reference

Inheritance diagram for InfluxDB2\Model\HealthCheck:

Public Member Functions
	getModelName ()
	getStatusAllowableValues ()
	__construct (array $data=null)
	listInvalidProperties ()
	valid ()
	getName ()
	setName ($name)
	getMessage ()
	setMessage ($message)
	getChecks ()
	setChecks ($checks)
	getStatus ()
	setStatus ($status)
	getVersion ()
	setVersion ($version)
	getCommit ()
	setCommit ($commit)
	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	STATUS_PASS = 'pass'
const	STATUS_FAIL = 'fail'

Protected Attributes
	$container = []

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

Constructor & Destructor Documentation

__construct()

InfluxDB2\Model\HealthCheck::__construct

(

array

$data = null

)

Constructor

Parameters

mixed[]

$data

Associated array of property values initializing the model

Member Function Documentation

__toString()

InfluxDB2\Model\HealthCheck::__toString

(

)

Gets the string presentation of the object

Returns

string

attributeMap()

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

getChecks()

InfluxDB2\Model\HealthCheck::getChecks

(

)

Gets checks

Returns

\InfluxDB2\Model\HealthCheck[]|null

getCommit()

InfluxDB2\Model\HealthCheck::getCommit

(

)

Gets commit

Returns

string|null

getMessage()

InfluxDB2\Model\HealthCheck::getMessage

(

)

Gets message

Returns

string|null

getModelName()

InfluxDB2\Model\HealthCheck::getModelName

(

)

The original name of the model.

Returns

string

Implements InfluxDB2\Model\ModelInterface.

getName()

InfluxDB2\Model\HealthCheck::getName

(

)

Gets name

Returns

string

getStatus()

InfluxDB2\Model\HealthCheck::getStatus

(

)

Gets status

Returns

string

getStatusAllowableValues()

InfluxDB2\Model\HealthCheck::getStatusAllowableValues

(

)

Gets allowable values of the enum

Returns

string[]

getters()

static InfluxDB2\Model\HealthCheck::getters ( )

static

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

Returns

array

Implements InfluxDB2\Model\ModelInterface.

getVersion()

InfluxDB2\Model\HealthCheck::getVersion

(

)

Gets version

Returns

string|null

listInvalidProperties()

InfluxDB2\Model\HealthCheck::listInvalidProperties

(

)

Show all the invalid properties with reasons.

Returns

array invalid properties with reasons

Implements InfluxDB2\Model\ModelInterface.

offsetExists()

InfluxDB2\Model\HealthCheck::offsetExists

(

$offset

)

Returns true if offset exists. False otherwise.

Parameters

integer

$offset

Offset

Returns

boolean

offsetGet()

InfluxDB2\Model\HealthCheck::offsetGet

(

$offset

)

Gets offset.

Parameters

integer

$offset

Offset

Returns

mixed

offsetSet()

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

Sets value based on offset.

Parameters

integer	$offset	Offset
mixed	$value	Value to be set

Returns

void

offsetUnset()

InfluxDB2\Model\HealthCheck::offsetUnset

(

$offset

)

Unsets offset.

Parameters

integer

$offset

Offset

Returns

void

openAPIFormats()

static InfluxDB2\Model\HealthCheck::openAPIFormats ( )

static

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

Returns

array

Implements InfluxDB2\Model\ModelInterface.

openAPITypes()

static InfluxDB2\Model\HealthCheck::openAPITypes ( )

static

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

Returns

array

Implements InfluxDB2\Model\ModelInterface.

setChecks()

InfluxDB2\Model\HealthCheck::setChecks

(

$checks

)

Sets checks

Parameters

\InfluxDB2\Model\HealthCheck[] | null

$checks

checks

Returns

$this

setCommit()

InfluxDB2\Model\HealthCheck::setCommit

(

$commit

)

Sets commit

Parameters

string | null

$commit

commit

Returns

$this

setMessage()

InfluxDB2\Model\HealthCheck::setMessage

(

$message

)

Sets message

Parameters

string | null

$message

message

Returns

$this

setName()

InfluxDB2\Model\HealthCheck::setName

(

$name

)

Sets name

Parameters

string

$name

name

Returns

$this

setStatus()

InfluxDB2\Model\HealthCheck::setStatus

(

$status

)

Sets status

Parameters

string

$status

status

Returns

$this

setters()

static InfluxDB2\Model\HealthCheck::setters ( )

static

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

Returns

array

Implements InfluxDB2\Model\ModelInterface.

setVersion()

InfluxDB2\Model\HealthCheck::setVersion

(

$version

)

Sets version

Parameters

string | null

$version

version

Returns

$this

valid()

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

staticprotected

Initial value:

= [
        'name' => 'name',
        'message' => 'message',
        'checks' => 'checks',
        'status' => 'status',
        'version' => 'version',
        'commit' => 'commit'
    ]

$getters

InfluxDB2\Model\HealthCheck::$getters

staticprotected

Initial value:

= [
        'name' => 'getName',
        'message' => 'getMessage',
        'checks' => 'getChecks',
        'status' => 'getStatus',
        'version' => 'getVersion',
        'commit' => 'getCommit'
    ]

$openAPIFormats

InfluxDB2\Model\HealthCheck::$openAPIFormats

staticprotected

Initial value:

= [
        'name' => null,
        'message' => null,
        'checks' => null,
        'status' => null,
        'version' => null,
        'commit' => null
    ]

$openAPITypes

InfluxDB2\Model\HealthCheck::$openAPITypes

staticprotected

Initial value:

= [
        'name' => 'string',
        'message' => 'string',
        'checks' => '\InfluxDB2\Model\HealthCheck[]',
        'status' => 'string',
        'version' => 'string',
        'commit' => 'string'
    ]

$setters

InfluxDB2\Model\HealthCheck::$setters

staticprotected

Initial value:

= [
        'name' => 'setName',
        'message' => 'setMessage',
        'checks' => 'setChecks',
        'status' => 'setStatus',
        'version' => 'setVersion',
        'commit' => 'setCommit'
    ]

---

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

• src/InfluxDB2/Model/HealthCheck.php