Class HealthCheck

public final class HealthCheck extends GeneratedMessageV3 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

Fields

CHECK_INTERVAL_FIELD_NUMBER

public static final int CHECK_INTERVAL_FIELD_NUMBER
Field Value
TypeDescription
int

DISABLE_HEALTH_CHECK_FIELD_NUMBER

public static final int DISABLE_HEALTH_CHECK_FIELD_NUMBER
Field Value
TypeDescription
int

HEALTHY_THRESHOLD_FIELD_NUMBER

public static final int HEALTHY_THRESHOLD_FIELD_NUMBER
Field Value
TypeDescription
int

HOST_FIELD_NUMBER

public static final int HOST_FIELD_NUMBER
Field Value
TypeDescription
int

RESTART_THRESHOLD_FIELD_NUMBER

public static final int RESTART_THRESHOLD_FIELD_NUMBER
Field Value
TypeDescription
int

TIMEOUT_FIELD_NUMBER

public static final int TIMEOUT_FIELD_NUMBER
Field Value
TypeDescription
int

UNHEALTHY_THRESHOLD_FIELD_NUMBER

public static final int UNHEALTHY_THRESHOLD_FIELD_NUMBER
Field Value
TypeDescription
int

Methods

equals(Object obj)

public boolean equals(Object obj)
Parameter
NameDescription
objObject
Returns
TypeDescription
boolean
Overrides

getCheckInterval()

public Duration getCheckInterval()

Interval between health checks.

.google.protobuf.Duration check_interval = 6;

Returns
TypeDescription
Duration

The checkInterval.

getCheckIntervalOrBuilder()

public DurationOrBuilder getCheckIntervalOrBuilder()

Interval between health checks.

.google.protobuf.Duration check_interval = 6;

Returns
TypeDescription
DurationOrBuilder

getDefaultInstance()

public static HealthCheck getDefaultInstance()
Returns
TypeDescription
HealthCheck

getDefaultInstanceForType()

public HealthCheck getDefaultInstanceForType()
Returns
TypeDescription
HealthCheck

getDescriptor()

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

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.

getParserForType()

public Parser<HealthCheck> getParserForType()
Returns
TypeDescription
Parser<HealthCheck>
Overrides

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.

getSerializedSize()

public int getSerializedSize()
Returns
TypeDescription
int
Overrides

getTimeout()

public Duration getTimeout()

Time before the health check is considered failed.

.google.protobuf.Duration timeout = 7;

Returns
TypeDescription
Duration

The timeout.

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.

getUnknownFields()

public final UnknownFieldSet getUnknownFields()
Returns
TypeDescription
UnknownFieldSet
Overrides

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.

hashCode()

public int hashCode()
Returns
TypeDescription
int
Overrides

internalGetFieldAccessorTable()

protected GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
Returns
TypeDescription
FieldAccessorTable
Overrides

isInitialized()

public final boolean isInitialized()
Returns
TypeDescription
boolean
Overrides

newBuilder()

public static HealthCheck.Builder newBuilder()
Returns
TypeDescription
HealthCheck.Builder

newBuilder(HealthCheck prototype)

public static HealthCheck.Builder newBuilder(HealthCheck prototype)
Parameter
NameDescription
prototypeHealthCheck
Returns
TypeDescription
HealthCheck.Builder

newBuilderForType()

public HealthCheck.Builder newBuilderForType()
Returns
TypeDescription
HealthCheck.Builder

newBuilderForType(GeneratedMessageV3.BuilderParent parent)

protected HealthCheck.Builder newBuilderForType(GeneratedMessageV3.BuilderParent parent)
Parameter
NameDescription
parentBuilderParent
Returns
TypeDescription
HealthCheck.Builder
Overrides

newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)

protected Object newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)
Parameter
NameDescription
unusedUnusedPrivateParameter
Returns
TypeDescription
Object
Overrides

parseDelimitedFrom(InputStream input)

public static HealthCheck parseDelimitedFrom(InputStream input)
Parameter
NameDescription
inputInputStream
Returns
TypeDescription
HealthCheck
Exceptions
TypeDescription
IOException

parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

public static HealthCheck parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
NameDescription
inputInputStream
extensionRegistryExtensionRegistryLite
Returns
TypeDescription
HealthCheck
Exceptions
TypeDescription
IOException

parseFrom(byte[] data)

public static HealthCheck parseFrom(byte[] data)
Parameter
NameDescription
databyte[]
Returns
TypeDescription
HealthCheck
Exceptions
TypeDescription
InvalidProtocolBufferException

parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)

public static HealthCheck parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)
Parameters
NameDescription
databyte[]
extensionRegistryExtensionRegistryLite
Returns
TypeDescription
HealthCheck
Exceptions
TypeDescription
InvalidProtocolBufferException

parseFrom(ByteString data)

public static HealthCheck parseFrom(ByteString data)
Parameter
NameDescription
dataByteString
Returns
TypeDescription
HealthCheck
Exceptions
TypeDescription
InvalidProtocolBufferException

parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)

public static HealthCheck parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)
Parameters
NameDescription
dataByteString
extensionRegistryExtensionRegistryLite
Returns
TypeDescription
HealthCheck
Exceptions
TypeDescription
InvalidProtocolBufferException

parseFrom(CodedInputStream input)

public static HealthCheck parseFrom(CodedInputStream input)
Parameter
NameDescription
inputCodedInputStream
Returns
TypeDescription
HealthCheck
Exceptions
TypeDescription
IOException

parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

public static HealthCheck parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
NameDescription
inputCodedInputStream
extensionRegistryExtensionRegistryLite
Returns
TypeDescription
HealthCheck
Exceptions
TypeDescription
IOException

parseFrom(InputStream input)

public static HealthCheck parseFrom(InputStream input)
Parameter
NameDescription
inputInputStream
Returns
TypeDescription
HealthCheck
Exceptions
TypeDescription
IOException

parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

public static HealthCheck parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
NameDescription
inputInputStream
extensionRegistryExtensionRegistryLite
Returns
TypeDescription
HealthCheck
Exceptions
TypeDescription
IOException

parseFrom(ByteBuffer data)

public static HealthCheck parseFrom(ByteBuffer data)
Parameter
NameDescription
dataByteBuffer
Returns
TypeDescription
HealthCheck
Exceptions
TypeDescription
InvalidProtocolBufferException

parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)

public static HealthCheck parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)
Parameters
NameDescription
dataByteBuffer
extensionRegistryExtensionRegistryLite
Returns
TypeDescription
HealthCheck
Exceptions
TypeDescription
InvalidProtocolBufferException

parser()

public static Parser<HealthCheck> parser()
Returns
TypeDescription
Parser<HealthCheck>

toBuilder()

public HealthCheck.Builder toBuilder()
Returns
TypeDescription
HealthCheck.Builder

writeTo(CodedOutputStream output)

public void writeTo(CodedOutputStream output)
Parameter
NameDescription
outputCodedOutputStream
Overrides Exceptions
TypeDescription
IOException