InfluxDB2\Model\DBRP Class Reference

Inheritance diagram for InfluxDB2\Model\DBRP:

Public Member Functions
	getModelName ()
	__construct (array $data=null)
	listInvalidProperties ()
	valid ()
	getId ()
	setId ($id)
	getOrgId ()
	setOrgId ($org_id)
	getBucketId ()
	setBucketId ($bucket_id)
	getDatabase ()
	setDatabase ($database)
	getRetentionPolicy ()
	setRetentionPolicy ($retention_policy)
	getDefault ()
	setDefault ($default)
	getVirtual ()
	setVirtual ($virtual)
	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

Protected Attributes
	$container = []

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

Constructor & Destructor Documentation

__construct()

InfluxDB2\Model\DBRP::__construct

(

array

$data = null

)

Constructor

Parameters

mixed[]

$data

Associated array of property values initializing the model

Member Function Documentation

__toString()

InfluxDB2\Model\DBRP::__toString

(

)

Gets the string presentation of the object

Returns

string

attributeMap()

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

getBucketId()

InfluxDB2\Model\DBRP::getBucketId

(

)

Gets bucket_id

Returns

string

getDatabase()

InfluxDB2\Model\DBRP::getDatabase

(

)

Gets database

Returns

string

getDefault()

InfluxDB2\Model\DBRP::getDefault

(

)

Gets default

Returns

bool

getId()

InfluxDB2\Model\DBRP::getId

(

)

Gets id

Returns

string

getLinks()

InfluxDB2\Model\DBRP::getLinks

(

)

Gets links

Returns

\InfluxDB2\Model\Links|null

getModelName()

InfluxDB2\Model\DBRP::getModelName

(

)

The original name of the model.

Returns

string

Implements InfluxDB2\Model\ModelInterface.

getOrgId()

InfluxDB2\Model\DBRP::getOrgId

(

)

Gets org_id

Returns

string

getRetentionPolicy()

InfluxDB2\Model\DBRP::getRetentionPolicy

(

)

Gets retention_policy

Returns

string

getters()

static InfluxDB2\Model\DBRP::getters ( )

static

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

Returns

array

Implements InfluxDB2\Model\ModelInterface.

getVirtual()

InfluxDB2\Model\DBRP::getVirtual

(

)

Gets virtual

Returns

bool|null

listInvalidProperties()

InfluxDB2\Model\DBRP::listInvalidProperties

(

)

Show all the invalid properties with reasons.

Returns

array invalid properties with reasons

Implements InfluxDB2\Model\ModelInterface.

offsetExists()

InfluxDB2\Model\DBRP::offsetExists

(

$offset

)

Returns true if offset exists. False otherwise.

Parameters

integer

$offset

Offset

Returns

boolean

offsetGet()

InfluxDB2\Model\DBRP::offsetGet

(

$offset

)

Gets offset.

Parameters

integer

$offset

Offset

Returns

mixed

offsetSet()

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

Sets value based on offset.

Parameters

integer	$offset	Offset
mixed	$value	Value to be set

Returns

void

offsetUnset()

InfluxDB2\Model\DBRP::offsetUnset

(

$offset

)

Unsets offset.

Parameters

integer

$offset

Offset

Returns

void

openAPIFormats()

static InfluxDB2\Model\DBRP::openAPIFormats ( )

static

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

Returns

array

Implements InfluxDB2\Model\ModelInterface.

openAPITypes()

static InfluxDB2\Model\DBRP::openAPITypes ( )

static

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

Returns

array

Implements InfluxDB2\Model\ModelInterface.

setBucketId()

InfluxDB2\Model\DBRP::setBucketId

(

$bucket_id

)

Sets bucket_id

Parameters

string

$bucket_id

The ID of the bucket used as the target for the translation.

Returns

$this

setDatabase()

InfluxDB2\Model\DBRP::setDatabase

(

$database

)

Sets database

Parameters

string

$database

InfluxDB v1 database

Returns

$this

setDefault()

InfluxDB2\Model\DBRP::setDefault

(

$default

)

Sets default

Parameters

bool

$default

Mapping represents the default retention policy for the database specified.

Returns

$this

setId()

InfluxDB2\Model\DBRP::setId

(

$id

)

Sets id

Parameters

string

$id

The ID of the DBRP mapping.

Returns

$this

setLinks()

InfluxDB2\Model\DBRP::setLinks

(

$links

)

Sets links

Parameters

\InfluxDB2\Model\Links | null

$links

links

Returns

$this

setOrgId()

InfluxDB2\Model\DBRP::setOrgId

(

$org_id

)

Sets org_id

Parameters

string

$org_id

The ID of the organization.

Returns

$this

setRetentionPolicy()

InfluxDB2\Model\DBRP::setRetentionPolicy

(

$retention_policy

)

Sets retention_policy

Parameters

string

$retention_policy

InfluxDB v1 retention policy

Returns

$this

setters()

static InfluxDB2\Model\DBRP::setters ( )

static

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

Returns

array

Implements InfluxDB2\Model\ModelInterface.

setVirtual()

InfluxDB2\Model\DBRP::setVirtual

(

$virtual

)

Sets virtual

Parameters

bool | null

$virtual

Indicates an autogenerated, virtual mapping based on the bucket name. Currently only available in OSS.

Returns

$this

valid()

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

staticprotected

Initial value:

= [
        'id' => 'id',
        'org_id' => 'orgID',
        'bucket_id' => 'bucketID',
        'database' => 'database',
        'retention_policy' => 'retention_policy',
        'default' => 'default',
        'virtual' => 'virtual',
        'links' => 'links'
    ]

$getters

InfluxDB2\Model\DBRP::$getters

staticprotected

Initial value:

= [
        'id' => 'getId',
        'org_id' => 'getOrgId',
        'bucket_id' => 'getBucketId',
        'database' => 'getDatabase',
        'retention_policy' => 'getRetentionPolicy',
        'default' => 'getDefault',
        'virtual' => 'getVirtual',
        'links' => 'getLinks'
    ]

$openAPIFormats

InfluxDB2\Model\DBRP::$openAPIFormats

staticprotected

Initial value:

= [
        'id' => null,
        'org_id' => null,
        'bucket_id' => null,
        'database' => null,
        'retention_policy' => null,
        'default' => null,
        'virtual' => null,
        'links' => null
    ]

$openAPITypes

InfluxDB2\Model\DBRP::$openAPITypes

staticprotected

Initial value:

= [
        'id' => 'string',
        'org_id' => 'string',
        'bucket_id' => 'string',
        'database' => 'string',
        'retention_policy' => 'string',
        'default' => 'bool',
        'virtual' => 'bool',
        'links' => '\InfluxDB2\Model\Links'
    ]

$setters

InfluxDB2\Model\DBRP::$setters

staticprotected

Initial value:

= [
        'id' => 'setId',
        'org_id' => 'setOrgId',
        'bucket_id' => 'setBucketId',
        'database' => 'setDatabase',
        'retention_policy' => 'setRetentionPolicy',
        'default' => 'setDefault',
        'virtual' => 'setVirtual',
        'links' => 'setLinks'
    ]

---

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

• src/InfluxDB2/Model/DBRP.php