Class ReadinessCheck (2.45.0)

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

getDescriptor()

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

newBuilder()

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

newBuilder(ReadinessCheck prototype)

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

parseDelimitedFrom(InputStream input)

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

parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

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

parseFrom(byte[] data)

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

parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)

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

parseFrom(ByteString data)

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

parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)

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

parseFrom(CodedInputStream input)

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

parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

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

parseFrom(InputStream input)

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

parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

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

parseFrom(ByteBuffer data)

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

parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)

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

parser()

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

Methods

equals(Object obj)

public boolean equals(Object obj)
Parameter
Name Description
obj Object
Returns
Type Description
boolean
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
Type Description
DurationOrBuilder

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
Type Description
DurationOrBuilder

getDefaultInstanceForType()

public ReadinessCheck getDefaultInstanceForType()
Returns
Type Description
ReadinessCheck

getFailureThreshold()

public int getFailureThreshold()

Number of consecutive failed checks required before removing traffic.

uint32 failure_threshold = 3;

Returns
Type Description
int

The failureThreshold.

getHost()

public String 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()
Returns
Type Description
Parser<ReadinessCheck>
Overrides

getPath()

public String 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;

Returns
Type Description
DurationOrBuilder

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

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 ReadinessCheck.Builder newBuilderForType()
Returns
Type Description
ReadinessCheck.Builder

newBuilderForType(GeneratedMessageV3.BuilderParent parent)

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

newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)

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

toBuilder()

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

writeTo(CodedOutputStream output)

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