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\BucketRetentionRules Class Reference
Inheritance diagram for InfluxDB2\Model\BucketRetentionRules:
InfluxDB2\Model\ModelInterface

Public Member Functions

 getModelName ()
 
 getTypeAllowableValues ()
 
 __construct (array $data=null)
 
 listInvalidProperties ()
 
 valid ()
 
 getType ()
 
 setType ($type)
 
 getEverySeconds ()
 
 setEverySeconds ($every_seconds)
 
 getShardGroupDurationSeconds ()
 
 setShardGroupDurationSeconds ($shard_group_duration_seconds)
 
 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_EXPIRE = 'expire'
 

Protected Attributes

 $container = []
 

Static Protected Attributes

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

Constructor & Destructor Documentation

◆ __construct()

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

Constructor

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

Member Function Documentation

◆ __toString()

InfluxDB2\Model\BucketRetentionRules::__toString ( )

Gets the string presentation of the object

Returns
string

◆ attributeMap()

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

◆ getEverySeconds()

InfluxDB2\Model\BucketRetentionRules::getEverySeconds ( )

Gets every_seconds

Returns
int

◆ getModelName()

InfluxDB2\Model\BucketRetentionRules::getModelName ( )

The original name of the model.

Returns
string

Implements InfluxDB2\Model\ModelInterface.

◆ getShardGroupDurationSeconds()

InfluxDB2\Model\BucketRetentionRules::getShardGroupDurationSeconds ( )

Gets shard_group_duration_seconds

Returns
int|null

◆ getters()

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

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

Returns
array

Implements InfluxDB2\Model\ModelInterface.

◆ getType()

InfluxDB2\Model\BucketRetentionRules::getType ( )

Gets type

Returns
string|null

◆ getTypeAllowableValues()

InfluxDB2\Model\BucketRetentionRules::getTypeAllowableValues ( )

Gets allowable values of the enum

Returns
string[]

◆ listInvalidProperties()

InfluxDB2\Model\BucketRetentionRules::listInvalidProperties ( )

Show all the invalid properties with reasons.

Returns
array invalid properties with reasons

Implements InfluxDB2\Model\ModelInterface.

◆ offsetExists()

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

Returns true if offset exists. False otherwise.

Parameters
integer$offsetOffset
Returns
boolean

◆ offsetGet()

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

Gets offset.

Parameters
integer$offsetOffset
Returns
mixed

◆ offsetSet()

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

Sets value based on offset.

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

◆ offsetUnset()

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

Unsets offset.

Parameters
integer$offsetOffset
Returns
void

◆ openAPIFormats()

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

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

Returns
array

Implements InfluxDB2\Model\ModelInterface.

◆ openAPITypes()

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

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

Returns
array

Implements InfluxDB2\Model\ModelInterface.

◆ setEverySeconds()

InfluxDB2\Model\BucketRetentionRules::setEverySeconds ( $every_seconds)

Sets every_seconds

Parameters
int$every_secondsThe duration in seconds for how long data will be kept in the database. The default duration is 2592000 (30 days). 0 represents infinite retention.
Returns
$this

◆ setShardGroupDurationSeconds()

InfluxDB2\Model\BucketRetentionRules::setShardGroupDurationSeconds ( $shard_group_duration_seconds)

Sets shard_group_duration_seconds

Parameters
int | null$shard_group_duration_secondsThe shard group duration. The duration or interval (in seconds) that each shard group covers. #### InfluxDB Cloud - Does not use shardGroupDurationsSeconds. #### InfluxDB OSS - Default value depends on the bucket retention period.
Returns
$this

◆ setters()

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

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

Returns
array

Implements InfluxDB2\Model\ModelInterface.

◆ setType()

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

Sets type

Parameters
string | null$typetype
Returns
$this

◆ valid()

InfluxDB2\Model\BucketRetentionRules::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\BucketRetentionRules::$attributeMap
staticprotected
Initial value:
= [
'type' => 'type',
'every_seconds' => 'everySeconds',
'shard_group_duration_seconds' => 'shardGroupDurationSeconds'
]

◆ $getters

InfluxDB2\Model\BucketRetentionRules::$getters
staticprotected
Initial value:
= [
'type' => 'getType',
'every_seconds' => 'getEverySeconds',
'shard_group_duration_seconds' => 'getShardGroupDurationSeconds'
]

◆ $openAPIFormats

InfluxDB2\Model\BucketRetentionRules::$openAPIFormats
staticprotected
Initial value:
= [
'type' => null,
'every_seconds' => 'int64',
'shard_group_duration_seconds' => 'int64'
]

◆ $openAPITypes

InfluxDB2\Model\BucketRetentionRules::$openAPITypes
staticprotected
Initial value:
= [
'type' => 'string',
'every_seconds' => 'int',
'shard_group_duration_seconds' => 'int'
]

◆ $setters

InfluxDB2\Model\BucketRetentionRules::$setters
staticprotected
Initial value:
= [
'type' => 'setType',
'every_seconds' => 'setEverySeconds',
'shard_group_duration_seconds' => 'setShardGroupDurationSeconds'
]

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