Class ReadinessCheck.Builder (2.47.0)

publicstaticfinalclass ReadinessCheck.BuilderextendsGeneratedMessageV3.Builder<ReadinessCheck.Builder>implementsReadinessCheckOrBuilder

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.Builder.getUnknownFieldSetBuilder()
com.google.protobuf.GeneratedMessageV3.Builder.internalGetMapFieldReflection(int)
com.google.protobuf.GeneratedMessageV3.Builder.internalGetMutableMapFieldReflection(int)
com.google.protobuf.GeneratedMessageV3.Builder.mergeUnknownLengthDelimitedField(int,com.google.protobuf.ByteString)
com.google.protobuf.GeneratedMessageV3.Builder.mergeUnknownVarintField(int,int)
com.google.protobuf.GeneratedMessageV3.Builder.parseUnknownField(com.google.protobuf.CodedInputStream,com.google.protobuf.ExtensionRegistryLite,int)
com.google.protobuf.GeneratedMessageV3.Builder.setUnknownFieldSetBuilder(com.google.protobuf.UnknownFieldSet.Builder)

Static Methods

getDescriptor()

publicstaticfinalDescriptors.DescriptorgetDescriptor()
Returns
Type Description
Descriptor

Methods

addRepeatedField(Descriptors.FieldDescriptor field, Object value)

publicReadinessCheck.BuilderaddRepeatedField(Descriptors.FieldDescriptorfield,Objectvalue)
Parameters
Name Description
field FieldDescriptor
value Object
Returns
Type Description
ReadinessCheck.Builder
Overrides

build()

publicReadinessCheckbuild()
Returns
Type Description
ReadinessCheck

buildPartial()

publicReadinessCheckbuildPartial()
Returns
Type Description
ReadinessCheck

clear()

publicReadinessCheck.Builderclear()
Returns
Type Description
ReadinessCheck.Builder
Overrides

clearAppStartTimeout()

publicReadinessCheck.BuilderclearAppStartTimeout()

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
ReadinessCheck.Builder

clearCheckInterval()

publicReadinessCheck.BuilderclearCheckInterval()

Interval between health checks.

.google.protobuf.Duration check_interval = 5;

Returns
Type Description
ReadinessCheck.Builder

clearFailureThreshold()

publicReadinessCheck.BuilderclearFailureThreshold()

Number of consecutive failed checks required before removing traffic.

uint32 failure_threshold = 3;

Returns
Type Description
ReadinessCheck.Builder

This builder for chaining.

clearField(Descriptors.FieldDescriptor field)

publicReadinessCheck.BuilderclearField(Descriptors.FieldDescriptorfield)
Parameter
Name Description
field FieldDescriptor
Returns
Type Description
ReadinessCheck.Builder
Overrides

clearHost()

publicReadinessCheck.BuilderclearHost()

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

string host = 2;

Returns
Type Description
ReadinessCheck.Builder

This builder for chaining.

clearOneof(Descriptors.OneofDescriptor oneof)

publicReadinessCheck.BuilderclearOneof(Descriptors.OneofDescriptoroneof)
Parameter
Name Description
oneof OneofDescriptor
Returns
Type Description
ReadinessCheck.Builder
Overrides

clearPath()

publicReadinessCheck.BuilderclearPath()

The request path.

string path = 1;

Returns
Type Description
ReadinessCheck.Builder

This builder for chaining.

clearSuccessThreshold()

publicReadinessCheck.BuilderclearSuccessThreshold()

Number of consecutive successful checks required before receiving traffic.

uint32 success_threshold = 4;

Returns
Type Description
ReadinessCheck.Builder

This builder for chaining.

clearTimeout()

publicReadinessCheck.BuilderclearTimeout()

Time before the check is considered failed.

.google.protobuf.Duration timeout = 6;

Returns
Type Description
ReadinessCheck.Builder

clone()

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

getAppStartTimeoutBuilder()

publicDuration.BuildergetAppStartTimeoutBuilder()

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
Builder

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.

getCheckIntervalBuilder()

publicDuration.BuildergetCheckIntervalBuilder()

Interval between health checks.

.google.protobuf.Duration check_interval = 5;

Returns
Type Description
Builder

getCheckIntervalOrBuilder()

publicDurationOrBuildergetCheckIntervalOrBuilder()

Interval between health checks.

.google.protobuf.Duration check_interval = 5;

Returns
Type Description
DurationOrBuilder

getDefaultInstanceForType()

publicReadinessCheckgetDefaultInstanceForType()
Returns
Type Description
ReadinessCheck

getDescriptorForType()

publicDescriptors.DescriptorgetDescriptorForType()
Returns
Type Description
Descriptor
Overrides

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.

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.

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.

getTimeoutBuilder()

publicDuration.BuildergetTimeoutBuilder()

Time before the check is considered failed.

.google.protobuf.Duration timeout = 6;

Returns
Type Description
Builder

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.

internalGetFieldAccessorTable()

protectedGeneratedMessageV3.FieldAccessorTableinternalGetFieldAccessorTable()
Returns
Type Description
FieldAccessorTable
Overrides

isInitialized()

publicfinalbooleanisInitialized()
Returns
Type Description
boolean
Overrides

mergeAppStartTimeout(Duration value)

publicReadinessCheck.BuildermergeAppStartTimeout(Durationvalue)

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;

Parameter
Name Description
value Duration
Returns
Type Description
ReadinessCheck.Builder

mergeCheckInterval(Duration value)

publicReadinessCheck.BuildermergeCheckInterval(Durationvalue)

Interval between health checks.

.google.protobuf.Duration check_interval = 5;

Parameter
Name Description
value Duration
Returns
Type Description
ReadinessCheck.Builder

mergeFrom(ReadinessCheck other)

publicReadinessCheck.BuildermergeFrom(ReadinessCheckother)
Parameter
Name Description
other ReadinessCheck
Returns
Type Description
ReadinessCheck.Builder

mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

publicReadinessCheck.BuildermergeFrom(CodedInputStreaminput,ExtensionRegistryLiteextensionRegistry)
Parameters
Name Description
input CodedInputStream
extensionRegistry ExtensionRegistryLite
Returns
Type Description
ReadinessCheck.Builder
Overrides
Exceptions
Type Description
IOException

mergeFrom(Message other)

publicReadinessCheck.BuildermergeFrom(Messageother)
Parameter
Name Description
other Message
Returns
Type Description
ReadinessCheck.Builder
Overrides

mergeTimeout(Duration value)

publicReadinessCheck.BuildermergeTimeout(Durationvalue)

Time before the check is considered failed.

.google.protobuf.Duration timeout = 6;

Parameter
Name Description
value Duration
Returns
Type Description
ReadinessCheck.Builder

mergeUnknownFields(UnknownFieldSet unknownFields)

publicfinalReadinessCheck.BuildermergeUnknownFields(UnknownFieldSetunknownFields)
Parameter
Name Description
unknownFields UnknownFieldSet
Returns
Type Description
ReadinessCheck.Builder
Overrides

setAppStartTimeout(Duration value)

publicReadinessCheck.BuildersetAppStartTimeout(Durationvalue)

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;

Parameter
Name Description
value Duration
Returns
Type Description
ReadinessCheck.Builder

setAppStartTimeout(Duration.Builder builderForValue)

publicReadinessCheck.BuildersetAppStartTimeout(Duration.BuilderbuilderForValue)

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;

Parameter
Name Description
builderForValue Builder
Returns
Type Description
ReadinessCheck.Builder

setCheckInterval(Duration value)

publicReadinessCheck.BuildersetCheckInterval(Durationvalue)

Interval between health checks.

.google.protobuf.Duration check_interval = 5;

Parameter
Name Description
value Duration
Returns
Type Description
ReadinessCheck.Builder

setCheckInterval(Duration.Builder builderForValue)

publicReadinessCheck.BuildersetCheckInterval(Duration.BuilderbuilderForValue)

Interval between health checks.

.google.protobuf.Duration check_interval = 5;

Parameter
Name Description
builderForValue Builder
Returns
Type Description
ReadinessCheck.Builder

setFailureThreshold(int value)

publicReadinessCheck.BuildersetFailureThreshold(intvalue)

Number of consecutive failed checks required before removing traffic.

uint32 failure_threshold = 3;

Parameter
Name Description
value int

The failureThreshold to set.

Returns
Type Description
ReadinessCheck.Builder

This builder for chaining.

setField(Descriptors.FieldDescriptor field, Object value)

publicReadinessCheck.BuildersetField(Descriptors.FieldDescriptorfield,Objectvalue)
Parameters
Name Description
field FieldDescriptor
value Object
Returns
Type Description
ReadinessCheck.Builder
Overrides

setHost(String value)

publicReadinessCheck.BuildersetHost(Stringvalue)

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

string host = 2;

Parameter
Name Description
value String

The host to set.

Returns
Type Description
ReadinessCheck.Builder

This builder for chaining.

setHostBytes(ByteString value)

publicReadinessCheck.BuildersetHostBytes(ByteStringvalue)

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

string host = 2;

Parameter
Name Description
value ByteString

The bytes for host to set.

Returns
Type Description
ReadinessCheck.Builder

This builder for chaining.

setPath(String value)

publicReadinessCheck.BuildersetPath(Stringvalue)

The request path.

string path = 1;

Parameter
Name Description
value String

The path to set.

Returns
Type Description
ReadinessCheck.Builder

This builder for chaining.

setPathBytes(ByteString value)

publicReadinessCheck.BuildersetPathBytes(ByteStringvalue)

The request path.

string path = 1;

Parameter
Name Description
value ByteString

The bytes for path to set.

Returns
Type Description
ReadinessCheck.Builder

This builder for chaining.

setRepeatedField(Descriptors.FieldDescriptor field, int index, Object value)

publicReadinessCheck.BuildersetRepeatedField(Descriptors.FieldDescriptorfield,intindex,Objectvalue)
Parameters
Name Description
field FieldDescriptor
index int
value Object
Returns
Type Description
ReadinessCheck.Builder
Overrides

setSuccessThreshold(int value)

publicReadinessCheck.BuildersetSuccessThreshold(intvalue)

Number of consecutive successful checks required before receiving traffic.

uint32 success_threshold = 4;

Parameter
Name Description
value int

The successThreshold to set.

Returns
Type Description
ReadinessCheck.Builder

This builder for chaining.

setTimeout(Duration value)

publicReadinessCheck.BuildersetTimeout(Durationvalue)

Time before the check is considered failed.

.google.protobuf.Duration timeout = 6;

Parameter
Name Description
value Duration
Returns
Type Description
ReadinessCheck.Builder

setTimeout(Duration.Builder builderForValue)

publicReadinessCheck.BuildersetTimeout(Duration.BuilderbuilderForValue)

Time before the check is considered failed.

.google.protobuf.Duration timeout = 6;

Parameter
Name Description
builderForValue Builder
Returns
Type Description
ReadinessCheck.Builder

setUnknownFields(UnknownFieldSet unknownFields)

publicfinalReadinessCheck.BuildersetUnknownFields(UnknownFieldSetunknownFields)
Parameter
Name Description
unknownFields UnknownFieldSet
Returns
Type Description
ReadinessCheck.Builder
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月30日 UTC.