Class HealthCheck (2.49.0) 

publicfinalclass HealthCheckextendsGeneratedMessageV3implementsHealthCheckOrBuilder

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

Inherited Members

com.google.protobuf.GeneratedMessageV3.<ListT>makeMutableCopy(ListT)
com.google.protobuf.GeneratedMessageV3.<ListT>makeMutableCopy(ListT,int)
com.google.protobuf.GeneratedMessageV3.<T>emptyList(java.lang.Class<T>)
com.google.protobuf.GeneratedMessageV3.internalGetMapFieldReflection(int)

Static Fields

CHECK_INTERVAL_FIELD_NUMBER

publicstaticfinalintCHECK_INTERVAL_FIELD_NUMBER
Field Value
Type Description
int

DISABLE_HEALTH_CHECK_FIELD_NUMBER

publicstaticfinalintDISABLE_HEALTH_CHECK_FIELD_NUMBER
Field Value
Type Description
int

HEALTHY_THRESHOLD_FIELD_NUMBER

publicstaticfinalintHEALTHY_THRESHOLD_FIELD_NUMBER
Field Value
Type Description
int

HOST_FIELD_NUMBER

publicstaticfinalintHOST_FIELD_NUMBER
Field Value
Type Description
int

RESTART_THRESHOLD_FIELD_NUMBER

publicstaticfinalintRESTART_THRESHOLD_FIELD_NUMBER
Field Value
Type Description
int

TIMEOUT_FIELD_NUMBER

publicstaticfinalintTIMEOUT_FIELD_NUMBER
Field Value
Type Description
int

UNHEALTHY_THRESHOLD_FIELD_NUMBER

publicstaticfinalintUNHEALTHY_THRESHOLD_FIELD_NUMBER
Field Value
Type Description
int

Static Methods

getDefaultInstance()

publicstaticHealthCheckgetDefaultInstance()
Returns
Type Description
HealthCheck

getDescriptor()

publicstaticfinalDescriptors.DescriptorgetDescriptor()
Returns
Type Description
Descriptor

newBuilder()

publicstaticHealthCheck.BuildernewBuilder()
Returns
Type Description
HealthCheck.Builder

newBuilder(HealthCheck prototype)

publicstaticHealthCheck.BuildernewBuilder(HealthCheckprototype)
Parameter
Name Description
prototype HealthCheck
Returns
Type Description
HealthCheck.Builder

parseDelimitedFrom(InputStream input)

publicstaticHealthCheckparseDelimitedFrom(InputStreaminput)
Parameter
Name Description
input InputStream
Returns
Type Description
HealthCheck
Exceptions
Type Description
IOException

parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

publicstaticHealthCheckparseDelimitedFrom(InputStreaminput,ExtensionRegistryLiteextensionRegistry)
Parameters
Name Description
input InputStream
extensionRegistry ExtensionRegistryLite
Returns
Type Description
HealthCheck
Exceptions
Type Description
IOException

parseFrom(byte[] data)

publicstaticHealthCheckparseFrom(byte[]data)
Parameter
Name Description
data byte[]
Returns
Type Description
HealthCheck
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)

publicstaticHealthCheckparseFrom(byte[]data,ExtensionRegistryLiteextensionRegistry)
Parameters
Name Description
data byte[]
extensionRegistry ExtensionRegistryLite
Returns
Type Description
HealthCheck
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(ByteString data)

publicstaticHealthCheckparseFrom(ByteStringdata)
Parameter
Name Description
data ByteString
Returns
Type Description
HealthCheck
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)

publicstaticHealthCheckparseFrom(ByteStringdata,ExtensionRegistryLiteextensionRegistry)
Parameters
Name Description
data ByteString
extensionRegistry ExtensionRegistryLite
Returns
Type Description
HealthCheck
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(CodedInputStream input)

publicstaticHealthCheckparseFrom(CodedInputStreaminput)
Parameter
Name Description
input CodedInputStream
Returns
Type Description
HealthCheck
Exceptions
Type Description
IOException

parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

publicstaticHealthCheckparseFrom(CodedInputStreaminput,ExtensionRegistryLiteextensionRegistry)
Parameters
Name Description
input CodedInputStream
extensionRegistry ExtensionRegistryLite
Returns
Type Description
HealthCheck
Exceptions
Type Description
IOException

parseFrom(InputStream input)

publicstaticHealthCheckparseFrom(InputStreaminput)
Parameter
Name Description
input InputStream
Returns
Type Description
HealthCheck
Exceptions
Type Description
IOException

parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

publicstaticHealthCheckparseFrom(InputStreaminput,ExtensionRegistryLiteextensionRegistry)
Parameters
Name Description
input InputStream
extensionRegistry ExtensionRegistryLite
Returns
Type Description
HealthCheck
Exceptions
Type Description
IOException

parseFrom(ByteBuffer data)

publicstaticHealthCheckparseFrom(ByteBufferdata)
Parameter
Name Description
data ByteBuffer
Returns
Type Description
HealthCheck
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)

publicstaticHealthCheckparseFrom(ByteBufferdata,ExtensionRegistryLiteextensionRegistry)
Parameters
Name Description
data ByteBuffer
extensionRegistry ExtensionRegistryLite
Returns
Type Description
HealthCheck
Exceptions
Type Description
InvalidProtocolBufferException

parser()

publicstaticParser<HealthCheck>parser()
Returns
Type Description
Parser<HealthCheck>

Methods

equals(Object obj)

publicbooleanequals(Objectobj)
Parameter
Name Description
obj Object
Returns
Type Description
boolean
Overrides

getCheckInterval()

publicDurationgetCheckInterval()

Interval between health checks.

.google.protobuf.Duration check_interval = 6;

Returns
Type Description
Duration

The checkInterval.

getCheckIntervalOrBuilder()

publicDurationOrBuildergetCheckIntervalOrBuilder()

Interval between health checks.

.google.protobuf.Duration check_interval = 6;

Returns
Type Description
DurationOrBuilder

getDefaultInstanceForType()

publicHealthCheckgetDefaultInstanceForType()
Returns
Type Description
HealthCheck

getDisableHealthCheck()

publicbooleangetDisableHealthCheck()

Whether to explicitly disable health checks for this instance.

bool disable_health_check = 1;

Returns
Type Description
boolean

The disableHealthCheck.

getHealthyThreshold()

publicintgetHealthyThreshold()

Number of consecutive successful health checks required before receiving traffic.

uint32 healthy_threshold = 3;

Returns
Type Description
int

The healthyThreshold.

getHost()

publicStringgetHost()

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

string host = 2;

Returns
Type Description
String

The host.

getHostBytes()

publicByteStringgetHostBytes()

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()

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

getRestartThreshold()

publicintgetRestartThreshold()

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

uint32 restart_threshold = 5;

Returns
Type Description
int

The restartThreshold.

getSerializedSize()

publicintgetSerializedSize()
Returns
Type Description
int
Overrides

getTimeout()

publicDurationgetTimeout()

Time before the health check is considered failed.

.google.protobuf.Duration timeout = 7;

Returns
Type Description
Duration

The timeout.

getTimeoutOrBuilder()

publicDurationOrBuildergetTimeoutOrBuilder()

Time before the health check is considered failed.

.google.protobuf.Duration timeout = 7;

Returns
Type Description
DurationOrBuilder

getUnhealthyThreshold()

publicintgetUnhealthyThreshold()

Number of consecutive failed health checks required before removing traffic.

uint32 unhealthy_threshold = 4;

Returns
Type Description
int

The unhealthyThreshold.

hasCheckInterval()

publicbooleanhasCheckInterval()

Interval between health checks.

.google.protobuf.Duration check_interval = 6;

Returns
Type Description
boolean

Whether the checkInterval field is set.

hasTimeout()

publicbooleanhasTimeout()

Time before the health check is considered failed.

.google.protobuf.Duration timeout = 7;

Returns
Type Description
boolean

Whether the timeout field is set.

hashCode()

publicinthashCode()
Returns
Type Description
int
Overrides

internalGetFieldAccessorTable()

protectedGeneratedMessageV3.FieldAccessorTableinternalGetFieldAccessorTable()
Returns
Type Description
FieldAccessorTable
Overrides

isInitialized()

publicfinalbooleanisInitialized()
Returns
Type Description
boolean
Overrides

newBuilderForType()

publicHealthCheck.BuildernewBuilderForType()
Returns
Type Description
HealthCheck.Builder

newBuilderForType(GeneratedMessageV3.BuilderParent parent)

protectedHealthCheck.BuildernewBuilderForType(GeneratedMessageV3.BuilderParentparent)
Parameter
Name Description
parent BuilderParent
Returns
Type Description
HealthCheck.Builder
Overrides

newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)

protectedObjectnewInstance(GeneratedMessageV3.UnusedPrivateParameterunused)
Parameter
Name Description
unused UnusedPrivateParameter
Returns
Type Description
Object
Overrides

toBuilder()

publicHealthCheck.BuildertoBuilder()
Returns
Type Description
HealthCheck.Builder

writeTo(CodedOutputStream output)

publicvoidwriteTo(CodedOutputStreamoutput)
Parameter
Name Description
output CodedOutputStream
Overrides
Exceptions
Type Description
IOException

Except as otherwise noted, the content of this page is licensed under the Creative Commons Attribution 4.0 License, and code samples are licensed under the Apache 2.0 License. For details, see the Google Developers Site Policies. Java is a registered trademark of Oracle and/or its affiliates.

Last updated 2025年10月30日 UTC.