Class ReadinessCheck.Builder (2.3.4)

Stay organized with collections Save and categorize content based on your preferences.
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

Static Methods

getDescriptor()

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

Methods

addRepeatedField(Descriptors.FieldDescriptor field, Object value)

public ReadinessCheck.Builder addRepeatedField(Descriptors.FieldDescriptor field, Object value)
Parameters
NameDescription
fieldFieldDescriptor
valueObject
Returns
TypeDescription
ReadinessCheck.Builder
Overrides

build()

public ReadinessCheck build()
Returns
TypeDescription
ReadinessCheck

buildPartial()

public ReadinessCheck buildPartial()
Returns
TypeDescription
ReadinessCheck

clear()

public ReadinessCheck.Builder clear()
Returns
TypeDescription
ReadinessCheck.Builder
Overrides

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

clearCheckInterval()

public ReadinessCheck.Builder clearCheckInterval()

Interval between health checks.

.google.protobuf.Duration check_interval = 5;

Returns
TypeDescription
ReadinessCheck.Builder

clearFailureThreshold()

public ReadinessCheck.Builder clearFailureThreshold()

Number of consecutive failed checks required before removing traffic.

uint32 failure_threshold = 3;

Returns
TypeDescription
ReadinessCheck.Builder

This builder for chaining.

clearField(Descriptors.FieldDescriptor field)

public ReadinessCheck.Builder clearField(Descriptors.FieldDescriptor field)
Parameter
NameDescription
fieldFieldDescriptor
Returns
TypeDescription
ReadinessCheck.Builder
Overrides

clearHost()

public ReadinessCheck.Builder clearHost()

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

string host = 2;

Returns
TypeDescription
ReadinessCheck.Builder

This builder for chaining.

clearOneof(Descriptors.OneofDescriptor oneof)

public ReadinessCheck.Builder clearOneof(Descriptors.OneofDescriptor oneof)
Parameter
NameDescription
oneofOneofDescriptor
Returns
TypeDescription
ReadinessCheck.Builder
Overrides

clearPath()

public ReadinessCheck.Builder clearPath()

The request path.

string path = 1;

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

This builder for chaining.

clearTimeout()

public ReadinessCheck.Builder clearTimeout()

Time before the check is considered failed.

.google.protobuf.Duration timeout = 6;

Returns
TypeDescription
ReadinessCheck.Builder

clone()

public ReadinessCheck.Builder clone()
Returns
TypeDescription
ReadinessCheck.Builder
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.

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
TypeDescription
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
TypeDescription
DurationOrBuilder

getCheckInterval()

public Duration getCheckInterval()

Interval between health checks.

.google.protobuf.Duration check_interval = 5;

Returns
TypeDescription
Duration

The checkInterval.

getCheckIntervalBuilder()

public Duration.Builder getCheckIntervalBuilder()

Interval between health checks.

.google.protobuf.Duration check_interval = 5;

Returns
TypeDescription
Builder

getCheckIntervalOrBuilder()

public DurationOrBuilder getCheckIntervalOrBuilder()

Interval between health checks.

.google.protobuf.Duration check_interval = 5;

Returns
TypeDescription
DurationOrBuilder

getDefaultInstanceForType()

public ReadinessCheck getDefaultInstanceForType()
Returns
TypeDescription
ReadinessCheck

getDescriptorForType()

public Descriptors.Descriptor getDescriptorForType()
Returns
TypeDescription
Descriptor
Overrides

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.

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.

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.

getTimeoutBuilder()

public Duration.Builder getTimeoutBuilder()

Time before the check is considered failed.

.google.protobuf.Duration timeout = 6;

Returns
TypeDescription
Builder

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.

internalGetFieldAccessorTable()

protected GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
Returns
TypeDescription
FieldAccessorTable
Overrides

isInitialized()

public final boolean isInitialized()
Returns
TypeDescription
boolean
Overrides

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
NameDescription
valueDuration
Returns
TypeDescription
ReadinessCheck.Builder

mergeCheckInterval(Duration value)

public ReadinessCheck.Builder mergeCheckInterval(Duration value)

Interval between health checks.

.google.protobuf.Duration check_interval = 5;

Parameter
NameDescription
valueDuration
Returns
TypeDescription
ReadinessCheck.Builder

mergeFrom(ReadinessCheck other)

public ReadinessCheck.Builder mergeFrom(ReadinessCheck other)
Parameter
NameDescription
otherReadinessCheck
Returns
TypeDescription
ReadinessCheck.Builder

mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

public ReadinessCheck.Builder mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
NameDescription
inputCodedInputStream
extensionRegistryExtensionRegistryLite
Returns
TypeDescription
ReadinessCheck.Builder
Overrides Exceptions
TypeDescription
IOException

mergeFrom(Message other)

public ReadinessCheck.Builder mergeFrom(Message other)
Parameter
NameDescription
otherMessage
Returns
TypeDescription
ReadinessCheck.Builder
Overrides

mergeTimeout(Duration value)

public ReadinessCheck.Builder mergeTimeout(Duration value)

Time before the check is considered failed.

.google.protobuf.Duration timeout = 6;

Parameter
NameDescription
valueDuration
Returns
TypeDescription
ReadinessCheck.Builder

mergeUnknownFields(UnknownFieldSet unknownFields)

public final ReadinessCheck.Builder mergeUnknownFields(UnknownFieldSet unknownFields)
Parameter
NameDescription
unknownFieldsUnknownFieldSet
Returns
TypeDescription
ReadinessCheck.Builder
Overrides

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
NameDescription
valueDuration
Returns
TypeDescription
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
NameDescription
builderForValueBuilder
Returns
TypeDescription
ReadinessCheck.Builder

setCheckInterval(Duration value)

public ReadinessCheck.Builder setCheckInterval(Duration value)

Interval between health checks.

.google.protobuf.Duration check_interval = 5;

Parameter
NameDescription
valueDuration
Returns
TypeDescription
ReadinessCheck.Builder

setCheckInterval(Duration.Builder builderForValue)

public ReadinessCheck.Builder setCheckInterval(Duration.Builder builderForValue)

Interval between health checks.

.google.protobuf.Duration check_interval = 5;

Parameter
NameDescription
builderForValueBuilder
Returns
TypeDescription
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
NameDescription
valueint

The failureThreshold to set.

Returns
TypeDescription
ReadinessCheck.Builder

This builder for chaining.

setField(Descriptors.FieldDescriptor field, Object value)

public ReadinessCheck.Builder setField(Descriptors.FieldDescriptor field, Object value)
Parameters
NameDescription
fieldFieldDescriptor
valueObject
Returns
TypeDescription
ReadinessCheck.Builder
Overrides

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
NameDescription
valueString

The host to set.

Returns
TypeDescription
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
NameDescription
valueByteString

The bytes for host to set.

Returns
TypeDescription
ReadinessCheck.Builder

This builder for chaining.

setPath(String value)

public ReadinessCheck.Builder setPath(String value)

The request path.

string path = 1;

Parameter
NameDescription
valueString

The path to set.

Returns
TypeDescription
ReadinessCheck.Builder

This builder for chaining.

setPathBytes(ByteString value)

public ReadinessCheck.Builder setPathBytes(ByteString value)

The request path.

string path = 1;

Parameter
NameDescription
valueByteString

The bytes for path to set.

Returns
TypeDescription
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
NameDescription
fieldFieldDescriptor
indexint
valueObject
Returns
TypeDescription
ReadinessCheck.Builder
Overrides

setSuccessThreshold(int value)

public ReadinessCheck.Builder setSuccessThreshold(int value)

Number of consecutive successful checks required before receiving traffic.

uint32 success_threshold = 4;

Parameter
NameDescription
valueint

The successThreshold to set.

Returns
TypeDescription
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
NameDescription
valueDuration
Returns
TypeDescription
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
NameDescription
builderForValueBuilder
Returns
TypeDescription
ReadinessCheck.Builder

setUnknownFields(UnknownFieldSet unknownFields)

public final ReadinessCheck.Builder setUnknownFields(UnknownFieldSet unknownFields)
Parameter
NameDescription
unknownFieldsUnknownFieldSet
Returns
TypeDescription
ReadinessCheck.Builder
Overrides