InfluxDB PHP Client
Loading...
Searching...
No Matches
Public Member Functions | Static Public Member Functions | Public Attributes | Protected Attributes | Static Protected Attributes | List of all members
InfluxDB2\Model\Bucket Class Reference
Inheritance diagram for InfluxDB2\Model\Bucket:
InfluxDB2\Model\ModelInterface

Public Member Functions

 getModelName ()
 
 getTypeAllowableValues ()
 
 __construct (array $data=null)
 
 listInvalidProperties ()
 
 valid ()
 
 getLinks ()
 
 setLinks ($links)
 
 getId ()
 
 setId ($id)
 
 getType ()
 
 setType ($type)
 
 getName ()
 
 setName ($name)
 
 getDescription ()
 
 setDescription ($description)
 
 getOrgId ()
 
 setOrgId ($org_id)
 
 getRp ()
 
 setRp ($rp)
 
 getSchemaType ()
 
 setSchemaType ($schema_type)
 
 getCreatedAt ()
 
 setCreatedAt ($created_at)
 
 getUpdatedAt ()
 
 setUpdatedAt ($updated_at)
 
 getRetentionRules ()
 
 setRetentionRules ($retention_rules)
 
 getLabels ()
 
 setLabels ($labels)
 
 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_USER = 'user'
 
const TYPE_SYSTEM = 'system'
 

Protected Attributes

 $container = []
 

Static Protected Attributes

static $openAPIModelName = 'Bucket'
 
static $openAPITypes
 
static $openAPIFormats
 
static $attributeMap
 
static $setters
 
static $getters
 

Constructor & Destructor Documentation

◆ __construct()

InfluxDB2\Model\Bucket::__construct ( array $data = null)

Constructor

Parameters
mixed[]$dataAssociated array of property values initializing the model

Member Function Documentation

◆ __toString()

InfluxDB2\Model\Bucket::__toString ( )

Gets the string presentation of the object

Returns
string

◆ attributeMap()

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

◆ getCreatedAt()

InfluxDB2\Model\Bucket::getCreatedAt ( )

Gets created_at

Returns
\DateTime|null

◆ getDescription()

InfluxDB2\Model\Bucket::getDescription ( )

Gets description

Returns
string|null

◆ getId()

InfluxDB2\Model\Bucket::getId ( )

Gets id

Returns
string|null

◆ getLabels()

InfluxDB2\Model\Bucket::getLabels ( )

Gets labels

Returns
\InfluxDB2\Model\Label[]|null

◆ getLinks()

InfluxDB2\Model\Bucket::getLinks ( )

Gets links

Returns
\InfluxDB2\Model\BucketLinks|null

◆ getModelName()

InfluxDB2\Model\Bucket::getModelName ( )

The original name of the model.

Returns
string

Implements InfluxDB2\Model\ModelInterface.

◆ getName()

InfluxDB2\Model\Bucket::getName ( )

Gets name

Returns
string

◆ getOrgId()

InfluxDB2\Model\Bucket::getOrgId ( )

Gets org_id

Returns
string|null

◆ getRetentionRules()

InfluxDB2\Model\Bucket::getRetentionRules ( )

Gets retention_rules

Returns
\InfluxDB2\Model\BucketRetentionRules[]

◆ getRp()

InfluxDB2\Model\Bucket::getRp ( )

Gets rp

Returns
string|null

◆ getSchemaType()

InfluxDB2\Model\Bucket::getSchemaType ( )

Gets schema_type

Returns
\InfluxDB2\Model\SchemaType|null

◆ getters()

static InfluxDB2\Model\Bucket::getters ( )
static

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

Returns
array

Implements InfluxDB2\Model\ModelInterface.

◆ getType()

InfluxDB2\Model\Bucket::getType ( )

Gets type

Returns
string|null

◆ getTypeAllowableValues()

InfluxDB2\Model\Bucket::getTypeAllowableValues ( )

Gets allowable values of the enum

Returns
string[]

◆ getUpdatedAt()

InfluxDB2\Model\Bucket::getUpdatedAt ( )

Gets updated_at

Returns
\DateTime|null

◆ listInvalidProperties()

InfluxDB2\Model\Bucket::listInvalidProperties ( )

Show all the invalid properties with reasons.

Returns
array invalid properties with reasons

Implements InfluxDB2\Model\ModelInterface.

◆ offsetExists()

InfluxDB2\Model\Bucket::offsetExists ( $offset)

Returns true if offset exists. False otherwise.

Parameters
integer$offsetOffset
Returns
boolean

◆ offsetGet()

InfluxDB2\Model\Bucket::offsetGet ( $offset)

Gets offset.

Parameters
integer$offsetOffset
Returns
mixed

◆ offsetSet()

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

Sets value based on offset.

Parameters
integer$offsetOffset
mixed$valueValue to be set
Returns
void

◆ offsetUnset()

InfluxDB2\Model\Bucket::offsetUnset ( $offset)

Unsets offset.

Parameters
integer$offsetOffset
Returns
void

◆ openAPIFormats()

static InfluxDB2\Model\Bucket::openAPIFormats ( )
static

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

Returns
array

Implements InfluxDB2\Model\ModelInterface.

◆ openAPITypes()

static InfluxDB2\Model\Bucket::openAPITypes ( )
static

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

Returns
array

Implements InfluxDB2\Model\ModelInterface.

◆ setCreatedAt()

InfluxDB2\Model\Bucket::setCreatedAt ( $created_at)

Sets created_at

Parameters
\DateTime | null$created_atcreated_at
Returns
$this

◆ setDescription()

InfluxDB2\Model\Bucket::setDescription ( $description)

Sets description

Parameters
string | null$descriptiondescription
Returns
$this

◆ setId()

InfluxDB2\Model\Bucket::setId ( $id)

Sets id

Parameters
string | null$idid
Returns
$this

◆ setLabels()

InfluxDB2\Model\Bucket::setLabels ( $labels)

Sets labels

Parameters
\InfluxDB2\Model\Label[] | null$labelslabels
Returns
$this

◆ setLinks()

InfluxDB2\Model\Bucket::setLinks ( $links)

Sets links

Parameters
\InfluxDB2\Model\BucketLinks | null$linkslinks
Returns
$this

◆ setName()

InfluxDB2\Model\Bucket::setName ( $name)

Sets name

Parameters
string$namename
Returns
$this

◆ setOrgId()

InfluxDB2\Model\Bucket::setOrgId ( $org_id)

Sets org_id

Parameters
string | null$org_idorg_id
Returns
$this

◆ setRetentionRules()

InfluxDB2\Model\Bucket::setRetentionRules ( $retention_rules)

Sets retention_rules

Parameters
\InfluxDB2\Model\BucketRetentionRules[]$retention_rulesRetention rules to expire or retain data. #### InfluxDB Cloud - retentionRules is required. #### InfluxDB OSS - retentionRules isn't required.
Returns
$this

◆ setRp()

InfluxDB2\Model\Bucket::setRp ( $rp)

Sets rp

Parameters
string | null$rprp
Returns
$this

◆ setSchemaType()

InfluxDB2\Model\Bucket::setSchemaType ( $schema_type)

Sets schema_type

Parameters
\InfluxDB2\Model\SchemaType | null$schema_typeschema_type
Returns
$this

◆ setters()

static InfluxDB2\Model\Bucket::setters ( )
static

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

Returns
array

Implements InfluxDB2\Model\ModelInterface.

◆ setType()

InfluxDB2\Model\Bucket::setType ( $type)

Sets type

Parameters
string | null$typetype
Returns
$this

◆ setUpdatedAt()

InfluxDB2\Model\Bucket::setUpdatedAt ( $updated_at)

Sets updated_at

Parameters
\DateTime | null$updated_atupdated_at
Returns
$this

◆ valid()

InfluxDB2\Model\Bucket::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\Bucket::$attributeMap
staticprotected
Initial value:
= [
'links' => 'links',
'id' => 'id',
'type' => 'type',
'name' => 'name',
'description' => 'description',
'org_id' => 'orgID',
'rp' => 'rp',
'schema_type' => 'schemaType',
'created_at' => 'createdAt',
'updated_at' => 'updatedAt',
'retention_rules' => 'retentionRules',
'labels' => 'labels'
]

◆ $getters

InfluxDB2\Model\Bucket::$getters
staticprotected
Initial value:
= [
'links' => 'getLinks',
'id' => 'getId',
'type' => 'getType',
'name' => 'getName',
'description' => 'getDescription',
'org_id' => 'getOrgId',
'rp' => 'getRp',
'schema_type' => 'getSchemaType',
'created_at' => 'getCreatedAt',
'updated_at' => 'getUpdatedAt',
'retention_rules' => 'getRetentionRules',
'labels' => 'getLabels'
]

◆ $openAPIFormats

InfluxDB2\Model\Bucket::$openAPIFormats
staticprotected
Initial value:
= [
'links' => null,
'id' => null,
'type' => null,
'name' => null,
'description' => null,
'org_id' => null,
'rp' => null,
'schema_type' => null,
'created_at' => 'date-time',
'updated_at' => 'date-time',
'retention_rules' => null,
'labels' => null
]

◆ $openAPITypes

InfluxDB2\Model\Bucket::$openAPITypes
staticprotected
Initial value:
= [
'links' => '\InfluxDB2\Model\BucketLinks',
'id' => 'string',
'type' => 'string',
'name' => 'string',
'description' => 'string',
'org_id' => 'string',
'rp' => 'string',
'schema_type' => '\InfluxDB2\Model\SchemaType',
'created_at' => '\DateTime',
'updated_at' => '\DateTime',
'retention_rules' => '\InfluxDB2\Model\BucketRetentionRules[]',
'labels' => '\InfluxDB2\Model\Label[]'
]

◆ $setters

InfluxDB2\Model\Bucket::$setters
staticprotected
Initial value:
= [
'links' => 'setLinks',
'id' => 'setId',
'type' => 'setType',
'name' => 'setName',
'description' => 'setDescription',
'org_id' => 'setOrgId',
'rp' => 'setRp',
'schema_type' => 'setSchemaType',
'created_at' => 'setCreatedAt',
'updated_at' => 'setUpdatedAt',
'retention_rules' => 'setRetentionRules',
'labels' => 'setLabels'
]
The documentation for this class was generated from the following file:
Generated by doxygen 1.10.0