com.mesosphere.sdk.offer.taskdata

Class TaskLabelWriter

java.lang.Object

com.mesosphere.sdk.offer.taskdata.TaskLabelWriter

public class TaskLabelWriter
extends java.lang.Object

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

Constructor Summary

Constructors

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

Method Summary

Modifier and Type	Method and Description
protected java.util.Optional<HealthCheck>	getReadinessCheck() Returns the embedded readiness check, or an empty Optional if no readiness check is configured.
TaskLabelWriter	setGoalState(GoalState goalState) Sets a label on a TaskInfo indicating the Task's GoalState, e.g.
TaskLabelWriter	setHostname(Offer launchOffer) Stores the agent hostname from the provided Offer.
TaskLabelWriter	setIndex(int index) Assigns the pod instance index to the provided task.
TaskLabelWriter	setOfferAttributes(Offer launchOffer) Stores the Attributes from the provided Offer.
TaskLabelWriter	setPermanentlyFailed() Ensures that the task is identified as permanently failed.
TaskLabelWriter	setReadinessCheck(HealthCheck readinessCheck) Stores an encoded version of the HealthCheck as a readiness check.
TaskLabelWriter	setReadinessCheckEnvvar(java.lang.String key, java.lang.String value) Updates the stored readiness check, if any, to have the provided environment variable.
TaskLabelWriter	setRegion(Protos.DomainInfo.FaultDomain.RegionInfo region) Stores the org.apache.mesos.Protos.DomainInfo.FaultDomain.RegionInfo.
TaskLabelWriter	setTargetConfiguration(java.util.UUID targetConfigurationId) Sets a Label indicating the target configuration.
TaskLabelWriter	setTransient() Ensures that the task is identified as a transient task.
TaskLabelWriter	setType(java.lang.String taskType) Stores the provided task type string.
TaskLabelWriter	setZone(Protos.DomainInfo.FaultDomain.ZoneInfo zone) Stores the org.apache.mesos.Protos.DomainInfo.FaultDomain.ZoneInfo.
Labels	toProto() Returns a protobuf representation of all contained label entries.

Methods inherited from class java.lang.Object

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

Constructor Detail

TaskLabelWriter

public TaskLabelWriter(TaskInfo taskInfo)

See Also:

LabelWriter.LabelWriter(Labels)

TaskLabelWriter

public TaskLabelWriter(TaskInfo.Builder taskInfoBuilder)

See Also:

LabelWriter.LabelWriter(Labels)

Method Detail

setTransient

public TaskLabelWriter setTransient()

Ensures that the task is identified as a transient task. This is a "task" which is never launched, only passed to Mesos as a way to capture some resources. This is used for e.g. reserving space to run sidecar tasks.

setPermanentlyFailed

public TaskLabelWriter setPermanentlyFailed()

Ensures that the task is identified as permanently failed. This is intentionally stored in the TaskInfo as it will be automatically overwritten when the TaskInfo is replaced. As such it will automatically be "cleared" when the TaskInfo is regenerated in the offer cycle.

setType

public TaskLabelWriter setType(java.lang.String taskType)

Stores the provided task type string. Any existing task type is overwritten.

setIndex

public TaskLabelWriter setIndex(int index)

Assigns the pod instance index to the provided task. Any existing index is overwritten.

setOfferAttributes

public TaskLabelWriter setOfferAttributes(Offer launchOffer)

Stores the Attributes from the provided Offer. Any existing stored attributes are overwritten.

setZone

public TaskLabelWriter setZone(Protos.DomainInfo.FaultDomain.ZoneInfo zone)

Stores the org.apache.mesos.Protos.DomainInfo.FaultDomain.ZoneInfo. Any existing stored zone information is overwritten.

setRegion

public TaskLabelWriter setRegion(Protos.DomainInfo.FaultDomain.RegionInfo region)

Stores the org.apache.mesos.Protos.DomainInfo.FaultDomain.RegionInfo. Any existing stored region information is overwritten.

setHostname

public TaskLabelWriter setHostname(Offer launchOffer)

Stores the agent hostname from the provided Offer. Any existing stored hostname is overwritten.

setGoalState

public TaskLabelWriter setGoalState(GoalState goalState)

Sets a label on a TaskInfo indicating the Task's GoalState, e.g. RUNNING, FINISH or ONCE.

setTargetConfiguration

public TaskLabelWriter setTargetConfiguration(java.util.UUID targetConfigurationId)

Sets a Label indicating the target configuration.

Parameters:

targetConfigurationId - ID referencing a particular Configuration in the ConfigStore

setReadinessCheck

public TaskLabelWriter setReadinessCheck(HealthCheck readinessCheck)

Stores an encoded version of the HealthCheck as a readiness check. Any existing stored readiness check is overwritten.

setReadinessCheckEnvvar

public TaskLabelWriter setReadinessCheckEnvvar(java.lang.String key,
                                               java.lang.String value)
                                        throws TaskException

Updates the stored readiness check, if any, to have the provided environment variable. Does nothing if no readiness check is present.

Throws:

TaskException - if parsing a previously set HealthCheck

toProto

public Labels toProto()

Returns a protobuf representation of all contained label entries.

getReadinessCheck

protected java.util.Optional<HealthCheck> getReadinessCheck()
                                                     throws TaskException

Returns the embedded readiness check, or an empty Optional if no readiness check is configured.

Throws:

TaskException