org.apache.mesos

Interface Protos.DrainConfigOrBuilder

All Known Implementing Classes:

Protos.DrainConfig, Protos.DrainConfig.Builder

Enclosing class:

Protos

public static interface Protos.DrainConfigOrBuilder

Method Summary

Modifier and Type	Method and Description
boolean	getMarkGone() Whether or not this agent will be removed permanently from the cluster when draining is complete.
Protos.DurationInfo	getMaxGracePeriod() An upper bound for tasks with a KillPolicy.
Protos.DurationInfoOrBuilder	getMaxGracePeriodOrBuilder() An upper bound for tasks with a KillPolicy.
boolean	hasMarkGone() Whether or not this agent will be removed permanently from the cluster when draining is complete.
boolean	hasMaxGracePeriod() An upper bound for tasks with a KillPolicy.

Method Detail

hasMaxGracePeriod

boolean hasMaxGracePeriod()

 An upper bound for tasks with a KillPolicy.
 If a task has a KillPolicy grace period greater than this value, this value
 will be used instead. This allows the operator to limit the maximum time it
 will take the agent to drain. If this field is unset, the task's KillPolicy
 or the executor's default grace period is used.
 NOTE: Grace periods start when the executor receives the associated kill.
 If, for example, the agent is unreachable when this call is made,
 tasks will still receive their full grace period to kill gracefully.
 

optional .mesos.DurationInfo max_grace_period = 1;

getMaxGracePeriod

Protos.DurationInfo getMaxGracePeriod()

 An upper bound for tasks with a KillPolicy.
 If a task has a KillPolicy grace period greater than this value, this value
 will be used instead. This allows the operator to limit the maximum time it
 will take the agent to drain. If this field is unset, the task's KillPolicy
 or the executor's default grace period is used.
 NOTE: Grace periods start when the executor receives the associated kill.
 If, for example, the agent is unreachable when this call is made,
 tasks will still receive their full grace period to kill gracefully.
 

optional .mesos.DurationInfo max_grace_period = 1;

getMaxGracePeriodOrBuilder

Protos.DurationInfoOrBuilder getMaxGracePeriodOrBuilder()

 An upper bound for tasks with a KillPolicy.
 If a task has a KillPolicy grace period greater than this value, this value
 will be used instead. This allows the operator to limit the maximum time it
 will take the agent to drain. If this field is unset, the task's KillPolicy
 or the executor's default grace period is used.
 NOTE: Grace periods start when the executor receives the associated kill.
 If, for example, the agent is unreachable when this call is made,
 tasks will still receive their full grace period to kill gracefully.
 

optional .mesos.DurationInfo max_grace_period = 1;

hasMarkGone

boolean hasMarkGone()

 Whether or not this agent will be removed permanently from the cluster when
 draining is complete. This transition is automatic and does **NOT** require
 a separate call to `MarkAgentGone`. If this field is unset, then the
 default value of `false` is used.
 Compared to `MarkAgentGone`, which is used for unreachable agents,
 marking agents gone after draining will respect kill policies.
 To notify frameworks, tasks terminated during draining will return
 a `TASK_GONE_BY_OPERATOR` status update instead of any other terminal
 status. Executors will not need to account for this case, because
 the terminal status update will be intercepted and modified by the agent.
 

optional bool mark_gone = 2 [default = false];

getMarkGone

boolean getMarkGone()

 Whether or not this agent will be removed permanently from the cluster when
 draining is complete. This transition is automatic and does **NOT** require
 a separate call to `MarkAgentGone`. If this field is unset, then the
 default value of `false` is used.
 Compared to `MarkAgentGone`, which is used for unreachable agents,
 marking agents gone after draining will respect kill policies.
 To notify frameworks, tasks terminated during draining will return
 a `TASK_GONE_BY_OPERATOR` status update instead of any other terminal
 status. Executors will not need to account for this case, because
 the terminal status update will be intercepted and modified by the agent.
 

optional bool mark_gone = 2 [default = false];