Class ReadinessCheck (2.76.0)
Version 2.76.0keyboard_arrow_down
public final class ReadinessCheck extends GeneratedMessageV3 implements ReadinessCheckOrBuilder
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
public static final int APP_START_TIMEOUT_FIELD_NUMBER
Field Value
Type Description
int
CHECK_INTERVAL_FIELD_NUMBER
public static final int CHECK_INTERVAL_FIELD_NUMBER
Field Value
Type Description
int
FAILURE_THRESHOLD_FIELD_NUMBER
public static final int FAILURE_THRESHOLD_FIELD_NUMBER
Field Value
Type Description
int
HOST_FIELD_NUMBER
public static final int HOST_FIELD_NUMBER
Field Value
Type Description
int
PATH_FIELD_NUMBER
public static final int PATH_FIELD_NUMBER
Field Value
Type Description
int
SUCCESS_THRESHOLD_FIELD_NUMBER
public static final int SUCCESS_THRESHOLD_FIELD_NUMBER
Field Value
Type Description
int
TIMEOUT_FIELD_NUMBER
public static final int TIMEOUT_FIELD_NUMBER
Field Value
Type Description
int
Static Methods
getDefaultInstance()
public static ReadinessCheck getDefaultInstance ()
getDescriptor()
public static final Descriptors . Descriptor getDescriptor ()
newBuilder()
public static ReadinessCheck . Builder newBuilder ()
newBuilder(ReadinessCheck prototype)
public static ReadinessCheck . Builder newBuilder ( ReadinessCheck prototype )
public static ReadinessCheck parseDelimitedFrom ( InputStream input )
public static ReadinessCheck parseDelimitedFrom ( InputStream input , ExtensionRegistryLite extensionRegistry )
parseFrom(byte[] data)
public static ReadinessCheck parseFrom ( byte [] data )
Parameter
Name Description
databyte []
parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)
public static ReadinessCheck parseFrom ( byte [] data , ExtensionRegistryLite extensionRegistry )
parseFrom(ByteString data)
public static ReadinessCheck parseFrom ( ByteString data )
parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)
public static ReadinessCheck parseFrom ( ByteString data , ExtensionRegistryLite extensionRegistry )
public static ReadinessCheck parseFrom ( CodedInputStream input )
public static ReadinessCheck parseFrom ( CodedInputStream input , ExtensionRegistryLite extensionRegistry )
public static ReadinessCheck parseFrom ( InputStream input )
public static ReadinessCheck parseFrom ( InputStream input , ExtensionRegistryLite extensionRegistry )
parseFrom(ByteBuffer data)
public static ReadinessCheck parseFrom ( ByteBuffer data )
parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)
public static ReadinessCheck parseFrom ( ByteBuffer data , ExtensionRegistryLite extensionRegistry )
parser()
public static Parser<ReadinessCheck> parser ()
Methods
equals(Object obj)
public boolean equals ( Object obj )
Parameter
Name Description
objObject
Overrides
getAppStartTimeout()
public Duration getAppStartTimeout ()
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()
public DurationOrBuilder getAppStartTimeoutOrBuilder ()
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;
getCheckInterval()
public Duration getCheckInterval ()
Interval between health checks.
.google.protobuf.Duration check_interval = 5;
Returns
Type Description
Duration The checkInterval.
getCheckIntervalOrBuilder()
public DurationOrBuilder getCheckIntervalOrBuilder ()
Interval between health checks.
.google.protobuf.Duration check_interval = 5;
getDefaultInstanceForType()
public ReadinessCheck getDefaultInstanceForType ()
getFailureThreshold()
public int getFailureThreshold ()
Number of consecutive failed checks required before removing
traffic.
uint32 failure_threshold = 3;
Returns
Type Description
int The failureThreshold.
getHost()
Host header to send when performing a HTTP Readiness check.
Example: "myapp.appspot.com"
string host = 2;
Returns
Type Description
String The host.
getHostBytes()
public ByteString getHostBytes ()
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()
public Parser<ReadinessCheck> getParserForType ()
Overrides
getPath()
The request path.
string path = 1;
Returns
Type Description
String The path.
getPathBytes()
public ByteString getPathBytes ()
The request path.
string path = 1;
Returns
Type Description
ByteString The bytes for path.
getSerializedSize()
public int getSerializedSize ()
Returns
Type Description
int
Overrides
getSuccessThreshold()
public int getSuccessThreshold ()
Number of consecutive successful checks required before receiving
traffic.
uint32 success_threshold = 4;
Returns
Type Description
int The successThreshold.
getTimeout()
public Duration getTimeout ()
Time before the check is considered failed.
.google.protobuf.Duration timeout = 6;
Returns
Type Description
Duration The timeout.
getTimeoutOrBuilder()
public DurationOrBuilder getTimeoutOrBuilder ()
Time before the check is considered failed.
.google.protobuf.Duration timeout = 6;
hasAppStartTimeout()
public boolean hasAppStartTimeout ()
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()
public boolean hasCheckInterval ()
Interval between health checks.
.google.protobuf.Duration check_interval = 5;
Returns
Type Description
boolean Whether the checkInterval field is set.
hasTimeout()
public boolean hasTimeout ()
Time before the check is considered failed.
.google.protobuf.Duration timeout = 6;
Returns
Type Description
boolean Whether the timeout field is set.
hashCode()
Returns
Type Description
int
Overrides
internalGetFieldAccessorTable()
protected GeneratedMessageV3 . FieldAccessorTable internalGetFieldAccessorTable ()
Overrides
isInitialized()
public final boolean isInitialized ()
Overrides
newBuilderForType()
public ReadinessCheck . Builder newBuilderForType ()
newBuilderForType(GeneratedMessageV3.BuilderParent parent)
protected ReadinessCheck . Builder newBuilderForType ( GeneratedMessageV3 . BuilderParent parent )
Overrides
newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)
protected Object newInstance ( GeneratedMessageV3 . UnusedPrivateParameter unused )
Returns
Type Description
Object
Overrides
toBuilder()
public ReadinessCheck . Builder toBuilder ()
writeTo(CodedOutputStream output)
public void writeTo ( CodedOutputStream output )
Overrides
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-28 UTC.
[[["Easy to understand","easyToUnderstand","thumb-up"],["Solved my problem","solvedMyProblem","thumb-up"],["Other","otherUp","thumb-up"]],[["Missing the information I need","missingTheInformationINeed","thumb-down"],["Too complicated / too many steps","tooComplicatedTooManySteps","thumb-down"],["Out of date","outOfDate","thumb-down"],["Samples / code issue","samplesCodeIssue","thumb-down"],["Other","otherDown","thumb-down"]],["Last updated 2025-10-28 UTC."],[],[]]
