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

Public Member Functions

 getModelName ()
 
 getStatusAllowableValues ()
 
 __construct (array $data=null)
 
 listInvalidProperties ()
 
 valid ()
 
 getId ()
 
 setId ($id)
 
 getTaskId ()
 
 setTaskId ($task_id)
 
 getStatus ()
 
 setStatus ($status)
 
 getScheduledFor ()
 
 setScheduledFor ($scheduled_for)
 
 getLog ()
 
 setLog ($log)
 
 getFlux ()
 
 setFlux ($flux)
 
 getStartedAt ()
 
 setStartedAt ($started_at)
 
 getFinishedAt ()
 
 setFinishedAt ($finished_at)
 
 getRequestedAt ()
 
 setRequestedAt ($requested_at)
 
 getLinks ()
 
 setLinks ($links)
 
 offsetExists ($offset)
 
 offsetGet ($offset)
 
 offsetSet ($offset, $value)
 
 offsetUnset ($offset)
 
 __toString ()
 
 getModelName ()
 
 listInvalidProperties ()
 
 valid ()
 

Static Public Member Functions

static openAPITypes ()
 
static openAPIFormats ()
 
static attributeMap ()
 
static setters ()
 
static getters ()
 
static openAPITypes ()
 
static openAPIFormats ()
 
static attributeMap ()
 
static setters ()
 
static getters ()
 

Public Attributes

const DISCRIMINATOR = null
 
const STATUS_SCHEDULED = 'scheduled'
 
const STATUS_STARTED = 'started'
 
const STATUS_FAILED = 'failed'
 
const STATUS_SUCCESS = 'success'
 
const STATUS_CANCELED = 'canceled'
 

Protected Attributes

 $container = []
 

Static Protected Attributes

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

Constructor & Destructor Documentation

◆ __construct()

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

Constructor

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

Member Function Documentation

◆ __toString()

InfluxDB2\Model\Run::__toString ( )

Gets the string presentation of the object

Returns
string

◆ attributeMap()

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

◆ getFinishedAt()

InfluxDB2\Model\Run::getFinishedAt ( )

Gets finished_at

Returns
\DateTime|null

◆ getFlux()

InfluxDB2\Model\Run::getFlux ( )

Gets flux

Returns
string|null

◆ getId()

InfluxDB2\Model\Run::getId ( )

Gets id

Returns
string|null

◆ getLinks()

InfluxDB2\Model\Run::getLinks ( )

Gets links

Returns
\InfluxDB2\Model\RunLinks|null

◆ getLog()

InfluxDB2\Model\Run::getLog ( )

Gets log

Returns
\InfluxDB2\Model\LogEvent[]|null

◆ getModelName()

InfluxDB2\Model\Run::getModelName ( )

The original name of the model.

Returns
string

Implements InfluxDB2\Model\ModelInterface.

◆ getRequestedAt()

InfluxDB2\Model\Run::getRequestedAt ( )

Gets requested_at

Returns
\DateTime|null

◆ getScheduledFor()

InfluxDB2\Model\Run::getScheduledFor ( )

Gets scheduled_for

Returns
\DateTime|null

◆ getStartedAt()

InfluxDB2\Model\Run::getStartedAt ( )

Gets started_at

Returns
\DateTime|null

◆ getStatus()

InfluxDB2\Model\Run::getStatus ( )

Gets status

Returns
string|null

◆ getStatusAllowableValues()

InfluxDB2\Model\Run::getStatusAllowableValues ( )

Gets allowable values of the enum

Returns
string[]

◆ getTaskId()

InfluxDB2\Model\Run::getTaskId ( )

Gets task_id

Returns
string|null

◆ getters()

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

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

Returns
array

Implements InfluxDB2\Model\ModelInterface.

◆ listInvalidProperties()

InfluxDB2\Model\Run::listInvalidProperties ( )

Show all the invalid properties with reasons.

Returns
array invalid properties with reasons

Implements InfluxDB2\Model\ModelInterface.

◆ offsetExists()

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

Returns true if offset exists. False otherwise.

Parameters
integer$offsetOffset
Returns
boolean

◆ offsetGet()

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

Gets offset.

Parameters
integer$offsetOffset
Returns
mixed

◆ offsetSet()

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

Sets value based on offset.

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

◆ offsetUnset()

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

Unsets offset.

Parameters
integer$offsetOffset
Returns
void

◆ openAPIFormats()

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

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

Returns
array

Implements InfluxDB2\Model\ModelInterface.

◆ openAPITypes()

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

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

Returns
array

Implements InfluxDB2\Model\ModelInterface.

◆ setFinishedAt()

InfluxDB2\Model\Run::setFinishedAt (   $finished_at)

Sets finished_at

Parameters
\DateTime | null$finished_atThe time (RFC3339Nano date/time format) the run finished executing.
Returns
$this

◆ setFlux()

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

Sets flux

Parameters
string | null$fluxFlux used for the task
Returns
$this

◆ setId()

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

Sets id

Parameters
string | null$idid
Returns
$this

◆ setLinks()

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

Sets links

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

◆ setLog()

InfluxDB2\Model\Run::setLog (   $log)

Sets log

Parameters
\InfluxDB2\Model\LogEvent[] | null$logAn array of logs associated with the run.
Returns
$this

◆ setRequestedAt()

InfluxDB2\Model\Run::setRequestedAt (   $requested_at)

Sets requested_at

Parameters
\DateTime | null$requested_atThe time (RFC3339Nano date/time format) the run was manually requested.
Returns
$this

◆ setScheduledFor()

InfluxDB2\Model\Run::setScheduledFor (   $scheduled_for)

Sets scheduled_for

Parameters
\DateTime | null$scheduled_forThe time RFC3339 date/time format used for the run's now option.
Returns
$this

◆ setStartedAt()

InfluxDB2\Model\Run::setStartedAt (   $started_at)

Sets started_at

Parameters
\DateTime | null$started_atThe time (RFC3339Nano date/time format) the run started executing.
Returns
$this

◆ setStatus()

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

Sets status

Parameters
string | null$statusstatus
Returns
$this

◆ setTaskId()

InfluxDB2\Model\Run::setTaskId (   $task_id)

Sets task_id

Parameters
string | null$task_idtask_id
Returns
$this

◆ setters()

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

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

Returns
array

Implements InfluxDB2\Model\ModelInterface.

◆ valid()

InfluxDB2\Model\Run::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\Run::$attributeMap
staticprotected
Initial value:
= [
'id' => 'id',
'task_id' => 'taskID',
'status' => 'status',
'scheduled_for' => 'scheduledFor',
'log' => 'log',
'flux' => 'flux',
'started_at' => 'startedAt',
'finished_at' => 'finishedAt',
'requested_at' => 'requestedAt',
'links' => 'links'
]

◆ $getters

InfluxDB2\Model\Run::$getters
staticprotected
Initial value:
= [
'id' => 'getId',
'task_id' => 'getTaskId',
'status' => 'getStatus',
'scheduled_for' => 'getScheduledFor',
'log' => 'getLog',
'flux' => 'getFlux',
'started_at' => 'getStartedAt',
'finished_at' => 'getFinishedAt',
'requested_at' => 'getRequestedAt',
'links' => 'getLinks'
]

◆ $openAPIFormats

InfluxDB2\Model\Run::$openAPIFormats
staticprotected
Initial value:
= [
'id' => null,
'task_id' => null,
'status' => null,
'scheduled_for' => 'date-time',
'log' => null,
'flux' => null,
'started_at' => 'date-time',
'finished_at' => 'date-time',
'requested_at' => 'date-time',
'links' => null
]

◆ $openAPITypes

InfluxDB2\Model\Run::$openAPITypes
staticprotected
Initial value:
= [
'id' => 'string',
'task_id' => 'string',
'status' => 'string',
'scheduled_for' => '\DateTime',
'log' => '\InfluxDB2\Model\LogEvent[]',
'flux' => 'string',
'started_at' => '\DateTime',
'finished_at' => '\DateTime',
'requested_at' => '\DateTime',
'links' => '\InfluxDB2\Model\RunLinks'
]

◆ $setters

InfluxDB2\Model\Run::$setters
staticprotected
Initial value:
= [
'id' => 'setId',
'task_id' => 'setTaskId',
'status' => 'setStatus',
'scheduled_for' => 'setScheduledFor',
'log' => 'setLog',
'flux' => 'setFlux',
'started_at' => 'setStartedAt',
'finished_at' => 'setFinishedAt',
'requested_at' => 'setRequestedAt',
'links' => 'setLinks'
]

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