org.apache.mesos

Class Protos.DrainConfig

java.lang.Object

com.google.protobuf.GeneratedMessageV3

org.apache.mesos.Protos.DrainConfig

All Implemented Interfaces:

Protos.DrainConfigOrBuilder

Enclosing class:

Protos

public static final class Protos.DrainConfig
extends com.google.protobuf.GeneratedMessageV3
implements Protos.DrainConfigOrBuilder

Protobuf type mesos.DrainConfig

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	Protos.DrainConfig.Builder Protobuf type mesos.DrainConfig

Field Summary

Fields

Modifier and Type	Field and Description
static int	MARK_GONE_FIELD_NUMBER
static int	MAX_GRACE_PERIOD_FIELD_NUMBER
static <any>	PARSER Deprecated.

Method Summary

Modifier and Type	Method and Description
boolean	equals(java.lang.Object obj)
static Protos.DrainConfig	getDefaultInstance()
Protos.DrainConfig	getDefaultInstanceForType()
static com.google.protobuf.Descriptors.Descriptor	getDescriptor()
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.
<any>	getParserForType()
int	getSerializedSize()
com.google.protobuf.UnknownFieldSet	getUnknownFields()
int	hashCode()
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.
protected com.google.protobuf.GeneratedMessageV3.FieldAccessorTable	internalGetFieldAccessorTable()
boolean	isInitialized()
static Protos.DrainConfig.Builder	newBuilder()
static Protos.DrainConfig.Builder	newBuilder(Protos.DrainConfig prototype)
Protos.DrainConfig.Builder	newBuilderForType()
protected Protos.DrainConfig.Builder	newBuilderForType(com.google.protobuf.GeneratedMessageV3.BuilderParent parent)
static Protos.DrainConfig	parseDelimitedFrom(java.io.InputStream input)
static Protos.DrainConfig	parseDelimitedFrom(java.io.InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
static Protos.DrainConfig	parseFrom(byte[] data, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
static Protos.DrainConfig	parseFrom(java.nio.ByteBuffer data)
static Protos.DrainConfig	parseFrom(java.nio.ByteBuffer data, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
static Protos.DrainConfig	parseFrom(com.google.protobuf.ByteString data)
static Protos.DrainConfig	parseFrom(com.google.protobuf.ByteString data, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
static Protos.DrainConfig	parseFrom(com.google.protobuf.CodedInputStream input)
static Protos.DrainConfig	parseFrom(com.google.protobuf.CodedInputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
static Protos.DrainConfig	parseFrom(java.io.InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
static <any>	parser()
Protos.DrainConfig.Builder	toBuilder()
void	writeTo(com.google.protobuf.CodedOutputStream output)

Methods inherited from class java.lang.Object

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

Field Detail

MAX_GRACE_PERIOD_FIELD_NUMBER

public static final int MAX_GRACE_PERIOD_FIELD_NUMBER

See Also:

Constant Field Values

MARK_GONE_FIELD_NUMBER

public static final int MARK_GONE_FIELD_NUMBER

See Also:

Constant Field Values

PARSER

@Deprecated
public static final <any> PARSER

Deprecated.

Method Detail

getUnknownFields

public final com.google.protobuf.UnknownFieldSet getUnknownFields()

getDescriptor

public static final com.google.protobuf.Descriptors.Descriptor getDescriptor()

internalGetFieldAccessorTable

protected com.google.protobuf.GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()

hasMaxGracePeriod

public 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;

Specified by:

hasMaxGracePeriod in interface Protos.DrainConfigOrBuilder

getMaxGracePeriod

public 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;

Specified by:

getMaxGracePeriod in interface Protos.DrainConfigOrBuilder

getMaxGracePeriodOrBuilder

public 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;

Specified by:

getMaxGracePeriodOrBuilder in interface Protos.DrainConfigOrBuilder

hasMarkGone

public 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];

Specified by:

hasMarkGone in interface Protos.DrainConfigOrBuilder

getMarkGone

public 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];

Specified by:

getMarkGone in interface Protos.DrainConfigOrBuilder

isInitialized

public final boolean isInitialized()

writeTo

public void writeTo(com.google.protobuf.CodedOutputStream output)
             throws java.io.IOException

Throws:

java.io.IOException

getSerializedSize

public int getSerializedSize()

equals

public boolean equals(java.lang.Object obj)

hashCode

public int hashCode()

parseFrom

public static Protos.DrainConfig parseFrom(java.nio.ByteBuffer data)
                                    throws com.google.protobuf.InvalidProtocolBufferException

Throws:

com.google.protobuf.InvalidProtocolBufferException

parseFrom

public static Protos.DrainConfig parseFrom(java.nio.ByteBuffer data,
                                           com.google.protobuf.ExtensionRegistryLite extensionRegistry)
                                    throws com.google.protobuf.InvalidProtocolBufferException

Throws:

com.google.protobuf.InvalidProtocolBufferException

parseFrom

public static Protos.DrainConfig parseFrom(com.google.protobuf.ByteString data)
                                    throws com.google.protobuf.InvalidProtocolBufferException

Throws:

com.google.protobuf.InvalidProtocolBufferException

parseFrom

public static Protos.DrainConfig parseFrom(com.google.protobuf.ByteString data,
                                           com.google.protobuf.ExtensionRegistryLite extensionRegistry)
                                    throws com.google.protobuf.InvalidProtocolBufferException

Throws:

com.google.protobuf.InvalidProtocolBufferException

parseFrom

public static Protos.DrainConfig parseFrom(byte[] data,
                                           com.google.protobuf.ExtensionRegistryLite extensionRegistry)
                                    throws com.google.protobuf.InvalidProtocolBufferException

Throws:

com.google.protobuf.InvalidProtocolBufferException

parseFrom

public static Protos.DrainConfig parseFrom(java.io.InputStream input,
                                           com.google.protobuf.ExtensionRegistryLite extensionRegistry)
                                    throws java.io.IOException

Throws:

java.io.IOException

parseDelimitedFrom

public static Protos.DrainConfig parseDelimitedFrom(java.io.InputStream input)
                                             throws java.io.IOException

Throws:

java.io.IOException

parseDelimitedFrom

public static Protos.DrainConfig parseDelimitedFrom(java.io.InputStream input,
                                                    com.google.protobuf.ExtensionRegistryLite extensionRegistry)
                                             throws java.io.IOException

Throws:

java.io.IOException

parseFrom

public static Protos.DrainConfig parseFrom(com.google.protobuf.CodedInputStream input)
                                    throws java.io.IOException

Throws:

java.io.IOException

parseFrom

public static Protos.DrainConfig parseFrom(com.google.protobuf.CodedInputStream input,
                                           com.google.protobuf.ExtensionRegistryLite extensionRegistry)
                                    throws java.io.IOException

Throws:

java.io.IOException

newBuilderForType

public Protos.DrainConfig.Builder newBuilderForType()

newBuilder

public static Protos.DrainConfig.Builder newBuilder()

newBuilder

public static Protos.DrainConfig.Builder newBuilder(Protos.DrainConfig prototype)

toBuilder

public Protos.DrainConfig.Builder toBuilder()

newBuilderForType

protected Protos.DrainConfig.Builder newBuilderForType(com.google.protobuf.GeneratedMessageV3.BuilderParent parent)

getDefaultInstance

public static Protos.DrainConfig getDefaultInstance()

parser

public static <any> parser()

getParserForType

public <any> getParserForType()

getDefaultInstanceForType

public Protos.DrainConfig getDefaultInstanceForType()