public static final class ReadinessCheck.Builder extends GeneratedMessageV3.Builder<ReadinessCheck.Builder> implements ReadinessCheckOrBuilderReadiness checking configuration for VM instances. Unhealthy instances are removed from traffic rotation.
Protobuf type google.appengine.v1.ReadinessCheck
Inheritance
Object > AbstractMessageLite.Builder<MessageType,BuilderType> > AbstractMessage.Builder<BuilderType> > GeneratedMessageV3.Builder > ReadinessCheck.BuilderImplements
ReadinessCheckOrBuilderStatic Methods
getDescriptor()
public static final Descriptors.Descriptor getDescriptor()| Returns | |
|---|---|
| Type | Description |
Descriptor |
|
Methods
addRepeatedField(Descriptors.FieldDescriptor field, Object value)
public ReadinessCheck.Builder addRepeatedField(Descriptors.FieldDescriptor field, Object value)| Parameters | |
|---|---|
| Name | Description |
field |
FieldDescriptor |
value |
Object |
| Returns | |
|---|---|
| Type | Description |
ReadinessCheck.Builder |
|
build()
public ReadinessCheck build()| Returns | |
|---|---|
| Type | Description |
ReadinessCheck |
|
buildPartial()
public ReadinessCheck buildPartial()| Returns | |
|---|---|
| Type | Description |
ReadinessCheck |
|
clear()
public ReadinessCheck.Builder clear()| Returns | |
|---|---|
| Type | Description |
ReadinessCheck.Builder |
|
clearAppStartTimeout()
public ReadinessCheck.Builder clearAppStartTimeout()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()
public ReadinessCheck.Builder clearCheckInterval()Interval between health checks.
.google.protobuf.Duration check_interval = 5;
| Returns | |
|---|---|
| Type | Description |
ReadinessCheck.Builder |
|
clearFailureThreshold()
public ReadinessCheck.Builder clearFailureThreshold()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)
public ReadinessCheck.Builder clearField(Descriptors.FieldDescriptor field)| Parameter | |
|---|---|
| Name | Description |
field |
FieldDescriptor |
| Returns | |
|---|---|
| Type | Description |
ReadinessCheck.Builder |
|
clearHost()
public ReadinessCheck.Builder clearHost()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)
public ReadinessCheck.Builder clearOneof(Descriptors.OneofDescriptor oneof)| Parameter | |
|---|---|
| Name | Description |
oneof |
OneofDescriptor |
| Returns | |
|---|---|
| Type | Description |
ReadinessCheck.Builder |
|
clearPath()
public ReadinessCheck.Builder clearPath()The request path.
string path = 1;
| Returns | |
|---|---|
| Type | Description |
ReadinessCheck.Builder |
This builder for chaining. |
clearSuccessThreshold()
public ReadinessCheck.Builder clearSuccessThreshold()Number of consecutive successful checks required before receiving traffic.
uint32 success_threshold = 4;
| Returns | |
|---|---|
| Type | Description |
ReadinessCheck.Builder |
This builder for chaining. |
clearTimeout()
public ReadinessCheck.Builder clearTimeout()Time before the check is considered failed.
.google.protobuf.Duration timeout = 6;
| Returns | |
|---|---|
| Type | Description |
ReadinessCheck.Builder |
|
clone()
public ReadinessCheck.Builder clone()| Returns | |
|---|---|
| Type | Description |
ReadinessCheck.Builder |
|
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. |
getAppStartTimeoutBuilder()
public Duration.Builder getAppStartTimeoutBuilder()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()
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. |
getCheckIntervalBuilder()
public Duration.Builder getCheckIntervalBuilder()Interval between health checks.
.google.protobuf.Duration check_interval = 5;
| Returns | |
|---|---|
| Type | Description |
Builder |
|
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 |
|
getDescriptorForType()
public Descriptors.Descriptor getDescriptorForType()| Returns | |
|---|---|
| Type | Description |
Descriptor |
|
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. |
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. |
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. |
getTimeoutBuilder()
public Duration.Builder getTimeoutBuilder()Time before the check is considered failed.
.google.protobuf.Duration timeout = 6;
| Returns | |
|---|---|
| Type | Description |
Builder |
|
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. |
internalGetFieldAccessorTable()
protected GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()| Returns | |
|---|---|
| Type | Description |
FieldAccessorTable |
|
isInitialized()
public final boolean isInitialized()| Returns | |
|---|---|
| Type | Description |
boolean |
|
mergeAppStartTimeout(Duration value)
public ReadinessCheck.Builder mergeAppStartTimeout(Duration value)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)
public ReadinessCheck.Builder mergeCheckInterval(Duration value)Interval between health checks.
.google.protobuf.Duration check_interval = 5;
| Parameter | |
|---|---|
| Name | Description |
value |
Duration |
| Returns | |
|---|---|
| Type | Description |
ReadinessCheck.Builder |
|
mergeFrom(ReadinessCheck other)
public ReadinessCheck.Builder mergeFrom(ReadinessCheck other)| Parameter | |
|---|---|
| Name | Description |
other |
ReadinessCheck |
| Returns | |
|---|---|
| Type | Description |
ReadinessCheck.Builder |
|
mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
public ReadinessCheck.Builder mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)| Parameters | |
|---|---|
| Name | Description |
input |
CodedInputStream |
extensionRegistry |
ExtensionRegistryLite |
| Returns | |
|---|---|
| Type | Description |
ReadinessCheck.Builder |
|
| Exceptions | |
|---|---|
| Type | Description |
IOException |
|
mergeFrom(Message other)
public ReadinessCheck.Builder mergeFrom(Message other)| Parameter | |
|---|---|
| Name | Description |
other |
Message |
| Returns | |
|---|---|
| Type | Description |
ReadinessCheck.Builder |
|
mergeTimeout(Duration value)
public ReadinessCheck.Builder mergeTimeout(Duration value)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)
public final ReadinessCheck.Builder mergeUnknownFields(UnknownFieldSet unknownFields)| Parameter | |
|---|---|
| Name | Description |
unknownFields |
UnknownFieldSet |
| Returns | |
|---|---|
| Type | Description |
ReadinessCheck.Builder |
|
setAppStartTimeout(Duration value)
public ReadinessCheck.Builder setAppStartTimeout(Duration value)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)
public ReadinessCheck.Builder setAppStartTimeout(Duration.Builder builderForValue)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)
public ReadinessCheck.Builder setCheckInterval(Duration value)Interval between health checks.
.google.protobuf.Duration check_interval = 5;
| Parameter | |
|---|---|
| Name | Description |
value |
Duration |
| Returns | |
|---|---|
| Type | Description |
ReadinessCheck.Builder |
|
setCheckInterval(Duration.Builder builderForValue)
public ReadinessCheck.Builder setCheckInterval(Duration.Builder builderForValue)Interval between health checks.
.google.protobuf.Duration check_interval = 5;
| Parameter | |
|---|---|
| Name | Description |
builderForValue |
Builder |
| Returns | |
|---|---|
| Type | Description |
ReadinessCheck.Builder |
|
setFailureThreshold(int value)
public ReadinessCheck.Builder setFailureThreshold(int value)Number of consecutive failed checks required before removing traffic.
uint32 failure_threshold = 3;
| Parameter | |
|---|---|
| Name | Description |
value |
intThe failureThreshold to set. |
| Returns | |
|---|---|
| Type | Description |
ReadinessCheck.Builder |
This builder for chaining. |
setField(Descriptors.FieldDescriptor field, Object value)
public ReadinessCheck.Builder setField(Descriptors.FieldDescriptor field, Object value)| Parameters | |
|---|---|
| Name | Description |
field |
FieldDescriptor |
value |
Object |
| Returns | |
|---|---|
| Type | Description |
ReadinessCheck.Builder |
|
setHost(String value)
public ReadinessCheck.Builder setHost(String value)Host header to send when performing a HTTP Readiness check. Example: "myapp.appspot.com"
string host = 2;
| Parameter | |
|---|---|
| Name | Description |
value |
StringThe host to set. |
| Returns | |
|---|---|
| Type | Description |
ReadinessCheck.Builder |
This builder for chaining. |
setHostBytes(ByteString value)
public ReadinessCheck.Builder setHostBytes(ByteString value)Host header to send when performing a HTTP Readiness check. Example: "myapp.appspot.com"
string host = 2;
| Parameter | |
|---|---|
| Name | Description |
value |
ByteStringThe bytes for host to set. |
| Returns | |
|---|---|
| Type | Description |
ReadinessCheck.Builder |
This builder for chaining. |
setPath(String value)
public ReadinessCheck.Builder setPath(String value)The request path.
string path = 1;
| Parameter | |
|---|---|
| Name | Description |
value |
StringThe path to set. |
| Returns | |
|---|---|
| Type | Description |
ReadinessCheck.Builder |
This builder for chaining. |
setPathBytes(ByteString value)
public ReadinessCheck.Builder setPathBytes(ByteString value)The request path.
string path = 1;
| Parameter | |
|---|---|
| Name | Description |
value |
ByteStringThe bytes for path to set. |
| Returns | |
|---|---|
| Type | Description |
ReadinessCheck.Builder |
This builder for chaining. |
setRepeatedField(Descriptors.FieldDescriptor field, int index, Object value)
public ReadinessCheck.Builder setRepeatedField(Descriptors.FieldDescriptor field, int index, Object value)| Parameters | |
|---|---|
| Name | Description |
field |
FieldDescriptor |
index |
int |
value |
Object |
| Returns | |
|---|---|
| Type | Description |
ReadinessCheck.Builder |
|
setSuccessThreshold(int value)
public ReadinessCheck.Builder setSuccessThreshold(int value)Number of consecutive successful checks required before receiving traffic.
uint32 success_threshold = 4;
| Parameter | |
|---|---|
| Name | Description |
value |
intThe successThreshold to set. |
| Returns | |
|---|---|
| Type | Description |
ReadinessCheck.Builder |
This builder for chaining. |
setTimeout(Duration value)
public ReadinessCheck.Builder setTimeout(Duration value)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)
public ReadinessCheck.Builder setTimeout(Duration.Builder builderForValue)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)
public final ReadinessCheck.Builder setUnknownFields(UnknownFieldSet unknownFields)| Parameter | |
|---|---|
| Name | Description |
unknownFields |
UnknownFieldSet |
| Returns | |
|---|---|
| Type | Description |
ReadinessCheck.Builder |
|