Class HealthCheck.Builder (2.1.10)

public static final class HealthCheck.Builder extends GeneratedMessageV3.Builder<HealthCheck.Builder> implements HealthCheckOrBuilder

Health checking configuration for VM instances. Unhealthy instances are killed and replaced with new instances. Only applicable for instances in App Engine flexible environment.

Protobuf type google.appengine.v1.HealthCheck

Static Methods

getDescriptor()

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

Methods

addRepeatedField(Descriptors.FieldDescriptor field, Object value)

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

build()

public HealthCheck build()
Returns
TypeDescription
HealthCheck

buildPartial()

public HealthCheck buildPartial()
Returns
TypeDescription
HealthCheck

clear()

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

clearCheckInterval()

public HealthCheck.Builder clearCheckInterval()

Interval between health checks.

.google.protobuf.Duration check_interval = 6;

Returns
TypeDescription
HealthCheck.Builder

clearDisableHealthCheck()

public HealthCheck.Builder clearDisableHealthCheck()

Whether to explicitly disable health checks for this instance.

bool disable_health_check = 1;

Returns
TypeDescription
HealthCheck.Builder

This builder for chaining.

clearField(Descriptors.FieldDescriptor field)

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

clearHealthyThreshold()

public HealthCheck.Builder clearHealthyThreshold()

Number of consecutive successful health checks required before receiving traffic.

uint32 healthy_threshold = 3;

Returns
TypeDescription
HealthCheck.Builder

This builder for chaining.

clearHost()

public HealthCheck.Builder clearHost()

Host header to send when performing an HTTP health check. Example: "myapp.appspot.com"

string host = 2;

Returns
TypeDescription
HealthCheck.Builder

This builder for chaining.

clearOneof(Descriptors.OneofDescriptor oneof)

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

clearRestartThreshold()

public HealthCheck.Builder clearRestartThreshold()

Number of consecutive failed health checks required before an instance is restarted.

uint32 restart_threshold = 5;

Returns
TypeDescription
HealthCheck.Builder

This builder for chaining.

clearTimeout()

public HealthCheck.Builder clearTimeout()

Time before the health check is considered failed.

.google.protobuf.Duration timeout = 7;

Returns
TypeDescription
HealthCheck.Builder

clearUnhealthyThreshold()

public HealthCheck.Builder clearUnhealthyThreshold()

Number of consecutive failed health checks required before removing traffic.

uint32 unhealthy_threshold = 4;

Returns
TypeDescription
HealthCheck.Builder

This builder for chaining.

clone()

public HealthCheck.Builder clone()
Returns
TypeDescription
HealthCheck.Builder
Overrides

getCheckInterval()

public Duration getCheckInterval()

Interval between health checks.

.google.protobuf.Duration check_interval = 6;

Returns
TypeDescription
Duration

The checkInterval.

getCheckIntervalBuilder()

public Duration.Builder getCheckIntervalBuilder()

Interval between health checks.

.google.protobuf.Duration check_interval = 6;

Returns
TypeDescription
Builder

getCheckIntervalOrBuilder()

public DurationOrBuilder getCheckIntervalOrBuilder()

Interval between health checks.

.google.protobuf.Duration check_interval = 6;

Returns
TypeDescription
DurationOrBuilder

getDefaultInstanceForType()

public HealthCheck getDefaultInstanceForType()
Returns
TypeDescription
HealthCheck

getDescriptorForType()

public Descriptors.Descriptor getDescriptorForType()
Returns
TypeDescription
Descriptor
Overrides

getDisableHealthCheck()

public boolean getDisableHealthCheck()

Whether to explicitly disable health checks for this instance.

bool disable_health_check = 1;

Returns
TypeDescription
boolean

The disableHealthCheck.

getHealthyThreshold()

public int getHealthyThreshold()

Number of consecutive successful health checks required before receiving traffic.

uint32 healthy_threshold = 3;

Returns
TypeDescription
int

The healthyThreshold.

getHost()

public String getHost()

Host header to send when performing an HTTP health check. Example: "myapp.appspot.com"

string host = 2;

Returns
TypeDescription
String

The host.

getHostBytes()

public ByteString getHostBytes()

Host header to send when performing an HTTP health check. Example: "myapp.appspot.com"

string host = 2;

Returns
TypeDescription
ByteString

The bytes for host.

getRestartThreshold()

public int getRestartThreshold()

Number of consecutive failed health checks required before an instance is restarted.

uint32 restart_threshold = 5;

Returns
TypeDescription
int

The restartThreshold.

getTimeout()

public Duration getTimeout()

Time before the health check is considered failed.

.google.protobuf.Duration timeout = 7;

Returns
TypeDescription
Duration

The timeout.

getTimeoutBuilder()

public Duration.Builder getTimeoutBuilder()

Time before the health check is considered failed.

.google.protobuf.Duration timeout = 7;

Returns
TypeDescription
Builder

getTimeoutOrBuilder()

public DurationOrBuilder getTimeoutOrBuilder()

Time before the health check is considered failed.

.google.protobuf.Duration timeout = 7;

Returns
TypeDescription
DurationOrBuilder

getUnhealthyThreshold()

public int getUnhealthyThreshold()

Number of consecutive failed health checks required before removing traffic.

uint32 unhealthy_threshold = 4;

Returns
TypeDescription
int

The unhealthyThreshold.

hasCheckInterval()

public boolean hasCheckInterval()

Interval between health checks.

.google.protobuf.Duration check_interval = 6;

Returns
TypeDescription
boolean

Whether the checkInterval field is set.

hasTimeout()

public boolean hasTimeout()

Time before the health check is considered failed.

.google.protobuf.Duration timeout = 7;

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

mergeCheckInterval(Duration value)

public HealthCheck.Builder mergeCheckInterval(Duration value)

Interval between health checks.

.google.protobuf.Duration check_interval = 6;

Parameter
NameDescription
valueDuration
Returns
TypeDescription
HealthCheck.Builder

mergeFrom(HealthCheck other)

public HealthCheck.Builder mergeFrom(HealthCheck other)
Parameter
NameDescription
otherHealthCheck
Returns
TypeDescription
HealthCheck.Builder

mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

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

mergeFrom(Message other)

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

mergeTimeout(Duration value)

public HealthCheck.Builder mergeTimeout(Duration value)

Time before the health check is considered failed.

.google.protobuf.Duration timeout = 7;

Parameter
NameDescription
valueDuration
Returns
TypeDescription
HealthCheck.Builder

mergeUnknownFields(UnknownFieldSet unknownFields)

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

setCheckInterval(Duration value)

public HealthCheck.Builder setCheckInterval(Duration value)

Interval between health checks.

.google.protobuf.Duration check_interval = 6;

Parameter
NameDescription
valueDuration
Returns
TypeDescription
HealthCheck.Builder

setCheckInterval(Duration.Builder builderForValue)

public HealthCheck.Builder setCheckInterval(Duration.Builder builderForValue)

Interval between health checks.

.google.protobuf.Duration check_interval = 6;

Parameter
NameDescription
builderForValueBuilder
Returns
TypeDescription
HealthCheck.Builder

setDisableHealthCheck(boolean value)

public HealthCheck.Builder setDisableHealthCheck(boolean value)

Whether to explicitly disable health checks for this instance.

bool disable_health_check = 1;

Parameter
NameDescription
valueboolean

The disableHealthCheck to set.

Returns
TypeDescription
HealthCheck.Builder

This builder for chaining.

setField(Descriptors.FieldDescriptor field, Object value)

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

setHealthyThreshold(int value)

public HealthCheck.Builder setHealthyThreshold(int value)

Number of consecutive successful health checks required before receiving traffic.

uint32 healthy_threshold = 3;

Parameter
NameDescription
valueint

The healthyThreshold to set.

Returns
TypeDescription
HealthCheck.Builder

This builder for chaining.

setHost(String value)

public HealthCheck.Builder setHost(String value)

Host header to send when performing an HTTP health check. Example: "myapp.appspot.com"

string host = 2;

Parameter
NameDescription
valueString

The host to set.

Returns
TypeDescription
HealthCheck.Builder

This builder for chaining.

setHostBytes(ByteString value)

public HealthCheck.Builder setHostBytes(ByteString value)

Host header to send when performing an HTTP health check. Example: "myapp.appspot.com"

string host = 2;

Parameter
NameDescription
valueByteString

The bytes for host to set.

Returns
TypeDescription
HealthCheck.Builder

This builder for chaining.

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

public HealthCheck.Builder setRepeatedField(Descriptors.FieldDescriptor field, int index, Object value)
Parameters
NameDescription
fieldFieldDescriptor
indexint
valueObject
Returns
TypeDescription
HealthCheck.Builder
Overrides

setRestartThreshold(int value)

public HealthCheck.Builder setRestartThreshold(int value)

Number of consecutive failed health checks required before an instance is restarted.

uint32 restart_threshold = 5;

Parameter
NameDescription
valueint

The restartThreshold to set.

Returns
TypeDescription
HealthCheck.Builder

This builder for chaining.

setTimeout(Duration value)

public HealthCheck.Builder setTimeout(Duration value)

Time before the health check is considered failed.

.google.protobuf.Duration timeout = 7;

Parameter
NameDescription
valueDuration
Returns
TypeDescription
HealthCheck.Builder

setTimeout(Duration.Builder builderForValue)

public HealthCheck.Builder setTimeout(Duration.Builder builderForValue)

Time before the health check is considered failed.

.google.protobuf.Duration timeout = 7;

Parameter
NameDescription
builderForValueBuilder
Returns
TypeDescription
HealthCheck.Builder

setUnhealthyThreshold(int value)

public HealthCheck.Builder setUnhealthyThreshold(int value)

Number of consecutive failed health checks required before removing traffic.

uint32 unhealthy_threshold = 4;

Parameter
NameDescription
valueint

The unhealthyThreshold to set.

Returns
TypeDescription
HealthCheck.Builder

This builder for chaining.

setUnknownFields(UnknownFieldSet unknownFields)

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