Class ReadinessCheck (2.24.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
TypeDescription
int

CHECK_INTERVAL_FIELD_NUMBER

public static final int CHECK_INTERVAL_FIELD_NUMBER
Field Value
TypeDescription
int

FAILURE_THRESHOLD_FIELD_NUMBER

public static final int FAILURE_THRESHOLD_FIELD_NUMBER
Field Value
TypeDescription
int

HOST_FIELD_NUMBER

public static final int HOST_FIELD_NUMBER
Field Value
TypeDescription
int

PATH_FIELD_NUMBER

public static final int PATH_FIELD_NUMBER
Field Value
TypeDescription
int

SUCCESS_THRESHOLD_FIELD_NUMBER

public static final int SUCCESS_THRESHOLD_FIELD_NUMBER
Field Value
TypeDescription
int

TIMEOUT_FIELD_NUMBER

public static final int TIMEOUT_FIELD_NUMBER
Field Value
TypeDescription
int

Static Methods

getDefaultInstance()

public static ReadinessCheck getDefaultInstance()
Returns
TypeDescription
ReadinessCheck

getDescriptor()

public static final Descriptors.Descriptor getDescriptor()
Returns
TypeDescription
Descriptor

newBuilder()

public static ReadinessCheck.Builder newBuilder()
Returns
TypeDescription
ReadinessCheck.Builder

newBuilder(ReadinessCheck prototype)

public static ReadinessCheck.Builder newBuilder(ReadinessCheck prototype)
Parameter
NameDescription
prototypeReadinessCheck
Returns
TypeDescription
ReadinessCheck.Builder

parseDelimitedFrom(InputStream input)

public static ReadinessCheck parseDelimitedFrom(InputStream input)
Parameter
NameDescription
inputInputStream
Returns
TypeDescription
ReadinessCheck
Exceptions
TypeDescription
IOException

parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

public static ReadinessCheck parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
NameDescription
inputInputStream
extensionRegistryExtensionRegistryLite
Returns
TypeDescription
ReadinessCheck
Exceptions
TypeDescription
IOException

parseFrom(byte[] data)

public static ReadinessCheck parseFrom(byte[] data)
Parameter
NameDescription
databyte[]
Returns
TypeDescription
ReadinessCheck
Exceptions
TypeDescription
InvalidProtocolBufferException

parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)

public static ReadinessCheck parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)
Parameters
NameDescription
databyte[]
extensionRegistryExtensionRegistryLite
Returns
TypeDescription
ReadinessCheck
Exceptions
TypeDescription
InvalidProtocolBufferException

parseFrom(ByteString data)

public static ReadinessCheck parseFrom(ByteString data)
Parameter
NameDescription
dataByteString
Returns
TypeDescription
ReadinessCheck
Exceptions
TypeDescription
InvalidProtocolBufferException

parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)

public static ReadinessCheck parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)
Parameters
NameDescription
dataByteString
extensionRegistryExtensionRegistryLite
Returns
TypeDescription
ReadinessCheck
Exceptions
TypeDescription
InvalidProtocolBufferException

parseFrom(CodedInputStream input)

public static ReadinessCheck parseFrom(CodedInputStream input)
Parameter
NameDescription
inputCodedInputStream
Returns
TypeDescription
ReadinessCheck
Exceptions
TypeDescription
IOException

parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

public static ReadinessCheck parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
NameDescription
inputCodedInputStream
extensionRegistryExtensionRegistryLite
Returns
TypeDescription
ReadinessCheck
Exceptions
TypeDescription
IOException

parseFrom(InputStream input)

public static ReadinessCheck parseFrom(InputStream input)
Parameter
NameDescription
inputInputStream
Returns
TypeDescription
ReadinessCheck
Exceptions
TypeDescription
IOException

parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

public static ReadinessCheck parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
NameDescription
inputInputStream
extensionRegistryExtensionRegistryLite
Returns
TypeDescription
ReadinessCheck
Exceptions
TypeDescription
IOException

parseFrom(ByteBuffer data)

public static ReadinessCheck parseFrom(ByteBuffer data)
Parameter
NameDescription
dataByteBuffer
Returns
TypeDescription
ReadinessCheck
Exceptions
TypeDescription
InvalidProtocolBufferException

parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)

public static ReadinessCheck parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)
Parameters
NameDescription
dataByteBuffer
extensionRegistryExtensionRegistryLite
Returns
TypeDescription
ReadinessCheck
Exceptions
TypeDescription
InvalidProtocolBufferException

parser()

public static Parser<ReadinessCheck> parser()
Returns
TypeDescription
Parser<ReadinessCheck>

Methods

equals(Object obj)

public boolean equals(Object obj)
Parameter
NameDescription
objObject
Returns
TypeDescription
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
TypeDescription
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
TypeDescription
DurationOrBuilder

getCheckInterval()

public Duration getCheckInterval()

Interval between health checks.

.google.protobuf.Duration check_interval = 5;

Returns
TypeDescription
Duration

The checkInterval.

getCheckIntervalOrBuilder()

public DurationOrBuilder getCheckIntervalOrBuilder()

Interval between health checks.

.google.protobuf.Duration check_interval = 5;

Returns
TypeDescription
DurationOrBuilder

getDefaultInstanceForType()

public ReadinessCheck getDefaultInstanceForType()
Returns
TypeDescription
ReadinessCheck

getFailureThreshold()

public int getFailureThreshold()

Number of consecutive failed checks required before removing traffic.

uint32 failure_threshold = 3;

Returns
TypeDescription
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
TypeDescription
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
TypeDescription
ByteString

The bytes for host.

getParserForType()

public Parser<ReadinessCheck> getParserForType()
Returns
TypeDescription
Parser<ReadinessCheck>
Overrides

getPath()

public String getPath()

The request path.

string path = 1;

Returns
TypeDescription
String

The path.

getPathBytes()

public ByteString getPathBytes()

The request path.

string path = 1;

Returns
TypeDescription
ByteString

The bytes for path.

getSerializedSize()

public int getSerializedSize()
Returns
TypeDescription
int
Overrides

getSuccessThreshold()

public int getSuccessThreshold()

Number of consecutive successful checks required before receiving traffic.

uint32 success_threshold = 4;

Returns
TypeDescription
int

The successThreshold.

getTimeout()

public Duration getTimeout()

Time before the check is considered failed.

.google.protobuf.Duration timeout = 6;

Returns
TypeDescription
Duration

The timeout.

getTimeoutOrBuilder()

public DurationOrBuilder getTimeoutOrBuilder()

Time before the check is considered failed.

.google.protobuf.Duration timeout = 6;

Returns
TypeDescription
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
TypeDescription
boolean

Whether the appStartTimeout field is set.

hasCheckInterval()

public boolean hasCheckInterval()

Interval between health checks.

.google.protobuf.Duration check_interval = 5;

Returns
TypeDescription
boolean

Whether the checkInterval field is set.

hasTimeout()

public boolean hasTimeout()

Time before the check is considered failed.

.google.protobuf.Duration timeout = 6;

Returns
TypeDescription
boolean

Whether the timeout field is set.

hashCode()

public int hashCode()
Returns
TypeDescription
int
Overrides

internalGetFieldAccessorTable()

protected GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
Returns
TypeDescription
FieldAccessorTable
Overrides

isInitialized()

public final boolean isInitialized()
Returns
TypeDescription
boolean
Overrides

newBuilderForType()

public ReadinessCheck.Builder newBuilderForType()
Returns
TypeDescription
ReadinessCheck.Builder

newBuilderForType(GeneratedMessageV3.BuilderParent parent)

protected ReadinessCheck.Builder newBuilderForType(GeneratedMessageV3.BuilderParent parent)
Parameter
NameDescription
parentBuilderParent
Returns
TypeDescription
ReadinessCheck.Builder
Overrides

newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)

protected Object newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)
Parameter
NameDescription
unusedUnusedPrivateParameter
Returns
TypeDescription
Object
Overrides

toBuilder()

public ReadinessCheck.Builder toBuilder()
Returns
TypeDescription
ReadinessCheck.Builder

writeTo(CodedOutputStream output)

public void writeTo(CodedOutputStream output)
Parameter
NameDescription
outputCodedOutputStream
Overrides
Exceptions
TypeDescription
IOException