InfluxDB2\Model\PatchBucketRequest Class Reference

Inheritance diagram for InfluxDB2\Model\PatchBucketRequest:

Public Member Functions
	getModelName ()
	__construct (array $data=null)
	listInvalidProperties ()
	valid ()
	getName ()
	setName ($name)
	getDescription ()
	setDescription ($description)
	getRetentionRules ()
	setRetentionRules ($retention_rules)
	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 = 'PatchBucketRequest'
static	$openAPITypes
static	$openAPIFormats
static	$attributeMap
static	$setters
static	$getters

Constructor & Destructor Documentation

__construct()

InfluxDB2\Model\PatchBucketRequest::__construct

(

array

$data = null

)

Constructor

Parameters

mixed[]

$data

Associated array of property values initializing the model

Member Function Documentation

__toString()

InfluxDB2\Model\PatchBucketRequest::__toString

(

)

Gets the string presentation of the object

Returns

string

attributeMap()

static InfluxDB2\Model\PatchBucketRequest::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\PatchBucketRequest::getDescription

(

)

Gets description

Returns

string|null

getModelName()

InfluxDB2\Model\PatchBucketRequest::getModelName

(

)

The original name of the model.

Returns

string

Implements InfluxDB2\Model\ModelInterface.

getName()

InfluxDB2\Model\PatchBucketRequest::getName

(

)

Gets name

Returns

string|null

getRetentionRules()

InfluxDB2\Model\PatchBucketRequest::getRetentionRules

(

)

Gets retention_rules

Returns

\InfluxDB2\Model\PatchRetentionRule[]|null

getters()

static InfluxDB2\Model\PatchBucketRequest::getters ( )

static

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

Returns

array

Implements InfluxDB2\Model\ModelInterface.

listInvalidProperties()

InfluxDB2\Model\PatchBucketRequest::listInvalidProperties

(

)

Show all the invalid properties with reasons.

Returns

array invalid properties with reasons

Implements InfluxDB2\Model\ModelInterface.

offsetExists()

InfluxDB2\Model\PatchBucketRequest::offsetExists

(

$offset

)

Returns true if offset exists. False otherwise.

Parameters

integer

$offset

Offset

Returns

boolean

offsetGet()

InfluxDB2\Model\PatchBucketRequest::offsetGet

(

$offset

)

Gets offset.

Parameters

integer

$offset

Offset

Returns

mixed

offsetSet()

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

Sets value based on offset.

Parameters

integer	$offset	Offset
mixed	$value	Value to be set

Returns

void

offsetUnset()

InfluxDB2\Model\PatchBucketRequest::offsetUnset

(

$offset

)

Unsets offset.

Parameters

integer

$offset

Offset

Returns

void

openAPIFormats()

static InfluxDB2\Model\PatchBucketRequest::openAPIFormats ( )

static

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

Returns

array

Implements InfluxDB2\Model\ModelInterface.

openAPITypes()

static InfluxDB2\Model\PatchBucketRequest::openAPITypes ( )

static

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

Returns

array

Implements InfluxDB2\Model\ModelInterface.

setDescription()

InfluxDB2\Model\PatchBucketRequest::setDescription

(

$description

)

Sets description

Parameters

string | null

$description

A description of the bucket.

Returns

$this

setName()

InfluxDB2\Model\PatchBucketRequest::setName

(

$name

)

Sets name

Parameters

string | null

$name

The name of the bucket.

Returns

$this

setRetentionRules()

InfluxDB2\Model\PatchBucketRequest::setRetentionRules

(

$retention_rules

)

Sets retention_rules

Parameters

\InfluxDB2\Model\PatchRetentionRule[] | null

$retention_rules

Updates to rules to expire or retain data. No rules means no updates.

Returns

$this

setters()

static InfluxDB2\Model\PatchBucketRequest::setters ( )

static

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

Returns

array

Implements InfluxDB2\Model\ModelInterface.

valid()

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

staticprotected

Initial value:

= [
        'name' => 'name',
        'description' => 'description',
        'retention_rules' => 'retentionRules'
    ]

$getters

InfluxDB2\Model\PatchBucketRequest::$getters

staticprotected

Initial value:

= [
        'name' => 'getName',
        'description' => 'getDescription',
        'retention_rules' => 'getRetentionRules'
    ]

$openAPIFormats

InfluxDB2\Model\PatchBucketRequest::$openAPIFormats

staticprotected

Initial value:

= [
        'name' => null,
        'description' => null,
        'retention_rules' => null
    ]

$openAPITypes

InfluxDB2\Model\PatchBucketRequest::$openAPITypes

staticprotected

Initial value:

= [
        'name' => 'string',
        'description' => 'string',
        'retention_rules' => '\InfluxDB2\Model\PatchRetentionRule[]'
    ]

$setters

InfluxDB2\Model\PatchBucketRequest::$setters

staticprotected

Initial value:

= [
        'name' => 'setName',
        'description' => 'setDescription',
        'retention_rules' => 'setRetentionRules'
    ]

---

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

• src/InfluxDB2/Model/PatchBucketRequest.php