InfluxDB2\Model\User Class Reference

Inheritance diagram for InfluxDB2\Model\User:

Public Member Functions
	getModelName ()
	getStatusAllowableValues ()
	__construct (array $data=null)
	listInvalidProperties ()
	valid ()
	getId ()
	setId ($id)
	getName ()
	setName ($name)
	getStatus ()
	setStatus ($status)
	getLinks ()
	setLinks ($links)
	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_ACTIVE = 'active'
const	STATUS_INACTIVE = 'inactive'

Protected Attributes
	$container = []

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

Constructor & Destructor Documentation

__construct()

InfluxDB2\Model\User::__construct

(

array

$data = null

)

Constructor

Parameters

mixed[]

$data

Associated array of property values initializing the model

Reimplemented in InfluxDB2\Model\ResourceMember, and InfluxDB2\Model\ResourceOwner.

Member Function Documentation

__toString()

InfluxDB2\Model\User::__toString

(

)

Gets the string presentation of the object

Returns

string

Reimplemented in InfluxDB2\Model\ResourceMember, and InfluxDB2\Model\ResourceOwner.

attributeMap()

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

Reimplemented in InfluxDB2\Model\ResourceMember, and InfluxDB2\Model\ResourceOwner.

getId()

InfluxDB2\Model\User::getId

(

)

Gets id

Returns

string|null

getLinks()

InfluxDB2\Model\User::getLinks

(

)

Gets links

Returns

\InfluxDB2\Model\UserLinks|null

getModelName()

InfluxDB2\Model\User::getModelName

(

)

The original name of the model.

Returns

string

Implements InfluxDB2\Model\ModelInterface.

Reimplemented in InfluxDB2\Model\ResourceMember, and InfluxDB2\Model\ResourceOwner.

getName()

InfluxDB2\Model\User::getName

(

)

Gets name

Returns

string

getStatus()

InfluxDB2\Model\User::getStatus

(

)

Gets status

Returns

string|null

getStatusAllowableValues()

InfluxDB2\Model\User::getStatusAllowableValues

(

)

Gets allowable values of the enum

Returns

string[]

getters()

static InfluxDB2\Model\User::getters ( )

static

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

Returns

array

Implements InfluxDB2\Model\ModelInterface.

Reimplemented in InfluxDB2\Model\ResourceMember, and InfluxDB2\Model\ResourceOwner.

listInvalidProperties()

InfluxDB2\Model\User::listInvalidProperties

(

)

Show all the invalid properties with reasons.

Returns

array invalid properties with reasons

Implements InfluxDB2\Model\ModelInterface.

Reimplemented in InfluxDB2\Model\ResourceMember, and InfluxDB2\Model\ResourceOwner.

offsetExists()

InfluxDB2\Model\User::offsetExists

(

$offset

)

Returns true if offset exists. False otherwise.

Parameters

integer

$offset

Offset

Returns

boolean

Reimplemented in InfluxDB2\Model\ResourceMember, and InfluxDB2\Model\ResourceOwner.

offsetGet()

InfluxDB2\Model\User::offsetGet

(

$offset

)

Gets offset.

Parameters

integer

$offset

Offset

Returns

mixed

Reimplemented in InfluxDB2\Model\ResourceMember, and InfluxDB2\Model\ResourceOwner.

offsetSet()

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

Sets value based on offset.

Parameters

integer	$offset	Offset
mixed	$value	Value to be set

Returns

void

Reimplemented in InfluxDB2\Model\ResourceMember, and InfluxDB2\Model\ResourceOwner.

offsetUnset()

InfluxDB2\Model\User::offsetUnset

(

$offset

)

Unsets offset.

Parameters

integer

$offset

Offset

Returns

void

Reimplemented in InfluxDB2\Model\ResourceMember, and InfluxDB2\Model\ResourceOwner.

openAPIFormats()

static InfluxDB2\Model\User::openAPIFormats ( )

static

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

Returns

array

Implements InfluxDB2\Model\ModelInterface.

Reimplemented in InfluxDB2\Model\ResourceMember, and InfluxDB2\Model\ResourceOwner.

openAPITypes()

static InfluxDB2\Model\User::openAPITypes ( )

static

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

Returns

array

Implements InfluxDB2\Model\ModelInterface.

Reimplemented in InfluxDB2\Model\ResourceMember, and InfluxDB2\Model\ResourceOwner.

setId()

InfluxDB2\Model\User::setId

(

$id

)

Sets id

Parameters

string | null

$id

The ID of the user.

Returns

$this

setLinks()

InfluxDB2\Model\User::setLinks

(

$links

)

Sets links

Parameters

\InfluxDB2\Model\UserLinks | null

$links

links

Returns

$this

setName()

InfluxDB2\Model\User::setName

(

$name

)

Sets name

Parameters

string

$name

The name of the user.

Returns

$this

setStatus()

InfluxDB2\Model\User::setStatus

(

$status

)

Sets status

Parameters

string | null

$status

The status of a user. An inactive user won't have access to resources.

Returns

$this

setters()

static InfluxDB2\Model\User::setters ( )

static

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

Returns

array

Implements InfluxDB2\Model\ModelInterface.

Reimplemented in InfluxDB2\Model\ResourceMember, and InfluxDB2\Model\ResourceOwner.

valid()

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

Reimplemented in InfluxDB2\Model\ResourceMember, and InfluxDB2\Model\ResourceOwner.

Member Data Documentation

$attributeMap

InfluxDB2\Model\User::$attributeMap

staticprotected

Initial value:

= [
        'id' => 'id',
        'name' => 'name',
        'status' => 'status',
        'links' => 'links'
    ]

$getters

InfluxDB2\Model\User::$getters

staticprotected

Initial value:

= [
        'id' => 'getId',
        'name' => 'getName',
        'status' => 'getStatus',
        'links' => 'getLinks'
    ]

$openAPIFormats

InfluxDB2\Model\User::$openAPIFormats

staticprotected

Initial value:

= [
        'id' => null,
        'name' => null,
        'status' => null,
        'links' => null
    ]

$openAPITypes

InfluxDB2\Model\User::$openAPITypes

staticprotected

Initial value:

= [
        'id' => 'string',
        'name' => 'string',
        'status' => 'string',
        'links' => '\InfluxDB2\Model\UserLinks'
    ]

$setters

InfluxDB2\Model\User::$setters

staticprotected

Initial value:

= [
        'id' => 'setId',
        'name' => 'setName',
        'status' => 'setStatus',
        'links' => 'setLinks'
    ]

---

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

• src/InfluxDB2/Model/User.php