Task
Table of Contents
- $assignedGenericResources : array<string|int, GenericResourcesItem>|null
- User-defined resources can be either Integer resources (e.g, `SSD=3`) or.
- $createdAt : string|null
- $desiredState : string|null
- $iD : string|null
- The ID of the task.
- $labels : array<string|int, string>|null
- User-defined key/value metadata.
- $name : string|null
- Name of the task.
- $nodeID : string|null
- The ID of the node that this task is on.
- $serviceID : string|null
- The ID of the service this task is part of.
- $slot : int|null
- $spec : TaskSpec|null
- User modifiable task configuration.
- $status : TaskStatus|null
- $updatedAt : string|null
- $version : ObjectVersion|null
- The version number of the object such as node, service, etc. This is needed.
- getAssignedGenericResources() : array<string|int, GenericResourcesItem>|null
- User-defined resources can be either Integer resources (e.g, `SSD=3`) or.
- getCreatedAt() : string|null
- getDesiredState() : string|null
- getID() : string|null
- The ID of the task.
- getLabels() : array<string|int, string>|null
- User-defined key/value metadata.
- getName() : string|null
- Name of the task.
- getNodeID() : string|null
- The ID of the node that this task is on.
- getServiceID() : string|null
- The ID of the service this task is part of.
- getSlot() : int|null
- getSpec() : TaskSpec|null
- User modifiable task configuration.
- getStatus() : TaskStatus|null
- getUpdatedAt() : string|null
- getVersion() : ObjectVersion|null
- The version number of the object such as node, service, etc. This is needed.
- setAssignedGenericResources() : self
- User-defined resources can be either Integer resources (e.g, `SSD=3`) or.
- setCreatedAt() : self
- setDesiredState() : self
- setID() : self
- The ID of the task.
- setLabels() : self
- User-defined key/value metadata.
- setName() : self
- Name of the task.
- setNodeID() : self
- The ID of the node that this task is on.
- setServiceID() : self
- The ID of the service this task is part of.
- setSlot() : self
- setSpec() : self
- User modifiable task configuration.
- setStatus() : self
- setUpdatedAt() : self
- setVersion() : self
- The version number of the object such as node, service, etc. This is needed.
Properties
$assignedGenericResources
User-defined resources can be either Integer resources (e.g, `SSD=3`) or.
protected
array<string|int, GenericResourcesItem>|null
$assignedGenericResources
$createdAt
protected
string|null
$createdAt
$desiredState
protected
string|null
$desiredState
$iD
The ID of the task.
protected
string|null
$iD
$labels
User-defined key/value metadata.
protected
array<string|int, string>|null
$labels
$name
Name of the task.
protected
string|null
$name
$nodeID
The ID of the node that this task is on.
protected
string|null
$nodeID
$serviceID
The ID of the service this task is part of.
protected
string|null
$serviceID
$slot
protected
int|null
$slot
$spec
User modifiable task configuration.
protected
TaskSpec|null
$spec
$status
protected
TaskStatus|null
$status
$updatedAt
protected
string|null
$updatedAt
$version
The version number of the object such as node, service, etc. This is needed.
protected
ObjectVersion|null
$version
Methods
getAssignedGenericResources()
User-defined resources can be either Integer resources (e.g, `SSD=3`) or.
public
getAssignedGenericResources() : array<string|int, GenericResourcesItem>|null
Return values
array<string|int, GenericResourcesItem>|null —getCreatedAt()
public
getCreatedAt() : string|null
Return values
string|null —getDesiredState()
public
getDesiredState() : string|null
Return values
string|null —getID()
The ID of the task.
public
getID() : string|null
Return values
string|null —getLabels()
User-defined key/value metadata.
public
getLabels() : array<string|int, string>|null
Return values
array<string|int, string>|null —getName()
Name of the task.
public
getName() : string|null
Return values
string|null —getNodeID()
The ID of the node that this task is on.
public
getNodeID() : string|null
Return values
string|null —getServiceID()
The ID of the service this task is part of.
public
getServiceID() : string|null
Return values
string|null —getSlot()
public
getSlot() : int|null
Return values
int|null —getSpec()
User modifiable task configuration.
public
getSpec() : TaskSpec|null
Return values
TaskSpec|null —getStatus()
public
getStatus() : TaskStatus|null
Return values
TaskStatus|null —getUpdatedAt()
public
getUpdatedAt() : string|null
Return values
string|null —getVersion()
The version number of the object such as node, service, etc. This is needed.
public
getVersion() : ObjectVersion|null
overwrite each other.
Return values
ObjectVersion|null —setAssignedGenericResources()
User-defined resources can be either Integer resources (e.g, `SSD=3`) or.
public
setAssignedGenericResources(array<string|int, GenericResourcesItem>|null $assignedGenericResources) : self
Parameters
- $assignedGenericResources : array<string|int, GenericResourcesItem>|null
Return values
self —setCreatedAt()
public
setCreatedAt(string|null $createdAt) : self
Parameters
- $createdAt : string|null
Return values
self —setDesiredState()
public
setDesiredState(string|null $desiredState) : self
Parameters
- $desiredState : string|null
Return values
self —setID()
The ID of the task.
public
setID(string|null $iD) : self
Parameters
- $iD : string|null
Return values
self —setLabels()
User-defined key/value metadata.
public
setLabels(array<string|int, string>|null $labels) : self
Parameters
- $labels : array<string|int, string>|null
Return values
self —setName()
Name of the task.
public
setName(string|null $name) : self
Parameters
- $name : string|null
Return values
self —setNodeID()
The ID of the node that this task is on.
public
setNodeID(string|null $nodeID) : self
Parameters
- $nodeID : string|null
Return values
self —setServiceID()
The ID of the service this task is part of.
public
setServiceID(string|null $serviceID) : self
Parameters
- $serviceID : string|null
Return values
self —setSlot()
public
setSlot(int|null $slot) : self
Parameters
- $slot : int|null
Return values
self —setSpec()
User modifiable task configuration.
public
setSpec(TaskSpec|null $spec) : self
Parameters
- $spec : TaskSpec|null
Return values
self —setStatus()
public
setStatus(TaskStatus|null $status) : self
Parameters
- $status : TaskStatus|null
Return values
self —setUpdatedAt()
public
setUpdatedAt(string|null $updatedAt) : self
Parameters
- $updatedAt : string|null
Return values
self —setVersion()
The version number of the object such as node, service, etc. This is needed.
public
setVersion(ObjectVersion|null $version) : self
overwrite each other.
Parameters
- $version : ObjectVersion|null