InfluxDB2\Model\TaskUpdateRequest Class Reference

Inheritance diagram for InfluxDB2\Model\TaskUpdateRequest:

Public Member Functions
	getModelName ()
	__construct (array $data=null)
	listInvalidProperties ()
	valid ()
	getStatus ()
	setStatus ($status)
	getFlux ()
	setFlux ($flux)
	getName ()
	setName ($name)
	getEvery ()
	setEvery ($every)
	getCron ()
	setCron ($cron)
	getOffset ()
	setOffset ($offset)
	getDescription ()
	setDescription ($description)
	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 = 'TaskUpdateRequest'
static	$openAPITypes
static	$openAPIFormats
static	$attributeMap
static	$setters
static	$getters

Constructor & Destructor Documentation

__construct()

InfluxDB2\Model\TaskUpdateRequest::__construct

(

array

$data = null

)

Constructor

Parameters

mixed[]

$data

Associated array of property values initializing the model

Member Function Documentation

__toString()

InfluxDB2\Model\TaskUpdateRequest::__toString

(

)

Gets the string presentation of the object

Returns

string

attributeMap()

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

getCron()

InfluxDB2\Model\TaskUpdateRequest::getCron

(

)

Gets cron

Returns

string|null

getDescription()

InfluxDB2\Model\TaskUpdateRequest::getDescription

(

)

Gets description

Returns

string|null

getEvery()

InfluxDB2\Model\TaskUpdateRequest::getEvery

(

)

Gets every

Returns

string|null

getFlux()

InfluxDB2\Model\TaskUpdateRequest::getFlux

(

)

Gets flux

Returns

string|null

getModelName()

InfluxDB2\Model\TaskUpdateRequest::getModelName

(

)

The original name of the model.

Returns

string

Implements InfluxDB2\Model\ModelInterface.

getName()

InfluxDB2\Model\TaskUpdateRequest::getName

(

)

Gets name

Returns

string|null

getOffset()

InfluxDB2\Model\TaskUpdateRequest::getOffset

(

)

Gets offset

Returns

string|null

getStatus()

InfluxDB2\Model\TaskUpdateRequest::getStatus

(

)

Gets status

Returns

\InfluxDB2\Model\TaskStatusType|null

getters()

static InfluxDB2\Model\TaskUpdateRequest::getters ( )

static

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

Returns

array

Implements InfluxDB2\Model\ModelInterface.

listInvalidProperties()

InfluxDB2\Model\TaskUpdateRequest::listInvalidProperties

(

)

Show all the invalid properties with reasons.

Returns

array invalid properties with reasons

Implements InfluxDB2\Model\ModelInterface.

offsetExists()

InfluxDB2\Model\TaskUpdateRequest::offsetExists

(

$offset

)

Returns true if offset exists. False otherwise.

Parameters

integer

$offset

Offset

Returns

boolean

offsetGet()

InfluxDB2\Model\TaskUpdateRequest::offsetGet

(

$offset

)

Gets offset.

Parameters

integer

$offset

Offset

Returns

mixed

offsetSet()

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

Sets value based on offset.

Parameters

integer	$offset	Offset
mixed	$value	Value to be set

Returns

void

offsetUnset()

InfluxDB2\Model\TaskUpdateRequest::offsetUnset

(

$offset

)

Unsets offset.

Parameters

integer

$offset

Offset

Returns

void

openAPIFormats()

static InfluxDB2\Model\TaskUpdateRequest::openAPIFormats ( )

static

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

Returns

array

Implements InfluxDB2\Model\ModelInterface.

openAPITypes()

static InfluxDB2\Model\TaskUpdateRequest::openAPITypes ( )

static

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

Returns

array

Implements InfluxDB2\Model\ModelInterface.

setCron()

InfluxDB2\Model\TaskUpdateRequest::setCron

(

$cron

)

Sets cron

Parameters

string | null

$cron

Update the 'cron' option in the flux script.

Returns

$this

setDescription()

InfluxDB2\Model\TaskUpdateRequest::setDescription

(

$description

)

Sets description

Parameters

string | null

$description

Update the description of the task.

Returns

$this

setEvery()

InfluxDB2\Model\TaskUpdateRequest::setEvery

(

$every

)

Sets every

Parameters

string | null

$every

Update the 'every' option in the flux script.

Returns

$this

setFlux()

InfluxDB2\Model\TaskUpdateRequest::setFlux

(

$flux

)

Sets flux

Parameters

string | null

$flux

The Flux script that the task runs.

Returns

$this

setName()

InfluxDB2\Model\TaskUpdateRequest::setName

(

$name

)

Sets name

Parameters

string | null

$name

Update the 'name' option in the flux script.

Returns

$this

setOffset()

InfluxDB2\Model\TaskUpdateRequest::setOffset

(

$offset

)

Sets offset

Parameters

string | null

$offset

Update the 'offset' option in the flux script.

Returns

$this

setStatus()

InfluxDB2\Model\TaskUpdateRequest::setStatus

(

$status

)

Sets status

Parameters

\InfluxDB2\Model\TaskStatusType | null

$status

status

Returns

$this

setters()

static InfluxDB2\Model\TaskUpdateRequest::setters ( )

static

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

Returns

array

Implements InfluxDB2\Model\ModelInterface.

valid()

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

staticprotected

Initial value:

= [
        'status' => 'status',
        'flux' => 'flux',
        'name' => 'name',
        'every' => 'every',
        'cron' => 'cron',
        'offset' => 'offset',
        'description' => 'description'
    ]

$getters

InfluxDB2\Model\TaskUpdateRequest::$getters

staticprotected

Initial value:

= [
        'status' => 'getStatus',
        'flux' => 'getFlux',
        'name' => 'getName',
        'every' => 'getEvery',
        'cron' => 'getCron',
        'offset' => 'getOffset',
        'description' => 'getDescription'
    ]

$openAPIFormats

InfluxDB2\Model\TaskUpdateRequest::$openAPIFormats

staticprotected

Initial value:

= [
        'status' => null,
        'flux' => null,
        'name' => null,
        'every' => null,
        'cron' => null,
        'offset' => null,
        'description' => null
    ]

$openAPITypes

InfluxDB2\Model\TaskUpdateRequest::$openAPITypes

staticprotected

Initial value:

= [
        'status' => '\InfluxDB2\Model\TaskStatusType',
        'flux' => 'string',
        'name' => 'string',
        'every' => 'string',
        'cron' => 'string',
        'offset' => 'string',
        'description' => 'string'
    ]

$setters

InfluxDB2\Model\TaskUpdateRequest::$setters

staticprotected

Initial value:

= [
        'status' => 'setStatus',
        'flux' => 'setFlux',
        'name' => 'setName',
        'every' => 'setEvery',
        'cron' => 'setCron',
        'offset' => 'setOffset',
        'description' => 'setDescription'
    ]

---

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

• src/InfluxDB2/Model/TaskUpdateRequest.php