InfluxDB2\Model\PostBucketRequest Class Reference

Inheritance diagram for InfluxDB2\Model\PostBucketRequest:

Public Member Functions
	getModelName ()
	__construct (array $data=null)
	listInvalidProperties ()
	valid ()
	getOrgId ()
	setOrgId ($org_id)
	getName ()
	setName ($name)
	getDescription ()
	setDescription ($description)
	getRp ()
	setRp ($rp)
	getRetentionRules ()
	setRetentionRules ($retention_rules)
	getSchemaType ()
	setSchemaType ($schema_type)
	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 = 'PostBucketRequest'
static	$openAPITypes
static	$openAPIFormats
static	$attributeMap
static	$setters
static	$getters

Constructor & Destructor Documentation

__construct()

InfluxDB2\Model\PostBucketRequest::__construct

(

array

$data = null

)

Constructor

Parameters

mixed[]

$data

Associated array of property values initializing the model

Member Function Documentation

__toString()

InfluxDB2\Model\PostBucketRequest::__toString

(

)

Gets the string presentation of the object

Returns

string

attributeMap()

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

getDescription()

InfluxDB2\Model\PostBucketRequest::getDescription

(

)

Gets description

Returns

string|null

getModelName()

InfluxDB2\Model\PostBucketRequest::getModelName

(

)

The original name of the model.

Returns

string

Implements InfluxDB2\Model\ModelInterface.

getName()

InfluxDB2\Model\PostBucketRequest::getName

(

)

Gets name

Returns

string

getOrgId()

InfluxDB2\Model\PostBucketRequest::getOrgId

(

)

Gets org_id

Returns

string

getRetentionRules()

InfluxDB2\Model\PostBucketRequest::getRetentionRules

(

)

Gets retention_rules

Returns

\InfluxDB2\Model\BucketRetentionRules[]|null

getRp()

InfluxDB2\Model\PostBucketRequest::getRp

(

)

Gets rp

Returns

string|null

getSchemaType()

InfluxDB2\Model\PostBucketRequest::getSchemaType

(

)

Gets schema_type

Returns

\InfluxDB2\Model\SchemaType|null

getters()

static InfluxDB2\Model\PostBucketRequest::getters ( )

static

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

Returns

array

Implements InfluxDB2\Model\ModelInterface.

listInvalidProperties()

InfluxDB2\Model\PostBucketRequest::listInvalidProperties

(

)

Show all the invalid properties with reasons.

Returns

array invalid properties with reasons

Implements InfluxDB2\Model\ModelInterface.

offsetExists()

InfluxDB2\Model\PostBucketRequest::offsetExists

(

$offset

)

Returns true if offset exists. False otherwise.

Parameters

integer

$offset

Offset

Returns

boolean

offsetGet()

InfluxDB2\Model\PostBucketRequest::offsetGet

(

$offset

)

Gets offset.

Parameters

integer

$offset

Offset

Returns

mixed

offsetSet()

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

Sets value based on offset.

Parameters

integer	$offset	Offset
mixed	$value	Value to be set

Returns

void

offsetUnset()

InfluxDB2\Model\PostBucketRequest::offsetUnset

(

$offset

)

Unsets offset.

Parameters

integer

$offset

Offset

Returns

void

openAPIFormats()

static InfluxDB2\Model\PostBucketRequest::openAPIFormats ( )

static

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

Returns

array

Implements InfluxDB2\Model\ModelInterface.

openAPITypes()

static InfluxDB2\Model\PostBucketRequest::openAPITypes ( )

static

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

Returns

array

Implements InfluxDB2\Model\ModelInterface.

setDescription()

InfluxDB2\Model\PostBucketRequest::setDescription

(

$description

)

Sets description

Parameters

string | null

$description

A description of the bucket.

Returns

$this

setName()

InfluxDB2\Model\PostBucketRequest::setName

(

$name

)

Sets name

Parameters

string

$name

The name of the bucket.

Returns

$this

setOrgId()

InfluxDB2\Model\PostBucketRequest::setOrgId

(

$org_id

)

Sets org_id

Parameters

string

$org_id

Organization ID. The ID of the organization.

Returns

$this

setRetentionRules()

InfluxDB2\Model\PostBucketRequest::setRetentionRules

(

$retention_rules

)

Sets retention_rules

Parameters

\InfluxDB2\Model\BucketRetentionRules[] | null

$retention_rules

Retention rules to expire or retain data. #### InfluxDB Cloud - retentionRules is required. #### InfluxDB OSS - retentionRules isn't required.

Returns

$this

setRp()

InfluxDB2\Model\PostBucketRequest::setRp

(

$rp

)

Sets rp

Parameters

string | null

$rp

Retention policy is an InfluxDB 1.x concept that represents the duration of time that each data point in the retention policy persists. Use rp for compatibility with InfluxDB 1.x. The InfluxDB 2.x and Cloud equivalent is retention period.

Returns

$this

setSchemaType()

InfluxDB2\Model\PostBucketRequest::setSchemaType

(

$schema_type

)

Sets schema_type

Parameters

\InfluxDB2\Model\SchemaType | null

$schema_type

schema_type

Returns

$this

setters()

static InfluxDB2\Model\PostBucketRequest::setters ( )

static

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

Returns

array

Implements InfluxDB2\Model\ModelInterface.

valid()

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

staticprotected

Initial value:

= [
        'org_id' => 'orgID',
        'name' => 'name',
        'description' => 'description',
        'rp' => 'rp',
        'retention_rules' => 'retentionRules',
        'schema_type' => 'schemaType'
    ]

$getters

InfluxDB2\Model\PostBucketRequest::$getters

staticprotected

Initial value:

= [
        'org_id' => 'getOrgId',
        'name' => 'getName',
        'description' => 'getDescription',
        'rp' => 'getRp',
        'retention_rules' => 'getRetentionRules',
        'schema_type' => 'getSchemaType'
    ]

$openAPIFormats

InfluxDB2\Model\PostBucketRequest::$openAPIFormats

staticprotected

Initial value:

= [
        'org_id' => null,
        'name' => null,
        'description' => null,
        'rp' => null,
        'retention_rules' => null,
        'schema_type' => null
    ]

$openAPITypes

InfluxDB2\Model\PostBucketRequest::$openAPITypes

staticprotected

Initial value:

= [
        'org_id' => 'string',
        'name' => 'string',
        'description' => 'string',
        'rp' => 'string',
        'retention_rules' => '\InfluxDB2\Model\BucketRetentionRules[]',
        'schema_type' => '\InfluxDB2\Model\SchemaType'
    ]

$setters

InfluxDB2\Model\PostBucketRequest::$setters

staticprotected

Initial value:

= [
        'org_id' => 'setOrgId',
        'name' => 'setName',
        'description' => 'setDescription',
        'rp' => 'setRp',
        'retention_rules' => 'setRetentionRules',
        'schema_type' => 'setSchemaType'
    ]

---

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

• src/InfluxDB2/Model/PostBucketRequest.php