org.apache.mesos

Class Protos.HealthCheck

java.lang.Object

com.google.protobuf.GeneratedMessageV3

org.apache.mesos.Protos.HealthCheck

All Implemented Interfaces:

Protos.HealthCheckOrBuilder

Enclosing class:

Protos

public static final class Protos.HealthCheck
extends com.google.protobuf.GeneratedMessageV3
implements Protos.HealthCheckOrBuilder

 Describes a health check for a task or executor (or any arbitrary
 process/command). A type is picked by specifying one of the
 optional fields. Specifying more than one type is an error.
 

Protobuf type mesos.HealthCheck

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	Protos.HealthCheck.Builder Describes a health check for a task or executor (or any arbitrary process/command).
static class	Protos.HealthCheck.HTTPCheckInfo Describes an HTTP health check.
static interface	Protos.HealthCheck.HTTPCheckInfoOrBuilder
static class	Protos.HealthCheck.TCPCheckInfo Describes a TCP health check, i.e.
static interface	Protos.HealthCheck.TCPCheckInfoOrBuilder
static class	Protos.HealthCheck.Type Protobuf enum mesos.HealthCheck.Type

Field Summary

Fields

Modifier and Type	Field and Description
static int	COMMAND_FIELD_NUMBER
static int	CONSECUTIVE_FAILURES_FIELD_NUMBER
static int	DELAY_SECONDS_FIELD_NUMBER
static int	GRACE_PERIOD_SECONDS_FIELD_NUMBER
static int	HTTP_FIELD_NUMBER
static int	INTERVAL_SECONDS_FIELD_NUMBER
static <any>	PARSER Deprecated.
static int	TCP_FIELD_NUMBER
static int	TIMEOUT_SECONDS_FIELD_NUMBER
static int	TYPE_FIELD_NUMBER

Method Summary

Modifier and Type	Method and Description
boolean	equals(java.lang.Object obj)
Protos.CommandInfo	getCommand() Command health check.
Protos.CommandInfoOrBuilder	getCommandOrBuilder() Command health check.
int	getConsecutiveFailures() Number of consecutive failures until the task is killed by the executor.
static Protos.HealthCheck	getDefaultInstance()
Protos.HealthCheck	getDefaultInstanceForType()
double	getDelaySeconds() Amount of time to wait to start health checking the task after it transitions to `TASK_RUNNING` or `TASK_STATING` if the latter is used by the executor.
static com.google.protobuf.Descriptors.Descriptor	getDescriptor()
double	getGracePeriodSeconds() Amount of time after the task is launched during which health check failures are ignored.
Protos.HealthCheck.HTTPCheckInfo	getHttp() HTTP health check.
Protos.HealthCheck.HTTPCheckInfoOrBuilder	getHttpOrBuilder() HTTP health check.
double	getIntervalSeconds() Interval between health checks, i.e., amount of time to wait after the previous health check finished or timed out to start the next health check.
<any>	getParserForType()
int	getSerializedSize()
Protos.HealthCheck.TCPCheckInfo	getTcp() TCP health check.
Protos.HealthCheck.TCPCheckInfoOrBuilder	getTcpOrBuilder() TCP health check.
double	getTimeoutSeconds() Amount of time to wait for the health check to complete.
Protos.HealthCheck.Type	getType() The type of health check.
com.google.protobuf.UnknownFieldSet	getUnknownFields()
boolean	hasCommand() Command health check.
boolean	hasConsecutiveFailures() Number of consecutive failures until the task is killed by the executor.
boolean	hasDelaySeconds() Amount of time to wait to start health checking the task after it transitions to `TASK_RUNNING` or `TASK_STATING` if the latter is used by the executor.
boolean	hasGracePeriodSeconds() Amount of time after the task is launched during which health check failures are ignored.
int	hashCode()
boolean	hasHttp() HTTP health check.
boolean	hasIntervalSeconds() Interval between health checks, i.e., amount of time to wait after the previous health check finished or timed out to start the next health check.
boolean	hasTcp() TCP health check.
boolean	hasTimeoutSeconds() Amount of time to wait for the health check to complete.
boolean	hasType() The type of health check.
protected com.google.protobuf.GeneratedMessageV3.FieldAccessorTable	internalGetFieldAccessorTable()
boolean	isInitialized()
static Protos.HealthCheck.Builder	newBuilder()
static Protos.HealthCheck.Builder	newBuilder(Protos.HealthCheck prototype)
Protos.HealthCheck.Builder	newBuilderForType()
protected Protos.HealthCheck.Builder	newBuilderForType(com.google.protobuf.GeneratedMessageV3.BuilderParent parent)
static Protos.HealthCheck	parseDelimitedFrom(java.io.InputStream input)
static Protos.HealthCheck	parseDelimitedFrom(java.io.InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
static Protos.HealthCheck	parseFrom(byte[] data, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
static Protos.HealthCheck	parseFrom(java.nio.ByteBuffer data)
static Protos.HealthCheck	parseFrom(java.nio.ByteBuffer data, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
static Protos.HealthCheck	parseFrom(com.google.protobuf.ByteString data)
static Protos.HealthCheck	parseFrom(com.google.protobuf.ByteString data, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
static Protos.HealthCheck	parseFrom(com.google.protobuf.CodedInputStream input)
static Protos.HealthCheck	parseFrom(com.google.protobuf.CodedInputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
static Protos.HealthCheck	parseFrom(java.io.InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
static <any>	parser()
Protos.HealthCheck.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

DELAY_SECONDS_FIELD_NUMBER

public static final int DELAY_SECONDS_FIELD_NUMBER

See Also:

Constant Field Values

INTERVAL_SECONDS_FIELD_NUMBER

public static final int INTERVAL_SECONDS_FIELD_NUMBER

See Also:

Constant Field Values

TIMEOUT_SECONDS_FIELD_NUMBER

public static final int TIMEOUT_SECONDS_FIELD_NUMBER

See Also:

Constant Field Values

CONSECUTIVE_FAILURES_FIELD_NUMBER

public static final int CONSECUTIVE_FAILURES_FIELD_NUMBER

See Also:

Constant Field Values

GRACE_PERIOD_SECONDS_FIELD_NUMBER

public static final int GRACE_PERIOD_SECONDS_FIELD_NUMBER

See Also:

Constant Field Values

TYPE_FIELD_NUMBER

public static final int TYPE_FIELD_NUMBER

See Also:

Constant Field Values

COMMAND_FIELD_NUMBER

public static final int COMMAND_FIELD_NUMBER

See Also:

Constant Field Values

HTTP_FIELD_NUMBER

public static final int HTTP_FIELD_NUMBER

See Also:

Constant Field Values

TCP_FIELD_NUMBER

public static final int TCP_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()

hasDelaySeconds

public boolean hasDelaySeconds()

 Amount of time to wait to start health checking the task after it
 transitions to `TASK_RUNNING` or `TASK_STATING` if the latter is
 used by the executor.
 

optional double delay_seconds = 2 [default = 15];

Specified by:

hasDelaySeconds in interface Protos.HealthCheckOrBuilder

getDelaySeconds

public double getDelaySeconds()

 Amount of time to wait to start health checking the task after it
 transitions to `TASK_RUNNING` or `TASK_STATING` if the latter is
 used by the executor.
 

optional double delay_seconds = 2 [default = 15];

Specified by:

getDelaySeconds in interface Protos.HealthCheckOrBuilder

hasIntervalSeconds

public boolean hasIntervalSeconds()

 Interval between health checks, i.e., amount of time to wait after
 the previous health check finished or timed out to start the next
 health check.
 

optional double interval_seconds = 3 [default = 10];

Specified by:

hasIntervalSeconds in interface Protos.HealthCheckOrBuilder

getIntervalSeconds

public double getIntervalSeconds()

 Interval between health checks, i.e., amount of time to wait after
 the previous health check finished or timed out to start the next
 health check.
 

optional double interval_seconds = 3 [default = 10];

Specified by:

getIntervalSeconds in interface Protos.HealthCheckOrBuilder

hasTimeoutSeconds

public boolean hasTimeoutSeconds()

 Amount of time to wait for the health check to complete. After this
 timeout, the health check is aborted and treated as a failure. Zero
 means infinite timeout.
 

optional double timeout_seconds = 4 [default = 20];

Specified by:

hasTimeoutSeconds in interface Protos.HealthCheckOrBuilder

getTimeoutSeconds

public double getTimeoutSeconds()

 Amount of time to wait for the health check to complete. After this
 timeout, the health check is aborted and treated as a failure. Zero
 means infinite timeout.
 

optional double timeout_seconds = 4 [default = 20];

Specified by:

getTimeoutSeconds in interface Protos.HealthCheckOrBuilder

hasConsecutiveFailures

public boolean hasConsecutiveFailures()

 Number of consecutive failures until the task is killed by the executor.
 

optional uint32 consecutive_failures = 5 [default = 3];

Specified by:

hasConsecutiveFailures in interface Protos.HealthCheckOrBuilder

getConsecutiveFailures

public int getConsecutiveFailures()

 Number of consecutive failures until the task is killed by the executor.
 

optional uint32 consecutive_failures = 5 [default = 3];

Specified by:

getConsecutiveFailures in interface Protos.HealthCheckOrBuilder

hasGracePeriodSeconds

public boolean hasGracePeriodSeconds()

 Amount of time after the task is launched during which health check
 failures are ignored. Once a check succeeds for the first time,
 the grace period does not apply anymore. Note that it includes
 `delay_seconds`, i.e., setting `grace_period_seconds` < `delay_seconds`
 has no effect.
 

optional double grace_period_seconds = 6 [default = 10];

Specified by:

hasGracePeriodSeconds in interface Protos.HealthCheckOrBuilder

getGracePeriodSeconds

public double getGracePeriodSeconds()

 Amount of time after the task is launched during which health check
 failures are ignored. Once a check succeeds for the first time,
 the grace period does not apply anymore. Note that it includes
 `delay_seconds`, i.e., setting `grace_period_seconds` < `delay_seconds`
 has no effect.
 

optional double grace_period_seconds = 6 [default = 10];

Specified by:

getGracePeriodSeconds in interface Protos.HealthCheckOrBuilder

hasType

public boolean hasType()

 The type of health check.
 

optional .mesos.HealthCheck.Type type = 8;

Specified by:

hasType in interface Protos.HealthCheckOrBuilder

getType

public Protos.HealthCheck.Type getType()

 The type of health check.
 

optional .mesos.HealthCheck.Type type = 8;

Specified by:

getType in interface Protos.HealthCheckOrBuilder

hasCommand

public boolean hasCommand()

 Command health check.
 

optional .mesos.CommandInfo command = 7;

Specified by:

hasCommand in interface Protos.HealthCheckOrBuilder

getCommand

public Protos.CommandInfo getCommand()

 Command health check.
 

optional .mesos.CommandInfo command = 7;

Specified by:

getCommand in interface Protos.HealthCheckOrBuilder

getCommandOrBuilder

public Protos.CommandInfoOrBuilder getCommandOrBuilder()

 Command health check.
 

optional .mesos.CommandInfo command = 7;

Specified by:

getCommandOrBuilder in interface Protos.HealthCheckOrBuilder

hasHttp

public boolean hasHttp()

 HTTP health check.
 

optional .mesos.HealthCheck.HTTPCheckInfo http = 1;

Specified by:

hasHttp in interface Protos.HealthCheckOrBuilder

getHttp

public Protos.HealthCheck.HTTPCheckInfo getHttp()

 HTTP health check.
 

optional .mesos.HealthCheck.HTTPCheckInfo http = 1;

Specified by:

getHttp in interface Protos.HealthCheckOrBuilder

getHttpOrBuilder

public Protos.HealthCheck.HTTPCheckInfoOrBuilder getHttpOrBuilder()

 HTTP health check.
 

optional .mesos.HealthCheck.HTTPCheckInfo http = 1;

Specified by:

getHttpOrBuilder in interface Protos.HealthCheckOrBuilder

hasTcp

public boolean hasTcp()

 TCP health check.
 

optional .mesos.HealthCheck.TCPCheckInfo tcp = 9;

Specified by:

hasTcp in interface Protos.HealthCheckOrBuilder

getTcp

public Protos.HealthCheck.TCPCheckInfo getTcp()

 TCP health check.
 

optional .mesos.HealthCheck.TCPCheckInfo tcp = 9;

Specified by:

getTcp in interface Protos.HealthCheckOrBuilder

getTcpOrBuilder

public Protos.HealthCheck.TCPCheckInfoOrBuilder getTcpOrBuilder()

 TCP health check.
 

optional .mesos.HealthCheck.TCPCheckInfo tcp = 9;

Specified by:

getTcpOrBuilder in interface Protos.HealthCheckOrBuilder

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.HealthCheck parseFrom(java.nio.ByteBuffer data)
                                    throws com.google.protobuf.InvalidProtocolBufferException

Throws:

com.google.protobuf.InvalidProtocolBufferException

parseFrom

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

Throws:

com.google.protobuf.InvalidProtocolBufferException

parseFrom

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

Throws:

com.google.protobuf.InvalidProtocolBufferException

parseFrom

public static Protos.HealthCheck 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.HealthCheck parseFrom(byte[] data,
                                           com.google.protobuf.ExtensionRegistryLite extensionRegistry)
                                    throws com.google.protobuf.InvalidProtocolBufferException

Throws:

com.google.protobuf.InvalidProtocolBufferException

parseFrom

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

Throws:

java.io.IOException

parseDelimitedFrom

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

Throws:

java.io.IOException

parseDelimitedFrom

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

Throws:

java.io.IOException

parseFrom

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

Throws:

java.io.IOException

parseFrom

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

Throws:

java.io.IOException

newBuilderForType

public Protos.HealthCheck.Builder newBuilderForType()

newBuilder

public static Protos.HealthCheck.Builder newBuilder()

newBuilder

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

toBuilder

public Protos.HealthCheck.Builder toBuilder()

newBuilderForType

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

getDefaultInstance

public static Protos.HealthCheck getDefaultInstance()

parser

public static <any> parser()

getParserForType

public <any> getParserForType()

getDefaultInstanceForType

public Protos.HealthCheck getDefaultInstanceForType()