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

Public Member Functions

 getModelName ()
 
 getLastRunStatusAllowableValues ()
 
 __construct (array $data=null)
 
 listInvalidProperties ()
 
 valid ()
 
 getId ()
 
 setId ($id)
 
 getOrgId ()
 
 setOrgId ($org_id)
 
 getOrg ()
 
 setOrg ($org)
 
 getName ()
 
 setName ($name)
 
 getOwnerId ()
 
 setOwnerId ($owner_id)
 
 getDescription ()
 
 setDescription ($description)
 
 getStatus ()
 
 setStatus ($status)
 
 getLabels ()
 
 setLabels ($labels)
 
 getAuthorizationId ()
 
 setAuthorizationId ($authorization_id)
 
 getFlux ()
 
 setFlux ($flux)
 
 getEvery ()
 
 setEvery ($every)
 
 getCron ()
 
 setCron ($cron)
 
 getOffset ()
 
 setOffset ($offset)
 
 getLatestCompleted ()
 
 setLatestCompleted ($latest_completed)
 
 getLastRunStatus ()
 
 setLastRunStatus ($last_run_status)
 
 getLastRunError ()
 
 setLastRunError ($last_run_error)
 
 getCreatedAt ()
 
 setCreatedAt ($created_at)
 
 getUpdatedAt ()
 
 setUpdatedAt ($updated_at)
 
 getLinks ()
 
 setLinks ($links)
 
 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 LAST_RUN_STATUS_FAILED = 'failed'
 
const LAST_RUN_STATUS_SUCCESS = 'success'
 
const LAST_RUN_STATUS_CANCELED = 'canceled'
 

Protected Attributes

 $container = []
 

Static Protected Attributes

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

Constructor & Destructor Documentation

◆ __construct()

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

Constructor

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

Member Function Documentation

◆ __toString()

InfluxDB2\Model\Task::__toString ( )

Gets the string presentation of the object

Returns
string

◆ attributeMap()

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

◆ getAuthorizationId()

InfluxDB2\Model\Task::getAuthorizationId ( )

Gets authorization_id

Returns
string|null

◆ getCreatedAt()

InfluxDB2\Model\Task::getCreatedAt ( )

Gets created_at

Returns
\DateTime|null

◆ getCron()

InfluxDB2\Model\Task::getCron ( )

Gets cron

Returns
string|null

◆ getDescription()

InfluxDB2\Model\Task::getDescription ( )

Gets description

Returns
string|null

◆ getEvery()

InfluxDB2\Model\Task::getEvery ( )

Gets every

Returns
string|null

◆ getFlux()

InfluxDB2\Model\Task::getFlux ( )

Gets flux

Returns
string

◆ getId()

InfluxDB2\Model\Task::getId ( )

Gets id

Returns
string

◆ getLabels()

InfluxDB2\Model\Task::getLabels ( )

Gets labels

Returns
\InfluxDB2\Model\Label[]|null

◆ getLastRunError()

InfluxDB2\Model\Task::getLastRunError ( )

Gets last_run_error

Returns
string|null

◆ getLastRunStatus()

InfluxDB2\Model\Task::getLastRunStatus ( )

Gets last_run_status

Returns
string|null

◆ getLastRunStatusAllowableValues()

InfluxDB2\Model\Task::getLastRunStatusAllowableValues ( )

Gets allowable values of the enum

Returns
string[]

◆ getLatestCompleted()

InfluxDB2\Model\Task::getLatestCompleted ( )

Gets latest_completed

Returns
\DateTime|null

◆ getLinks()

InfluxDB2\Model\Task::getLinks ( )

Gets links

Returns
\InfluxDB2\Model\TaskLinks|null

◆ getModelName()

InfluxDB2\Model\Task::getModelName ( )

The original name of the model.

Returns
string

Implements InfluxDB2\Model\ModelInterface.

◆ getName()

InfluxDB2\Model\Task::getName ( )

Gets name

Returns
string

◆ getOffset()

InfluxDB2\Model\Task::getOffset ( )

Gets offset

Returns
string|null

◆ getOrg()

InfluxDB2\Model\Task::getOrg ( )

Gets org

Returns
string|null

◆ getOrgId()

InfluxDB2\Model\Task::getOrgId ( )

Gets org_id

Returns
string

◆ getOwnerId()

InfluxDB2\Model\Task::getOwnerId ( )

Gets owner_id

Returns
string|null

◆ getStatus()

InfluxDB2\Model\Task::getStatus ( )

Gets status

Returns
\InfluxDB2\Model\TaskStatusType|null

◆ getters()

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

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

Returns
array

Implements InfluxDB2\Model\ModelInterface.

◆ getUpdatedAt()

InfluxDB2\Model\Task::getUpdatedAt ( )

Gets updated_at

Returns
\DateTime|null

◆ listInvalidProperties()

InfluxDB2\Model\Task::listInvalidProperties ( )

Show all the invalid properties with reasons.

Returns
array invalid properties with reasons

Implements InfluxDB2\Model\ModelInterface.

◆ offsetExists()

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

Returns true if offset exists. False otherwise.

Parameters
integer$offsetOffset
Returns
boolean

◆ offsetGet()

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

Gets offset.

Parameters
integer$offsetOffset
Returns
mixed

◆ offsetSet()

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

Sets value based on offset.

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

◆ offsetUnset()

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

Unsets offset.

Parameters
integer$offsetOffset
Returns
void

◆ openAPIFormats()

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

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

Returns
array

Implements InfluxDB2\Model\ModelInterface.

◆ openAPITypes()

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

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

Returns
array

Implements InfluxDB2\Model\ModelInterface.

◆ setAuthorizationId()

InfluxDB2\Model\Task::setAuthorizationId ( $authorization_id)

Sets authorization_id

Parameters
string | null$authorization_idThe ID of the authorization used when the task communicates with the query engine.
Returns
$this

◆ setCreatedAt()

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

Sets created_at

Parameters
\DateTime | null$created_atcreated_at
Returns
$this

◆ setCron()

InfluxDB2\Model\Task::setCron ( $cron)

Sets cron

Parameters
string | null$cronCron expression that defines the schedule on which the task runs. InfluxDB bases cron runs on the system time.
Returns
$this

◆ setDescription()

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

Sets description

Parameters
string | null$descriptionThe description of the task.
Returns
$this

◆ setEvery()

InfluxDB2\Model\Task::setEvery ( $every)

Sets every

Parameters
string | null$everyAn interval (duration literal)) at which the task runs. every also determines when the task first runs, depending on the specified time.
Returns
$this

◆ setFlux()

InfluxDB2\Model\Task::setFlux ( $flux)

Sets flux

Parameters
string$fluxThe Flux script that the task runs.
Returns
$this

◆ setId()

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

Sets id

Parameters
string$idid
Returns
$this

◆ setLabels()

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

Sets labels

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

◆ setLastRunError()

InfluxDB2\Model\Task::setLastRunError ( $last_run_error)

Sets last_run_error

Parameters
string | null$last_run_errorlast_run_error
Returns
$this

◆ setLastRunStatus()

InfluxDB2\Model\Task::setLastRunStatus ( $last_run_status)

Sets last_run_status

Parameters
string | null$last_run_statuslast_run_status
Returns
$this

◆ setLatestCompleted()

InfluxDB2\Model\Task::setLatestCompleted ( $latest_completed)

Sets latest_completed

Parameters
\DateTime | null$latest_completedA timestamp (RFC3339 date/time format) of the latest scheduled and completed run.
Returns
$this

◆ setLinks()

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

Sets links

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

◆ setName()

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

Sets name

Parameters
string$nameThe name of the task.
Returns
$this

◆ setOffset()

InfluxDB2\Model\Task::setOffset ( $offset)

Sets offset

Parameters
string | null$offsetA duration to delay execution of the task after the scheduled time has elapsed. 0 removes the offset.
Returns
$this

◆ setOrg()

InfluxDB2\Model\Task::setOrg ( $org)

Sets org

Parameters
string | null$orgThe name of the organization that owns the task.
Returns
$this

◆ setOrgId()

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

Sets org_id

Parameters
string$org_idThe ID of the organization that owns the task.
Returns
$this

◆ setOwnerId()

InfluxDB2\Model\Task::setOwnerId ( $owner_id)

Sets owner_id

Parameters
string | null$owner_idThe ID of the user who owns the Task.
Returns
$this

◆ setStatus()

InfluxDB2\Model\Task::setStatus ( $status)

Sets status

Parameters
\InfluxDB2\Model\TaskStatusType | null$statusstatus
Returns
$this

◆ setters()

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

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

Returns
array

Implements InfluxDB2\Model\ModelInterface.

◆ setUpdatedAt()

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

Sets updated_at

Parameters
\DateTime | null$updated_atupdated_at
Returns
$this

◆ valid()

InfluxDB2\Model\Task::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\Task::$attributeMap
staticprotected
Initial value:
= [
'id' => 'id',
'org_id' => 'orgID',
'org' => 'org',
'name' => 'name',
'owner_id' => 'ownerID',
'description' => 'description',
'status' => 'status',
'labels' => 'labels',
'authorization_id' => 'authorizationID',
'flux' => 'flux',
'every' => 'every',
'cron' => 'cron',
'offset' => 'offset',
'latest_completed' => 'latestCompleted',
'last_run_status' => 'lastRunStatus',
'last_run_error' => 'lastRunError',
'created_at' => 'createdAt',
'updated_at' => 'updatedAt',
'links' => 'links'
]

◆ $getters

InfluxDB2\Model\Task::$getters
staticprotected
Initial value:
= [
'id' => 'getId',
'org_id' => 'getOrgId',
'org' => 'getOrg',
'name' => 'getName',
'owner_id' => 'getOwnerId',
'description' => 'getDescription',
'status' => 'getStatus',
'labels' => 'getLabels',
'authorization_id' => 'getAuthorizationId',
'flux' => 'getFlux',
'every' => 'getEvery',
'cron' => 'getCron',
'offset' => 'getOffset',
'latest_completed' => 'getLatestCompleted',
'last_run_status' => 'getLastRunStatus',
'last_run_error' => 'getLastRunError',
'created_at' => 'getCreatedAt',
'updated_at' => 'getUpdatedAt',
'links' => 'getLinks'
]

◆ $openAPIFormats

InfluxDB2\Model\Task::$openAPIFormats
staticprotected
Initial value:
= [
'id' => null,
'org_id' => null,
'org' => null,
'name' => null,
'owner_id' => null,
'description' => null,
'status' => null,
'labels' => null,
'authorization_id' => null,
'flux' => null,
'every' => 'duration',
'cron' => null,
'offset' => 'duration',
'latest_completed' => 'date-time',
'last_run_status' => null,
'last_run_error' => null,
'created_at' => 'date-time',
'updated_at' => 'date-time',
'links' => null
]

◆ $openAPITypes

InfluxDB2\Model\Task::$openAPITypes
staticprotected
Initial value:
= [
'id' => 'string',
'org_id' => 'string',
'org' => 'string',
'name' => 'string',
'owner_id' => 'string',
'description' => 'string',
'status' => '\InfluxDB2\Model\TaskStatusType',
'labels' => '\InfluxDB2\Model\Label[]',
'authorization_id' => 'string',
'flux' => 'string',
'every' => 'string',
'cron' => 'string',
'offset' => 'string',
'latest_completed' => '\DateTime',
'last_run_status' => 'string',
'last_run_error' => 'string',
'created_at' => '\DateTime',
'updated_at' => '\DateTime',
'links' => '\InfluxDB2\Model\TaskLinks'
]

◆ $setters

InfluxDB2\Model\Task::$setters
staticprotected
Initial value:
= [
'id' => 'setId',
'org_id' => 'setOrgId',
'org' => 'setOrg',
'name' => 'setName',
'owner_id' => 'setOwnerId',
'description' => 'setDescription',
'status' => 'setStatus',
'labels' => 'setLabels',
'authorization_id' => 'setAuthorizationId',
'flux' => 'setFlux',
'every' => 'setEvery',
'cron' => 'setCron',
'offset' => 'setOffset',
'latest_completed' => 'setLatestCompleted',
'last_run_status' => 'setLastRunStatus',
'last_run_error' => 'setLastRunError',
'created_at' => 'setCreatedAt',
'updated_at' => 'setUpdatedAt',
'links' => 'setLinks'
]

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