Send feedback
Class ReadinessCheck (2.4.0)
Stay organized with collections
Save and categorize content based on your preferences.
Version 2.4.0 keyboard_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
Static Fields
APP_START_TIMEOUT_FIELD_NUMBER
public static final int APP_START_TIMEOUT_FIELD_NUMBER
Field Value
CHECK_INTERVAL_FIELD_NUMBER
public static final int CHECK_INTERVAL_FIELD_NUMBER
Field Value
FAILURE_THRESHOLD_FIELD_NUMBER
public static final int FAILURE_THRESHOLD_FIELD_NUMBER
Field Value
HOST_FIELD_NUMBER
public static final int HOST_FIELD_NUMBER
Field Value
PATH_FIELD_NUMBER
public static final int PATH_FIELD_NUMBER
Field Value
SUCCESS_THRESHOLD_FIELD_NUMBER
public static final int SUCCESS_THRESHOLD_FIELD_NUMBER
Field Value
TIMEOUT_FIELD_NUMBER
public static final int TIMEOUT_FIELD_NUMBER
Field Value
Static Methods
getDefaultInstance()
public static ReadinessCheck getDefaultInstance ()
Returns
getDescriptor()
public static final Descriptors . Descriptor getDescriptor ()
Returns
newBuilder()
public static ReadinessCheck . Builder newBuilder ()
Returns
newBuilder(ReadinessCheck prototype)
public static ReadinessCheck . Builder newBuilder ( ReadinessCheck prototype )
Parameter
Returns
public static ReadinessCheck parseDelimitedFrom ( InputStream input )
Parameter
Returns
Exceptions
public static ReadinessCheck parseDelimitedFrom ( InputStream input , ExtensionRegistryLite extensionRegistry )
Parameters
Returns
Exceptions
parseFrom(byte[] data)
public static ReadinessCheck parseFrom ( byte [] data )
Parameter
Name Description data byte []
Returns
Exceptions
parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)
public static ReadinessCheck parseFrom ( byte [] data , ExtensionRegistryLite extensionRegistry )
Parameters
Returns
Exceptions
parseFrom(ByteString data)
public static ReadinessCheck parseFrom ( ByteString data )
Parameter
Returns
Exceptions
parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)
public static ReadinessCheck parseFrom ( ByteString data , ExtensionRegistryLite extensionRegistry )
Parameters
Returns
Exceptions
public static ReadinessCheck parseFrom ( CodedInputStream input )
Parameter
Returns
Exceptions
public static ReadinessCheck parseFrom ( CodedInputStream input , ExtensionRegistryLite extensionRegistry )
Parameters
Returns
Exceptions
public static ReadinessCheck parseFrom ( InputStream input )
Parameter
Returns
Exceptions
public static ReadinessCheck parseFrom ( InputStream input , ExtensionRegistryLite extensionRegistry )
Parameters
Returns
Exceptions
parseFrom(ByteBuffer data)
public static ReadinessCheck parseFrom ( ByteBuffer data )
Parameter
Returns
Exceptions
parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)
public static ReadinessCheck parseFrom ( ByteBuffer data , ExtensionRegistryLite extensionRegistry )
Parameters
Returns
Exceptions
parser()
public static Parser<ReadinessCheck> parser ()
Returns
Methods
equals(Object obj)
public boolean equals ( Object obj )
Parameter
Returns
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;
Returns
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;
Returns
getDefaultInstanceForType()
public ReadinessCheck getDefaultInstanceForType ()
Returns
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
getParserForType()
public Parser<ReadinessCheck> getParserForType ()
Returns
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
getSerializedSize()
public int getSerializedSize ()
Returns
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
getTimeoutOrBuilder()
public DurationOrBuilder getTimeoutOrBuilder ()
Time before the check is considered failed.
.google.protobuf.Duration timeout = 6;
Returns
getUnknownFields()
public final UnknownFieldSet getUnknownFields ()
Returns
Overrides
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
Overrides
internalGetFieldAccessorTable()
protected GeneratedMessageV3 . FieldAccessorTable internalGetFieldAccessorTable ()
Returns
Overrides
isInitialized()
public final boolean isInitialized ()
Returns
Overrides
newBuilderForType()
public ReadinessCheck . Builder newBuilderForType ()
Returns
newBuilderForType(GeneratedMessageV3.BuilderParent parent)
protected ReadinessCheck . Builder newBuilderForType ( GeneratedMessageV3 . BuilderParent parent )
Parameter
Returns
Overrides
newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)
protected Object newInstance ( GeneratedMessageV3 . UnusedPrivateParameter unused )
Parameter
Returns
Overrides
toBuilder()
public ReadinessCheck . Builder toBuilder ()
Returns
writeTo(CodedOutputStream output)
public void writeTo ( CodedOutputStream output )
Parameter
Overrides
Exceptions
Send feedback
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-01-28 UTC.
Need to tell us more?
[[["Easy to understand","easyToUnderstand","thumb-up"],["Solved my problem","solvedMyProblem","thumb-up"],["Other","otherUp","thumb-up"]],[["Hard to understand","hardToUnderstand","thumb-down"],["Incorrect information or sample code","incorrectInformationOrSampleCode","thumb-down"],["Missing the information/samples I need","missingTheInformationSamplesINeed","thumb-down"],["Other","otherDown","thumb-down"]],["Last updated 2025-01-28 UTC."],[],[]]