InfluxDB2\Model\Authorization Class Reference

Inheritance diagram for InfluxDB2\Model\Authorization:

Public Member Functions
	getModelName ()
	__construct (array $data=null)
	listInvalidProperties ()
	valid ()
	getCreatedAt ()
	setCreatedAt ($created_at)
	getUpdatedAt ()
	setUpdatedAt ($updated_at)
	getOrgId ()
	setOrgId ($org_id)
	getPermissions ()
	setPermissions ($permissions)
	getId ()
	setId ($id)
	getToken ()
	setToken ($token)
	getUserId ()
	setUserId ($user_id)
	getUser ()
	setUser ($user)
	getOrg ()
	setOrg ($org)
	getLinks ()
	setLinks ($links)
	offsetExists ($offset)
	offsetGet ($offset)
	offsetSet ($offset, $value)
	offsetUnset ($offset)
	__toString ()
Public Member Functions inherited from InfluxDB2\Model\AuthorizationUpdateRequest
	getStatusAllowableValues ()
	getStatus ()
	setStatus ($status)
	getDescription ()
	setDescription ($description)

Static Public Member Functions
static	openAPITypes ()
static	openAPIFormats ()
static	attributeMap ()
static	setters ()
static	getters ()

Public Attributes
const	DISCRIMINATOR = null
Public Attributes inherited from InfluxDB2\Model\AuthorizationUpdateRequest
const	DISCRIMINATOR = null
const	STATUS_ACTIVE = 'active'
const	STATUS_INACTIVE = 'inactive'

Static Protected Attributes
static	$openAPIModelName = 'Authorization'
static	$openAPITypes
static	$openAPIFormats
static	$attributeMap
static	$setters
static	$getters
Static Protected Attributes inherited from InfluxDB2\Model\AuthorizationUpdateRequest
static	$openAPIModelName = 'AuthorizationUpdateRequest'
static	$openAPITypes
static	$openAPIFormats
static	$attributeMap
static	$setters
static	$getters

Additional Inherited Members
Protected Attributes inherited from InfluxDB2\Model\AuthorizationUpdateRequest
	$container = []

Constructor & Destructor Documentation

__construct()

InfluxDB2\Model\Authorization::__construct

(

array

$data = null

)

Constructor

Parameters

mixed[]

$data

Associated array of property values initializing the model

Reimplemented from InfluxDB2\Model\AuthorizationUpdateRequest.

Member Function Documentation

__toString()

InfluxDB2\Model\Authorization::__toString

(

)

Gets the string presentation of the object

Returns

string

Reimplemented from InfluxDB2\Model\AuthorizationUpdateRequest.

attributeMap()

static InfluxDB2\Model\Authorization::attributeMap ( )

static

Array of attributes where the key is the local name, and the value is the original name

Returns

array

Reimplemented from InfluxDB2\Model\AuthorizationUpdateRequest.

getCreatedAt()

InfluxDB2\Model\Authorization::getCreatedAt

(

)

Gets created_at

Returns

\DateTime|null

getId()

InfluxDB2\Model\Authorization::getId

(

)

Gets id

Returns

string|null

getLinks()

InfluxDB2\Model\Authorization::getLinks

(

)

Gets links

Returns

\InfluxDB2\Model\AuthorizationLinks|null

getModelName()

InfluxDB2\Model\Authorization::getModelName

(

)

The original name of the model.

Returns

string

Reimplemented from InfluxDB2\Model\AuthorizationUpdateRequest.

getOrg()

InfluxDB2\Model\Authorization::getOrg

(

)

Gets org

Returns

string|null

getOrgId()

InfluxDB2\Model\Authorization::getOrgId

(

)

Gets org_id

Returns

string|null

getPermissions()

InfluxDB2\Model\Authorization::getPermissions

(

)

Gets permissions

Returns

\InfluxDB2\Model\Permission[]|null

getters()

static InfluxDB2\Model\Authorization::getters ( )

static

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

Returns

array

Reimplemented from InfluxDB2\Model\AuthorizationUpdateRequest.

getToken()

InfluxDB2\Model\Authorization::getToken

(

)

Gets token

Returns

string|null

getUpdatedAt()

InfluxDB2\Model\Authorization::getUpdatedAt

(

)

Gets updated_at

Returns

\DateTime|null

getUser()

InfluxDB2\Model\Authorization::getUser

(

)

Gets user

Returns

string|null

getUserId()

InfluxDB2\Model\Authorization::getUserId

(

)

Gets user_id

Returns

string|null

listInvalidProperties()

InfluxDB2\Model\Authorization::listInvalidProperties

(

)

Show all the invalid properties with reasons.

Returns

array invalid properties with reasons

Reimplemented from InfluxDB2\Model\AuthorizationUpdateRequest.

offsetExists()

InfluxDB2\Model\Authorization::offsetExists

(

$offset

)

Returns true if offset exists. False otherwise.

Parameters

integer

$offset

Offset

Returns

boolean

Reimplemented from InfluxDB2\Model\AuthorizationUpdateRequest.

offsetGet()

InfluxDB2\Model\Authorization::offsetGet

(

$offset

)

Gets offset.

Parameters

integer

$offset

Offset

Returns

mixed

Reimplemented from InfluxDB2\Model\AuthorizationUpdateRequest.

offsetSet()

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

Sets value based on offset.

Parameters

integer	$offset	Offset
mixed	$value	Value to be set

Returns

void

Reimplemented from InfluxDB2\Model\AuthorizationUpdateRequest.

offsetUnset()

InfluxDB2\Model\Authorization::offsetUnset

(

$offset

)

Unsets offset.

Parameters

integer

$offset

Offset

Returns

void

Reimplemented from InfluxDB2\Model\AuthorizationUpdateRequest.

openAPIFormats()

static InfluxDB2\Model\Authorization::openAPIFormats ( )

static

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

Returns

array

Reimplemented from InfluxDB2\Model\AuthorizationUpdateRequest.

openAPITypes()

static InfluxDB2\Model\Authorization::openAPITypes ( )

static

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

Returns

array

Reimplemented from InfluxDB2\Model\AuthorizationUpdateRequest.

setCreatedAt()

InfluxDB2\Model\Authorization::setCreatedAt

(

$created_at

)

Sets created_at

Parameters

\DateTime | null

$created_at

created_at

Returns

$this

setId()

InfluxDB2\Model\Authorization::setId

(

$id

)

Sets id

Parameters

string | null

$id

id

Returns

$this

setLinks()

InfluxDB2\Model\Authorization::setLinks

(

$links

)

Sets links

Parameters

\InfluxDB2\Model\AuthorizationLinks | null

$links

links

Returns

$this

setOrg()

InfluxDB2\Model\Authorization::setOrg

(

$org

)

Sets org

Parameters

string | null

$org

The name of the organization that the token is scoped to.

Returns

$this

setOrgId()

InfluxDB2\Model\Authorization::setOrgId

(

$org_id

)

Sets org_id

Parameters

string | null

$org_id

The ID of the organization.

Returns

$this

setPermissions()

InfluxDB2\Model\Authorization::setPermissions

(

$permissions

)

Sets permissions

Parameters

\InfluxDB2\Model\Permission[] | null

$permissions

A list of permissions for an authorization. An authorization must have at least one permission.

Returns

$this

setters()

static InfluxDB2\Model\Authorization::setters ( )

static

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

Returns

array

Reimplemented from InfluxDB2\Model\AuthorizationUpdateRequest.

setToken()

InfluxDB2\Model\Authorization::setToken

(

$token

)

Sets token

Parameters

string | null

$token

The API token for authenticating InfluxDB API and CLI requests.

Returns

$this

setUpdatedAt()

InfluxDB2\Model\Authorization::setUpdatedAt

(

$updated_at

)

Sets updated_at

Parameters

\DateTime | null

$updated_at

updated_at

Returns

$this

setUser()

InfluxDB2\Model\Authorization::setUser

(

$user

)

Sets user

Parameters

string | null

$user

The name of the user that created and owns the token.

Returns

$this

setUserId()

InfluxDB2\Model\Authorization::setUserId

(

$user_id

)

Sets user_id

Parameters

string | null

$user_id

The ID of the user that created and owns the token.

Returns

$this

valid()

InfluxDB2\Model\Authorization::valid

(

)

Validate all the properties in the model return true if all passed

Returns

bool True if all properties are valid

Reimplemented from InfluxDB2\Model\AuthorizationUpdateRequest.

Member Data Documentation

$attributeMap

InfluxDB2\Model\Authorization::$attributeMap

staticprotected

Initial value:

= [
        'created_at' => 'createdAt',
        'updated_at' => 'updatedAt',
        'org_id' => 'orgID',
        'permissions' => 'permissions',
        'id' => 'id',
        'token' => 'token',
        'user_id' => 'userID',
        'user' => 'user',
        'org' => 'org',
        'links' => 'links'
    ]

$getters

InfluxDB2\Model\Authorization::$getters

staticprotected

Initial value:

= [
        'created_at' => 'getCreatedAt',
        'updated_at' => 'getUpdatedAt',
        'org_id' => 'getOrgId',
        'permissions' => 'getPermissions',
        'id' => 'getId',
        'token' => 'getToken',
        'user_id' => 'getUserId',
        'user' => 'getUser',
        'org' => 'getOrg',
        'links' => 'getLinks'
    ]

$openAPIFormats

InfluxDB2\Model\Authorization::$openAPIFormats

staticprotected

Initial value:

= [
        'created_at' => 'date-time',
        'updated_at' => 'date-time',
        'org_id' => null,
        'permissions' => null,
        'id' => null,
        'token' => null,
        'user_id' => null,
        'user' => null,
        'org' => null,
        'links' => null
    ]

$openAPITypes

InfluxDB2\Model\Authorization::$openAPITypes

staticprotected

Initial value:

= [
        'created_at' => '\DateTime',
        'updated_at' => '\DateTime',
        'org_id' => 'string',
        'permissions' => '\InfluxDB2\Model\Permission[]',
        'id' => 'string',
        'token' => 'string',
        'user_id' => 'string',
        'user' => 'string',
        'org' => 'string',
        'links' => '\InfluxDB2\Model\AuthorizationLinks'
    ]

$setters

InfluxDB2\Model\Authorization::$setters

staticprotected

Initial value:

= [
        'created_at' => 'setCreatedAt',
        'updated_at' => 'setUpdatedAt',
        'org_id' => 'setOrgId',
        'permissions' => 'setPermissions',
        'id' => 'setId',
        'token' => 'setToken',
        'user_id' => 'setUserId',
        'user' => 'setUser',
        'org' => 'setOrg',
        'links' => 'setLinks'
    ]

---

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

• src/InfluxDB2/Model/Authorization.php