Class LivenessCheck (2.11.0)

public final class LivenessCheck extends GeneratedMessageV3 implements LivenessCheckOrBuilder

Health checking configuration for VM instances. Unhealthy instances are killed and replaced with new instances.

Protobuf type google.appengine.v1.LivenessCheck

Static Fields

CHECK_INTERVAL_FIELD_NUMBER

public static final int CHECK_INTERVAL_FIELD_NUMBER
Field Value
TypeDescription
int

FAILURE_THRESHOLD_FIELD_NUMBER

public static final int FAILURE_THRESHOLD_FIELD_NUMBER
Field Value
TypeDescription
int

HOST_FIELD_NUMBER

public static final int HOST_FIELD_NUMBER
Field Value
TypeDescription
int

INITIAL_DELAY_FIELD_NUMBER

public static final int INITIAL_DELAY_FIELD_NUMBER
Field Value
TypeDescription
int

PATH_FIELD_NUMBER

public static final int PATH_FIELD_NUMBER
Field Value
TypeDescription
int

SUCCESS_THRESHOLD_FIELD_NUMBER

public static final int SUCCESS_THRESHOLD_FIELD_NUMBER
Field Value
TypeDescription
int

TIMEOUT_FIELD_NUMBER

public static final int TIMEOUT_FIELD_NUMBER
Field Value
TypeDescription
int

Static Methods

getDefaultInstance()

public static LivenessCheck getDefaultInstance()
Returns
TypeDescription
LivenessCheck

getDescriptor()

public static final Descriptors.Descriptor getDescriptor()
Returns
TypeDescription
Descriptor

newBuilder()

public static LivenessCheck.Builder newBuilder()
Returns
TypeDescription
LivenessCheck.Builder

newBuilder(LivenessCheck prototype)

public static LivenessCheck.Builder newBuilder(LivenessCheck prototype)
Parameter
NameDescription
prototypeLivenessCheck
Returns
TypeDescription
LivenessCheck.Builder

parseDelimitedFrom(InputStream input)

public static LivenessCheck parseDelimitedFrom(InputStream input)
Parameter
NameDescription
inputInputStream
Returns
TypeDescription
LivenessCheck
Exceptions
TypeDescription
IOException

parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

public static LivenessCheck parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
NameDescription
inputInputStream
extensionRegistryExtensionRegistryLite
Returns
TypeDescription
LivenessCheck
Exceptions
TypeDescription
IOException

parseFrom(byte[] data)

public static LivenessCheck parseFrom(byte[] data)
Parameter
NameDescription
databyte[]
Returns
TypeDescription
LivenessCheck
Exceptions
TypeDescription
InvalidProtocolBufferException

parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)

public static LivenessCheck parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)
Parameters
NameDescription
databyte[]
extensionRegistryExtensionRegistryLite
Returns
TypeDescription
LivenessCheck
Exceptions
TypeDescription
InvalidProtocolBufferException

parseFrom(ByteString data)

public static LivenessCheck parseFrom(ByteString data)
Parameter
NameDescription
dataByteString
Returns
TypeDescription
LivenessCheck
Exceptions
TypeDescription
InvalidProtocolBufferException

parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)

public static LivenessCheck parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)
Parameters
NameDescription
dataByteString
extensionRegistryExtensionRegistryLite
Returns
TypeDescription
LivenessCheck
Exceptions
TypeDescription
InvalidProtocolBufferException

parseFrom(CodedInputStream input)

public static LivenessCheck parseFrom(CodedInputStream input)
Parameter
NameDescription
inputCodedInputStream
Returns
TypeDescription
LivenessCheck
Exceptions
TypeDescription
IOException

parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

public static LivenessCheck parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
NameDescription
inputCodedInputStream
extensionRegistryExtensionRegistryLite
Returns
TypeDescription
LivenessCheck
Exceptions
TypeDescription
IOException

parseFrom(InputStream input)

public static LivenessCheck parseFrom(InputStream input)
Parameter
NameDescription
inputInputStream
Returns
TypeDescription
LivenessCheck
Exceptions
TypeDescription
IOException

parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

public static LivenessCheck parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
NameDescription
inputInputStream
extensionRegistryExtensionRegistryLite
Returns
TypeDescription
LivenessCheck
Exceptions
TypeDescription
IOException

parseFrom(ByteBuffer data)

public static LivenessCheck parseFrom(ByteBuffer data)
Parameter
NameDescription
dataByteBuffer
Returns
TypeDescription
LivenessCheck
Exceptions
TypeDescription
InvalidProtocolBufferException

parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)

public static LivenessCheck parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)
Parameters
NameDescription
dataByteBuffer
extensionRegistryExtensionRegistryLite
Returns
TypeDescription
LivenessCheck
Exceptions
TypeDescription
InvalidProtocolBufferException

parser()

public static Parser<LivenessCheck> parser()
Returns
TypeDescription
Parser<LivenessCheck>

Methods

equals(Object obj)

public boolean equals(Object obj)
Parameter
NameDescription
objObject
Returns
TypeDescription
boolean
Overrides

getCheckInterval()

public Duration getCheckInterval()

Interval between health checks.

.google.protobuf.Duration check_interval = 5;

Returns
TypeDescription
Duration

The checkInterval.

getCheckIntervalOrBuilder()

public DurationOrBuilder getCheckIntervalOrBuilder()

Interval between health checks.

.google.protobuf.Duration check_interval = 5;

Returns
TypeDescription
DurationOrBuilder

getDefaultInstanceForType()

public LivenessCheck getDefaultInstanceForType()
Returns
TypeDescription
LivenessCheck

getFailureThreshold()

public int getFailureThreshold()

Number of consecutive failed checks required before considering the VM unhealthy.

uint32 failure_threshold = 3;

Returns
TypeDescription
int

The failureThreshold.

getHost()

public String getHost()

Host header to send when performing a HTTP Liveness check. Example: "myapp.appspot.com"

string host = 2;

Returns
TypeDescription
String

The host.

getHostBytes()

public ByteString getHostBytes()

Host header to send when performing a HTTP Liveness check. Example: "myapp.appspot.com"

string host = 2;

Returns
TypeDescription
ByteString

The bytes for host.

getInitialDelay()

public Duration getInitialDelay()

The initial delay before starting to execute the checks.

.google.protobuf.Duration initial_delay = 7;

Returns
TypeDescription
Duration

The initialDelay.

getInitialDelayOrBuilder()

public DurationOrBuilder getInitialDelayOrBuilder()

The initial delay before starting to execute the checks.

.google.protobuf.Duration initial_delay = 7;

Returns
TypeDescription
DurationOrBuilder

getParserForType()

public Parser<LivenessCheck> getParserForType()
Returns
TypeDescription
Parser<LivenessCheck>
Overrides

getPath()

public String getPath()

The request path.

string path = 1;

Returns
TypeDescription
String

The path.

getPathBytes()

public ByteString getPathBytes()

The request path.

string path = 1;

Returns
TypeDescription
ByteString

The bytes for path.

getSerializedSize()

public int getSerializedSize()
Returns
TypeDescription
int
Overrides

getSuccessThreshold()

public int getSuccessThreshold()

Number of consecutive successful checks required before considering the VM healthy.

uint32 success_threshold = 4;

Returns
TypeDescription
int

The successThreshold.

getTimeout()

public Duration getTimeout()

Time before the check is considered failed.

.google.protobuf.Duration timeout = 6;

Returns
TypeDescription
Duration

The timeout.

getTimeoutOrBuilder()

public DurationOrBuilder getTimeoutOrBuilder()

Time before the check is considered failed.

.google.protobuf.Duration timeout = 6;

Returns
TypeDescription
DurationOrBuilder

getUnknownFields()

public final UnknownFieldSet getUnknownFields()
Returns
TypeDescription
UnknownFieldSet
Overrides

hasCheckInterval()

public boolean hasCheckInterval()

Interval between health checks.

.google.protobuf.Duration check_interval = 5;

Returns
TypeDescription
boolean

Whether the checkInterval field is set.

hasInitialDelay()

public boolean hasInitialDelay()

The initial delay before starting to execute the checks.

.google.protobuf.Duration initial_delay = 7;

Returns
TypeDescription
boolean

Whether the initialDelay field is set.

hasTimeout()

public boolean hasTimeout()

Time before the check is considered failed.

.google.protobuf.Duration timeout = 6;

Returns
TypeDescription
boolean

Whether the timeout field is set.

hashCode()

public int hashCode()
Returns
TypeDescription
int
Overrides

internalGetFieldAccessorTable()

protected GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
Returns
TypeDescription
FieldAccessorTable
Overrides

isInitialized()

public final boolean isInitialized()
Returns
TypeDescription
boolean
Overrides

newBuilderForType()

public LivenessCheck.Builder newBuilderForType()
Returns
TypeDescription
LivenessCheck.Builder

newBuilderForType(GeneratedMessageV3.BuilderParent parent)

protected LivenessCheck.Builder newBuilderForType(GeneratedMessageV3.BuilderParent parent)
Parameter
NameDescription
parentBuilderParent
Returns
TypeDescription
LivenessCheck.Builder
Overrides

newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)

protected Object newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)
Parameter
NameDescription
unusedUnusedPrivateParameter
Returns
TypeDescription
Object
Overrides

toBuilder()

public LivenessCheck.Builder toBuilder()
Returns
TypeDescription
LivenessCheck.Builder

writeTo(CodedOutputStream output)

public void writeTo(CodedOutputStream output)
Parameter
NameDescription
outputCodedOutputStream
Overrides Exceptions
TypeDescription
IOException