InfluxDB2\Model\PermissionResource Class Reference

Inheritance diagram for InfluxDB2\Model\PermissionResource:

Public Member Functions
	getModelName ()
	getTypeAllowableValues ()
	__construct (array $data=null)
	listInvalidProperties ()
	valid ()
	getType ()
	setType ($type)
	getId ()
	setId ($id)
	getName ()
	setName ($name)
	getOrgId ()
	setOrgId ($org_id)
	getOrg ()
	setOrg ($org)
	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	TYPE_AUTHORIZATIONS = 'authorizations'
const	TYPE_BUCKETS = 'buckets'
const	TYPE_DASHBOARDS = 'dashboards'
const	TYPE_ORGS = 'orgs'
const	TYPE_SOURCES = 'sources'
const	TYPE_TASKS = 'tasks'
const	TYPE_TELEGRAFS = 'telegrafs'
const	TYPE_USERS = 'users'
const	TYPE_VARIABLES = 'variables'
const	TYPE_SCRAPERS = 'scrapers'
const	TYPE_SECRETS = 'secrets'
const	TYPE_LABELS = 'labels'
const	TYPE_VIEWS = 'views'
const	TYPE_DOCUMENTS = 'documents'
const	TYPE_NOTIFICATION_RULES = 'notificationRules'
const	TYPE_NOTIFICATION_ENDPOINTS = 'notificationEndpoints'
const	TYPE_CHECKS = 'checks'
const	TYPE_DBRP = 'dbrp'
const	TYPE_NOTEBOOKS = 'notebooks'
const	TYPE_ANNOTATIONS = 'annotations'
const	TYPE_REMOTES = 'remotes'
const	TYPE_REPLICATIONS = 'replications'
const	TYPE_INSTANCE = 'instance'
const	TYPE_FLOWS = 'flows'
const	TYPE_FUNCTIONS = 'functions'

Protected Attributes
	$container = []

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

Constructor & Destructor Documentation

__construct()

InfluxDB2\Model\PermissionResource::__construct

(

array

$data = null

)

Constructor

Parameters

mixed[]

$data

Associated array of property values initializing the model

Member Function Documentation

__toString()

InfluxDB2\Model\PermissionResource::__toString

(

)

Gets the string presentation of the object

Returns

string

attributeMap()

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

getId()

InfluxDB2\Model\PermissionResource::getId

(

)

Gets id

Returns

string|null

getModelName()

InfluxDB2\Model\PermissionResource::getModelName

(

)

The original name of the model.

Returns

string

Implements InfluxDB2\Model\ModelInterface.

getName()

InfluxDB2\Model\PermissionResource::getName

(

)

Gets name

Returns

string|null

getOrg()

InfluxDB2\Model\PermissionResource::getOrg

(

)

Gets org

Returns

string|null

getOrgId()

InfluxDB2\Model\PermissionResource::getOrgId

(

)

Gets org_id

Returns

string|null

getters()

static InfluxDB2\Model\PermissionResource::getters ( )

static

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

Returns

array

Implements InfluxDB2\Model\ModelInterface.

getType()

InfluxDB2\Model\PermissionResource::getType

(

)

Gets type

Returns

string

getTypeAllowableValues()

InfluxDB2\Model\PermissionResource::getTypeAllowableValues

(

)

Gets allowable values of the enum

Returns

string[]

listInvalidProperties()

InfluxDB2\Model\PermissionResource::listInvalidProperties

(

)

Show all the invalid properties with reasons.

Returns

array invalid properties with reasons

Implements InfluxDB2\Model\ModelInterface.

offsetExists()

InfluxDB2\Model\PermissionResource::offsetExists

(

$offset

)

Returns true if offset exists. False otherwise.

Parameters

integer

$offset

Offset

Returns

boolean

offsetGet()

InfluxDB2\Model\PermissionResource::offsetGet

(

$offset

)

Gets offset.

Parameters

integer

$offset

Offset

Returns

mixed

offsetSet()

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

Sets value based on offset.

Parameters

integer	$offset	Offset
mixed	$value	Value to be set

Returns

void

offsetUnset()

InfluxDB2\Model\PermissionResource::offsetUnset

(

$offset

)

Unsets offset.

Parameters

integer

$offset

Offset

Returns

void

openAPIFormats()

static InfluxDB2\Model\PermissionResource::openAPIFormats ( )

static

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

Returns

array

Implements InfluxDB2\Model\ModelInterface.

openAPITypes()

static InfluxDB2\Model\PermissionResource::openAPITypes ( )

static

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

Returns

array

Implements InfluxDB2\Model\ModelInterface.

setId()

InfluxDB2\Model\PermissionResource::setId

(

$id

)

Sets id

Parameters

string | null

$id

The ID of a specific resource. In a permission, applies the permission to only the resource with this ID.

Returns

$this

setName()

InfluxDB2\Model\PermissionResource::setName

(

$name

)

Sets name

Parameters

string | null

$name

Optional: A name for the resource. Not all resource types have a name field.

Returns

$this

setOrg()

InfluxDB2\Model\PermissionResource::setOrg

(

$org

)

Sets org

Parameters

string | null

$org

Optional: The name of the organization with orgID.

Returns

$this

setOrgId()

InfluxDB2\Model\PermissionResource::setOrgId

(

$org_id

)

Sets org_id

Parameters

string | null

$org_id

The ID of the organization that owns the resource. In a permission, applies the permission to all resources of type owned by this organization.

Returns

$this

setters()

static InfluxDB2\Model\PermissionResource::setters ( )

static

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

Returns

array

Implements InfluxDB2\Model\ModelInterface.

setType()

InfluxDB2\Model\PermissionResource::setType

(

$type

)

Sets type

Parameters

string

$type

The type of resource. In a permission, applies the permission to all resources of this type.

Returns

$this

valid()

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

staticprotected

Initial value:

= [
        'type' => 'type',
        'id' => 'id',
        'name' => 'name',
        'org_id' => 'orgID',
        'org' => 'org'
    ]

$getters

InfluxDB2\Model\PermissionResource::$getters

staticprotected

Initial value:

= [
        'type' => 'getType',
        'id' => 'getId',
        'name' => 'getName',
        'org_id' => 'getOrgId',
        'org' => 'getOrg'
    ]

$openAPIFormats

InfluxDB2\Model\PermissionResource::$openAPIFormats

staticprotected

Initial value:

= [
        'type' => null,
        'id' => null,
        'name' => null,
        'org_id' => null,
        'org' => null
    ]

$openAPITypes

InfluxDB2\Model\PermissionResource::$openAPITypes

staticprotected

Initial value:

= [
        'type' => 'string',
        'id' => 'string',
        'name' => 'string',
        'org_id' => 'string',
        'org' => 'string'
    ]

$setters

InfluxDB2\Model\PermissionResource::$setters

staticprotected

Initial value:

= [
        'type' => 'setType',
        'id' => 'setId',
        'name' => 'setName',
        'org_id' => 'setOrgId',
        'org' => 'setOrg'
    ]

---

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

• src/InfluxDB2/Model/PermissionResource.php