com.mesosphere.sdk.offer.taskdata

Class TaskLabelReader

java.lang.Object

com.mesosphere.sdk.offer.taskdata.TaskLabelReader

public class TaskLabelReader
extends java.lang.Object

Provides read access to task labels which are (only) read by the Scheduler.

Constructor Summary

Constructors

Constructor and Description
TaskLabelReader(TaskInfo.Builder taskInfoBuilder)
TaskLabelReader(TaskInfo taskInfo)

Method Summary

Modifier and Type	Method and Description
java.lang.String	getHostname() Returns the hostname of the agent machine running the task.
int	getIndex() Returns the pod instance index of the task, or throws TaskException if no index data was found.
java.util.List<java.lang.String>	getOfferAttributeStrings() Returns the string representations of any Offer Attributes which were embedded in the task.
java.util.Optional<java.lang.String>	getRegion() Returns the Region in which the Task was launched.
java.util.UUID	getTargetConfiguration() Returns the ID referencing a configuration in a ConfigStore associated with the task.
java.lang.String	getType() Returns the task type string, which was embedded in the task.
java.util.Optional<java.lang.String>	getZone() Returns the Zone in which the Task was launched.
boolean	hasReadinessCheckLabel() Returns whether the task has a readiness check label.
boolean	isPermanentlyFailed() Returns whether the task is marked as permanently failed.
boolean	isReadinessCheckSucceeded(TaskStatus taskStatus) Returns whether or not a readiness check succeeded.
boolean	isTransient() Returns whether the task is marked as transient.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

TaskLabelReader

public TaskLabelReader(TaskInfo taskInfo)

See Also:

LabelReader.LabelReader(String, Labels)

TaskLabelReader

public TaskLabelReader(TaskInfo.Builder taskInfoBuilder)

See Also:

LabelReader.LabelReader(String, Labels)

Method Detail

getType

public java.lang.String getType()
                         throws TaskException

Returns the task type string, which was embedded in the task.

Throws:

TaskException - if the type could not be found.

getIndex

public int getIndex()
             throws TaskException,
                    java.lang.NumberFormatException

Returns the pod instance index of the task, or throws TaskException if no index data was found.

Throws:

TaskException - if the index data wasn't found

java.lang.NumberFormatException - if parsing the index as an integer failed

getOfferAttributeStrings

public java.util.List<java.lang.String> getOfferAttributeStrings()

Returns the string representations of any Offer Attributes which were embedded in the task.

getZone

public java.util.Optional<java.lang.String> getZone()

Returns the Zone in which the Task was launched.

getRegion

public java.util.Optional<java.lang.String> getRegion()

Returns the Region in which the Task was launched.

getHostname

public java.lang.String getHostname()
                             throws TaskException

Returns the hostname of the agent machine running the task.

Throws:

TaskException

getTargetConfiguration

public java.util.UUID getTargetConfiguration()
                                      throws TaskException

Returns the ID referencing a configuration in a ConfigStore associated with the task.

Returns:

the ID of the target configuration for the provided TaskInfo

Throws:

TaskException - when a TaskInfo is provided which does not contain a Label with an indicated target configuration

isReadinessCheckSucceeded

public boolean isReadinessCheckSucceeded(TaskStatus taskStatus)

Returns whether or not a readiness check succeeded. If the indicated TaskInfo does not have a readiness check, then this method indicates that the readiness check has passed. Otherwise failures to parse readiness checks are interpreted as readiness check failures. If some value other than "true" is present in the readiness check label of the TaskStatus, the readiness check has failed.

Parameters:

taskStatus - A TaskStatus which may or may not contain a readiness check outcome label

Returns:

the result of a readiness check for the indicated TaskStatus

isTransient

public boolean isTransient()

Returns whether the task is marked as transient. This identifies a 'task' which isn't actually launched, but is instead created to fill reserved resources.

isPermanentlyFailed

public boolean isPermanentlyFailed()

Returns whether the task is marked as permanently failed. This is intentionally stored in the TaskInfo as it will be automatically overwritten when the TaskInfo is replaced.

hasReadinessCheckLabel

public boolean hasReadinessCheckLabel()

Returns whether the task has a readiness check label.