Class ReadinessCheck.Builder (2.48.0)

Version 2.48.0

• 2.49.0 (latest)
• 2.48.0
• 2.47.0
• 2.46.0
• 2.45.0
• 2.44.0
• 2.43.0
• 2.42.0
• 2.41.0
• 2.40.0
• 2.39.0
• 2.37.0
• 2.36.0
• 2.35.0
• 2.34.0
• 2.33.0
• 2.32.0
• 2.31.0
• 2.30.0
• 2.29.0
• 2.28.0
• 2.27.0
• 2.24.0
• 2.23.0
• 2.22.0
• 2.21.0
• 2.20.0
• 2.19.0
• 2.18.0
• 2.17.0
• 2.16.0
• 2.15.0
• 2.14.0
• 2.13.0
• 2.12.0
• 2.11.0
• 2.10.0
• 2.9.0
• 2.8.0
• 2.7.0
• 2.6.0
• 2.5.0
• 2.4.0
• 2.3.4
• 2.2.0
• 2.1.10
• 0.2.0

public static final class ReadinessCheck.Builder extends GeneratedMessageV3.Builder<ReadinessCheck.Builder> implements ReadinessCheckOrBuilder

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

Implements

ReadinessCheckOrBuilder

Inherited Members

AbstractMessage.Builder.findInitializationErrors()

AbstractMessage.Builder.getInitializationErrorString()

AbstractMessage.Builder.internalMergeFrom(AbstractMessageLite)

AbstractMessage.Builder.mergeFrom(byte[])

AbstractMessage.Builder.mergeFrom(byte[],ExtensionRegistryLite)

AbstractMessage.Builder.mergeFrom(byte[],int,int)

AbstractMessage.Builder.mergeFrom(byte[],int,int,ExtensionRegistryLite)

AbstractMessage.Builder.mergeFrom(ByteString)

AbstractMessage.Builder.mergeFrom(ByteString,ExtensionRegistryLite)

AbstractMessage.Builder.mergeFrom(CodedInputStream)

AbstractMessage.Builder.mergeFrom(CodedInputStream,ExtensionRegistryLite)

AbstractMessage.Builder.mergeFrom(Message)

AbstractMessage.Builder.mergeFrom(InputStream)

AbstractMessage.Builder.mergeFrom(InputStream,ExtensionRegistryLite)

AbstractMessage.Builder.newUninitializedMessageException(Message)

AbstractMessage.Builder.toString()

AbstractMessageLite.Builder.<T>addAll(Iterable<T>,Collection<? super T>)

AbstractMessageLite.Builder.<T>addAll(Iterable<T>,List<? super T>)

AbstractMessageLite.Builder.internalMergeFrom(MessageType)

AbstractMessageLite.Builder.mergeDelimitedFrom(InputStream)

AbstractMessageLite.Builder.mergeDelimitedFrom(InputStream,ExtensionRegistryLite)

AbstractMessageLite.Builder.mergeFrom(MessageLite)

AbstractMessageLite.Builder.newUninitializedMessageException(MessageLite)

GeneratedMessageV3.Builder.addRepeatedField(Descriptors.FieldDescriptor,Object)

GeneratedMessageV3.Builder.clear()

GeneratedMessageV3.Builder.clearField(Descriptors.FieldDescriptor)

GeneratedMessageV3.Builder.clearOneof(Descriptors.OneofDescriptor)

GeneratedMessageV3.Builder.clone()

GeneratedMessageV3.Builder.getAllFields()

GeneratedMessageV3.Builder.getDescriptorForType()

GeneratedMessageV3.Builder.getField(Descriptors.FieldDescriptor)

GeneratedMessageV3.Builder.getFieldBuilder(Descriptors.FieldDescriptor)

GeneratedMessageV3.Builder.getOneofFieldDescriptor(Descriptors.OneofDescriptor)

GeneratedMessageV3.Builder.getParentForChildren()

GeneratedMessageV3.Builder.getRepeatedField(Descriptors.FieldDescriptor,int)

GeneratedMessageV3.Builder.getRepeatedFieldBuilder(Descriptors.FieldDescriptor,int)

GeneratedMessageV3.Builder.getRepeatedFieldCount(Descriptors.FieldDescriptor)

com.google.protobuf.GeneratedMessageV3.Builder.getUnknownFieldSetBuilder()

GeneratedMessageV3.Builder.getUnknownFields()

GeneratedMessageV3.Builder.hasField(Descriptors.FieldDescriptor)

GeneratedMessageV3.Builder.hasOneof(Descriptors.OneofDescriptor)

GeneratedMessageV3.Builder.internalGetFieldAccessorTable()

GeneratedMessageV3.Builder.internalGetMapField(int)

com.google.protobuf.GeneratedMessageV3.Builder.internalGetMapFieldReflection(int)

GeneratedMessageV3.Builder.internalGetMutableMapField(int)

com.google.protobuf.GeneratedMessageV3.Builder.internalGetMutableMapFieldReflection(int)

GeneratedMessageV3.Builder.isClean()

GeneratedMessageV3.Builder.isInitialized()

GeneratedMessageV3.Builder.markClean()

GeneratedMessageV3.Builder.mergeUnknownFields(UnknownFieldSet)

com.google.protobuf.GeneratedMessageV3.Builder.mergeUnknownLengthDelimitedField(int,com.google.protobuf.ByteString)

com.google.protobuf.GeneratedMessageV3.Builder.mergeUnknownVarintField(int,int)

GeneratedMessageV3.Builder.newBuilderForField(Descriptors.FieldDescriptor)

GeneratedMessageV3.Builder.onBuilt()

GeneratedMessageV3.Builder.onChanged()

com.google.protobuf.GeneratedMessageV3.Builder.parseUnknownField(com.google.protobuf.CodedInputStream,com.google.protobuf.ExtensionRegistryLite,int)

GeneratedMessageV3.Builder.setField(Descriptors.FieldDescriptor,Object)

GeneratedMessageV3.Builder.setRepeatedField(Descriptors.FieldDescriptor,int,Object)

com.google.protobuf.GeneratedMessageV3.Builder.setUnknownFieldSetBuilder(com.google.protobuf.UnknownFieldSet.Builder)

GeneratedMessageV3.Builder.setUnknownFields(UnknownFieldSet)

GeneratedMessageV3.Builder.setUnknownFieldsProto3(UnknownFieldSet)

Object.equals(Object)

Object.finalize()

Object.getClass()

Object.hashCode()

Object.notify()

Object.notifyAll()

Object.wait()

Object.wait(long)

Object.wait(long,int)

Static 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

Overrides

GeneratedMessageV3.Builder<BuilderType>.addRepeatedField(Descriptors.FieldDescriptor field, Object value)

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

Overrides

GeneratedMessageV3.Builder<BuilderType>.clear()

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

Overrides

GeneratedMessageV3.Builder<BuilderType>.clearField(Descriptors.FieldDescriptor field)

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

Overrides

GeneratedMessageV3.Builder<BuilderType>.clearOneof(Descriptors.OneofDescriptor oneof)

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

Overrides

GeneratedMessageV3.Builder<BuilderType>.clone()

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

Overrides

GeneratedMessageV3.Builder<BuilderType>.getDescriptorForType()

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

Overrides

GeneratedMessageV3.Builder<BuilderType>.internalGetFieldAccessorTable()

isInitialized()

public final boolean isInitialized()

Returns
Type	Description
boolean

Overrides

GeneratedMessageV3.Builder<BuilderType>.isInitialized()

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

Overrides

AbstractMessage.Builder<BuilderType>.mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

Exceptions
Type	Description
IOException

mergeFrom(Message other)

public ReadinessCheck.Builder mergeFrom(Message other)

Parameter
Name	Description
other	Message

Returns
Type	Description
ReadinessCheck.Builder

Overrides

AbstractMessage.Builder<BuilderType>.mergeFrom(Message other)

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

Overrides

GeneratedMessageV3.Builder<BuilderType>.mergeUnknownFields(UnknownFieldSet unknownFields)

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	int The 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

Overrides

GeneratedMessageV3.Builder<BuilderType>.setField(Descriptors.FieldDescriptor field, Object value)

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	String The 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	ByteString The 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	String The 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	ByteString The 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

Overrides

GeneratedMessageV3.Builder<BuilderType>.setRepeatedField(Descriptors.FieldDescriptor field, int index, Object value)

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	int The 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

Overrides

GeneratedMessageV3.Builder<BuilderType>.setUnknownFields(UnknownFieldSet unknownFields)