Class HealthCheck (2.41.0)

public final class HealthCheck extends GeneratedMessageV3 implements HealthCheckOrBuilder

Health checking configuration for VM instances. Unhealthy instances are killed and replaced with new instances. Only applicable for instances in App Engine flexible environment.

Protobuf type google.appengine.v1.HealthCheck

Static Fields

CHECK_INTERVAL_FIELD_NUMBER

public static final int CHECK_INTERVAL_FIELD_NUMBER
Field Value
Type Description
int

DISABLE_HEALTH_CHECK_FIELD_NUMBER

public static final int DISABLE_HEALTH_CHECK_FIELD_NUMBER
Field Value
Type Description
int

HEALTHY_THRESHOLD_FIELD_NUMBER

public static final int HEALTHY_THRESHOLD_FIELD_NUMBER
Field Value
Type Description
int

HOST_FIELD_NUMBER

public static final int HOST_FIELD_NUMBER
Field Value
Type Description
int

RESTART_THRESHOLD_FIELD_NUMBER

public static final int RESTART_THRESHOLD_FIELD_NUMBER
Field Value
Type Description
int

TIMEOUT_FIELD_NUMBER

public static final int TIMEOUT_FIELD_NUMBER
Field Value
Type Description
int

UNHEALTHY_THRESHOLD_FIELD_NUMBER

public static final int UNHEALTHY_THRESHOLD_FIELD_NUMBER
Field Value
Type Description
int

Static Methods

getDefaultInstance()

public static HealthCheck getDefaultInstance()
Returns
Type Description
HealthCheck

getDescriptor()

public static final Descriptors.Descriptor getDescriptor()
Returns
Type Description
Descriptor

newBuilder()

public static HealthCheck.Builder newBuilder()
Returns
Type Description
HealthCheck.Builder

newBuilder(HealthCheck prototype)

public static HealthCheck.Builder newBuilder(HealthCheck prototype)
Parameter
Name Description
prototype HealthCheck
Returns
Type Description
HealthCheck.Builder

parseDelimitedFrom(InputStream input)

public static HealthCheck parseDelimitedFrom(InputStream input)
Parameter
Name Description
input InputStream
Returns
Type Description
HealthCheck
Exceptions
Type Description
IOException

parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

public static HealthCheck parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
input InputStream
extensionRegistry ExtensionRegistryLite
Returns
Type Description
HealthCheck
Exceptions
Type Description
IOException

parseFrom(byte[] data)

public static HealthCheck parseFrom(byte[] data)
Parameter
Name Description
data byte[]
Returns
Type Description
HealthCheck
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)

public static HealthCheck parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
data byte[]
extensionRegistry ExtensionRegistryLite
Returns
Type Description
HealthCheck
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(ByteString data)

public static HealthCheck parseFrom(ByteString data)
Parameter
Name Description
data ByteString
Returns
Type Description
HealthCheck
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)

public static HealthCheck parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
data ByteString
extensionRegistry ExtensionRegistryLite
Returns
Type Description
HealthCheck
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(CodedInputStream input)

public static HealthCheck parseFrom(CodedInputStream input)
Parameter
Name Description
input CodedInputStream
Returns
Type Description
HealthCheck
Exceptions
Type Description
IOException

parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

public static HealthCheck parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
input CodedInputStream
extensionRegistry ExtensionRegistryLite
Returns
Type Description
HealthCheck
Exceptions
Type Description
IOException

parseFrom(InputStream input)

public static HealthCheck parseFrom(InputStream input)
Parameter
Name Description
input InputStream
Returns
Type Description
HealthCheck
Exceptions
Type Description
IOException

parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

public static HealthCheck parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
input InputStream
extensionRegistry ExtensionRegistryLite
Returns
Type Description
HealthCheck
Exceptions
Type Description
IOException

parseFrom(ByteBuffer data)

public static HealthCheck parseFrom(ByteBuffer data)
Parameter
Name Description
data ByteBuffer
Returns
Type Description
HealthCheck
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)

public static HealthCheck parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
data ByteBuffer
extensionRegistry ExtensionRegistryLite
Returns
Type Description
HealthCheck
Exceptions
Type Description
InvalidProtocolBufferException

parser()

public static Parser<HealthCheck> parser()
Returns
Type Description
Parser<HealthCheck>

Methods

equals(Object obj)

public boolean equals(Object obj)
Parameter
Name Description
obj Object
Returns
Type Description
boolean
Overrides

getCheckInterval()

public Duration getCheckInterval()

Interval between health checks.

.google.protobuf.Duration check_interval = 6;

Returns
Type Description
Duration

The checkInterval.

getCheckIntervalOrBuilder()

public DurationOrBuilder getCheckIntervalOrBuilder()

Interval between health checks.

.google.protobuf.Duration check_interval = 6;

Returns
Type Description
DurationOrBuilder

getDefaultInstanceForType()

public HealthCheck getDefaultInstanceForType()
Returns
Type Description
HealthCheck

getDisableHealthCheck()

public boolean getDisableHealthCheck()

Whether to explicitly disable health checks for this instance.

bool disable_health_check = 1;

Returns
Type Description
boolean

The disableHealthCheck.

getHealthyThreshold()

public int getHealthyThreshold()

Number of consecutive successful health checks required before receiving traffic.

uint32 healthy_threshold = 3;

Returns
Type Description
int

The healthyThreshold.

getHost()

public String getHost()

Host header to send when performing an HTTP health check. Example: "myapp.appspot.com"

string host = 2;

Returns
Type Description
String

The host.

getHostBytes()

public ByteString getHostBytes()

Host header to send when performing an HTTP health check. Example: "myapp.appspot.com"

string host = 2;

Returns
Type Description
ByteString

The bytes for host.

getParserForType()

public Parser<HealthCheck> getParserForType()
Returns
Type Description
Parser<HealthCheck>
Overrides

getRestartThreshold()

public int getRestartThreshold()

Number of consecutive failed health checks required before an instance is restarted.

uint32 restart_threshold = 5;

Returns
Type Description
int

The restartThreshold.

getSerializedSize()

public int getSerializedSize()
Returns
Type Description
int
Overrides

getTimeout()

public Duration getTimeout()

Time before the health check is considered failed.

.google.protobuf.Duration timeout = 7;

Returns
Type Description
Duration

The timeout.

getTimeoutOrBuilder()

public DurationOrBuilder getTimeoutOrBuilder()

Time before the health check is considered failed.

.google.protobuf.Duration timeout = 7;

Returns
Type Description
DurationOrBuilder

getUnhealthyThreshold()

public int getUnhealthyThreshold()

Number of consecutive failed health checks required before removing traffic.

uint32 unhealthy_threshold = 4;

Returns
Type Description
int

The unhealthyThreshold.

hasCheckInterval()

public boolean hasCheckInterval()

Interval between health checks.

.google.protobuf.Duration check_interval = 6;

Returns
Type Description
boolean

Whether the checkInterval field is set.

hasTimeout()

public boolean hasTimeout()

Time before the health check is considered failed.

.google.protobuf.Duration timeout = 7;

Returns
Type Description
boolean

Whether the timeout field is set.

hashCode()

public int hashCode()
Returns
Type Description
int
Overrides

internalGetFieldAccessorTable()

protected GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
Returns
Type Description
FieldAccessorTable
Overrides

isInitialized()

public final boolean isInitialized()
Returns
Type Description
boolean
Overrides

newBuilderForType()

public HealthCheck.Builder newBuilderForType()
Returns
Type Description
HealthCheck.Builder

newBuilderForType(GeneratedMessageV3.BuilderParent parent)

protected HealthCheck.Builder newBuilderForType(GeneratedMessageV3.BuilderParent parent)
Parameter
Name Description
parent BuilderParent
Returns
Type Description
HealthCheck.Builder
Overrides

newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)

protected Object newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)
Parameter
Name Description
unused UnusedPrivateParameter
Returns
Type Description
Object
Overrides

toBuilder()

public HealthCheck.Builder toBuilder()
Returns
Type Description
HealthCheck.Builder

writeTo(CodedOutputStream output)

public void writeTo(CodedOutputStream output)
Parameter
Name Description
output CodedOutputStream
Overrides
Exceptions
Type Description
IOException