Class ReadinessCheck (2.41.0)

publicfinalclass ReadinessCheckextendsGeneratedMessageV3implementsReadinessCheckOrBuilder

Readiness checking configuration for VM instances. Unhealthy instances are removed from traffic rotation.

Protobuf type google.appengine.v1.ReadinessCheck

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

APP_START_TIMEOUT_FIELD_NUMBER

publicstaticfinalintAPP_START_TIMEOUT_FIELD_NUMBER
Field Value
Type Description
int

CHECK_INTERVAL_FIELD_NUMBER

publicstaticfinalintCHECK_INTERVAL_FIELD_NUMBER
Field Value
Type Description
int

FAILURE_THRESHOLD_FIELD_NUMBER

publicstaticfinalintFAILURE_THRESHOLD_FIELD_NUMBER
Field Value
Type Description
int

HOST_FIELD_NUMBER

publicstaticfinalintHOST_FIELD_NUMBER
Field Value
Type Description
int

PATH_FIELD_NUMBER

publicstaticfinalintPATH_FIELD_NUMBER
Field Value
Type Description
int

SUCCESS_THRESHOLD_FIELD_NUMBER

publicstaticfinalintSUCCESS_THRESHOLD_FIELD_NUMBER
Field Value
Type Description
int

TIMEOUT_FIELD_NUMBER

publicstaticfinalintTIMEOUT_FIELD_NUMBER
Field Value
Type Description
int

Static Methods

getDefaultInstance()

publicstaticReadinessCheckgetDefaultInstance()
Returns
Type Description
ReadinessCheck

getDescriptor()

publicstaticfinalDescriptors.DescriptorgetDescriptor()
Returns
Type Description
Descriptor

newBuilder()

publicstaticReadinessCheck.BuildernewBuilder()
Returns
Type Description
ReadinessCheck.Builder

newBuilder(ReadinessCheck prototype)

publicstaticReadinessCheck.BuildernewBuilder(ReadinessCheckprototype)
Parameter
Name Description
prototype ReadinessCheck
Returns
Type Description
ReadinessCheck.Builder

parseDelimitedFrom(InputStream input)

publicstaticReadinessCheckparseDelimitedFrom(InputStreaminput)
Parameter
Name Description
input InputStream
Returns
Type Description
ReadinessCheck
Exceptions
Type Description
IOException

parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

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

parseFrom(byte[] data)

publicstaticReadinessCheckparseFrom(byte[]data)
Parameter
Name Description
data byte[]
Returns
Type Description
ReadinessCheck
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)

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

parseFrom(ByteString data)

publicstaticReadinessCheckparseFrom(ByteStringdata)
Parameter
Name Description
data ByteString
Returns
Type Description
ReadinessCheck
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)

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

parseFrom(CodedInputStream input)

publicstaticReadinessCheckparseFrom(CodedInputStreaminput)
Parameter
Name Description
input CodedInputStream
Returns
Type Description
ReadinessCheck
Exceptions
Type Description
IOException

parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

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

parseFrom(InputStream input)

publicstaticReadinessCheckparseFrom(InputStreaminput)
Parameter
Name Description
input InputStream
Returns
Type Description
ReadinessCheck
Exceptions
Type Description
IOException

parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

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

parseFrom(ByteBuffer data)

publicstaticReadinessCheckparseFrom(ByteBufferdata)
Parameter
Name Description
data ByteBuffer
Returns
Type Description
ReadinessCheck
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)

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

parser()

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

Methods

equals(Object obj)

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

getAppStartTimeout()

publicDurationgetAppStartTimeout()

A maximum time limit on application initialization, measured from moment the application successfully replies to a healthcheck until it is ready to serve traffic.

.google.protobuf.Duration app_start_timeout = 7;

Returns
Type Description
Duration

The appStartTimeout.

getAppStartTimeoutOrBuilder()

publicDurationOrBuildergetAppStartTimeoutOrBuilder()

A maximum time limit on application initialization, measured from moment the application successfully replies to a healthcheck until it is ready to serve traffic.

.google.protobuf.Duration app_start_timeout = 7;

Returns
Type Description
DurationOrBuilder

getCheckInterval()

publicDurationgetCheckInterval()

Interval between health checks.

.google.protobuf.Duration check_interval = 5;

Returns
Type Description
Duration

The checkInterval.

getCheckIntervalOrBuilder()

publicDurationOrBuildergetCheckIntervalOrBuilder()

Interval between health checks.

.google.protobuf.Duration check_interval = 5;

Returns
Type Description
DurationOrBuilder

getDefaultInstanceForType()

publicReadinessCheckgetDefaultInstanceForType()
Returns
Type Description
ReadinessCheck

getFailureThreshold()

publicintgetFailureThreshold()

Number of consecutive failed checks required before removing traffic.

uint32 failure_threshold = 3;

Returns
Type Description
int

The failureThreshold.

getHost()

publicStringgetHost()

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

string host = 2;

Returns
Type Description
String

The host.

getHostBytes()

publicByteStringgetHostBytes()

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

string host = 2;

Returns
Type Description
ByteString

The bytes for host.

getParserForType()

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

getPath()

publicStringgetPath()

The request path.

string path = 1;

Returns
Type Description
String

The path.

getPathBytes()

publicByteStringgetPathBytes()

The request path.

string path = 1;

Returns
Type Description
ByteString

The bytes for path.

getSerializedSize()

publicintgetSerializedSize()
Returns
Type Description
int
Overrides

getSuccessThreshold()

publicintgetSuccessThreshold()

Number of consecutive successful checks required before receiving traffic.

uint32 success_threshold = 4;

Returns
Type Description
int

The successThreshold.

getTimeout()

publicDurationgetTimeout()

Time before the check is considered failed.

.google.protobuf.Duration timeout = 6;

Returns
Type Description
Duration

The timeout.

getTimeoutOrBuilder()

publicDurationOrBuildergetTimeoutOrBuilder()

Time before the check is considered failed.

.google.protobuf.Duration timeout = 6;

Returns
Type Description
DurationOrBuilder

hasAppStartTimeout()

publicbooleanhasAppStartTimeout()

A maximum time limit on application initialization, measured from moment the application successfully replies to a healthcheck until it is ready to serve traffic.

.google.protobuf.Duration app_start_timeout = 7;

Returns
Type Description
boolean

Whether the appStartTimeout field is set.

hasCheckInterval()

publicbooleanhasCheckInterval()

Interval between health checks.

.google.protobuf.Duration check_interval = 5;

Returns
Type Description
boolean

Whether the checkInterval field is set.

hasTimeout()

publicbooleanhasTimeout()

Time before the check is considered failed.

.google.protobuf.Duration timeout = 6;

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

publicReadinessCheck.BuildernewBuilderForType()
Returns
Type Description
ReadinessCheck.Builder

newBuilderForType(GeneratedMessageV3.BuilderParent parent)

protectedReadinessCheck.BuildernewBuilderForType(GeneratedMessageV3.BuilderParentparent)
Parameter
Name Description
parent BuilderParent
Returns
Type Description
ReadinessCheck.Builder
Overrides

newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)

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

toBuilder()

publicReadinessCheck.BuildertoBuilder()
Returns
Type Description
ReadinessCheck.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.