Class LivenessCheck.Builder (2.34.0)

public static final class LivenessCheck.Builder extends GeneratedMessageV3.Builder<LivenessCheck.Builder> implements LivenessCheckOrBuilder

Health checking configuration for VM instances. Unhealthy instances are killed and replaced with new instances.

Protobuf type google.appengine.v1.LivenessCheck

Static Methods

getDescriptor()

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

Methods

addRepeatedField(Descriptors.FieldDescriptor field, Object value)

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

build()

public LivenessCheck build()
Returns
TypeDescription
LivenessCheck

buildPartial()

public LivenessCheck buildPartial()
Returns
TypeDescription
LivenessCheck

clear()

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

clearCheckInterval()

public LivenessCheck.Builder clearCheckInterval()

Interval between health checks.

.google.protobuf.Duration check_interval = 5;

Returns
TypeDescription
LivenessCheck.Builder

clearFailureThreshold()

public LivenessCheck.Builder clearFailureThreshold()

Number of consecutive failed checks required before considering the VM unhealthy.

uint32 failure_threshold = 3;

Returns
TypeDescription
LivenessCheck.Builder

This builder for chaining.

clearField(Descriptors.FieldDescriptor field)

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

clearHost()

public LivenessCheck.Builder clearHost()

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

string host = 2;

Returns
TypeDescription
LivenessCheck.Builder

This builder for chaining.

clearInitialDelay()

public LivenessCheck.Builder clearInitialDelay()

The initial delay before starting to execute the checks.

.google.protobuf.Duration initial_delay = 7;

Returns
TypeDescription
LivenessCheck.Builder

clearOneof(Descriptors.OneofDescriptor oneof)

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

clearPath()

public LivenessCheck.Builder clearPath()

The request path.

string path = 1;

Returns
TypeDescription
LivenessCheck.Builder

This builder for chaining.

clearSuccessThreshold()

public LivenessCheck.Builder clearSuccessThreshold()

Number of consecutive successful checks required before considering the VM healthy.

uint32 success_threshold = 4;

Returns
TypeDescription
LivenessCheck.Builder

This builder for chaining.

clearTimeout()

public LivenessCheck.Builder clearTimeout()

Time before the check is considered failed.

.google.protobuf.Duration timeout = 6;

Returns
TypeDescription
LivenessCheck.Builder

clone()

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

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 LivenessCheck getDefaultInstanceForType()
Returns
TypeDescription
LivenessCheck

getDescriptorForType()

public Descriptors.Descriptor getDescriptorForType()
Returns
TypeDescription
Descriptor
Overrides

getFailureThreshold()

public int getFailureThreshold()

Number of consecutive failed checks required before considering the VM unhealthy.

uint32 failure_threshold = 3;

Returns
TypeDescription
int

The failureThreshold.

getHost()

public String getHost()

Host header to send when performing a HTTP Liveness 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 Liveness check. Example: "myapp.appspot.com"

string host = 2;

Returns
TypeDescription
ByteString

The bytes for host.

getInitialDelay()

public Duration getInitialDelay()

The initial delay before starting to execute the checks.

.google.protobuf.Duration initial_delay = 7;

Returns
TypeDescription
Duration

The initialDelay.

getInitialDelayBuilder()

public Duration.Builder getInitialDelayBuilder()

The initial delay before starting to execute the checks.

.google.protobuf.Duration initial_delay = 7;

Returns
TypeDescription
Builder

getInitialDelayOrBuilder()

public DurationOrBuilder getInitialDelayOrBuilder()

The initial delay before starting to execute the checks.

.google.protobuf.Duration initial_delay = 7;

Returns
TypeDescription
DurationOrBuilder

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 considering the VM healthy.

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

hasCheckInterval()

public boolean hasCheckInterval()

Interval between health checks.

.google.protobuf.Duration check_interval = 5;

Returns
TypeDescription
boolean

Whether the checkInterval field is set.

hasInitialDelay()

public boolean hasInitialDelay()

The initial delay before starting to execute the checks.

.google.protobuf.Duration initial_delay = 7;

Returns
TypeDescription
boolean

Whether the initialDelay 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

mergeCheckInterval(Duration value)

public LivenessCheck.Builder mergeCheckInterval(Duration value)

Interval between health checks.

.google.protobuf.Duration check_interval = 5;

Parameter
NameDescription
valueDuration
Returns
TypeDescription
LivenessCheck.Builder

mergeFrom(LivenessCheck other)

public LivenessCheck.Builder mergeFrom(LivenessCheck other)
Parameter
NameDescription
otherLivenessCheck
Returns
TypeDescription
LivenessCheck.Builder

mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

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

mergeFrom(Message other)

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

mergeInitialDelay(Duration value)

public LivenessCheck.Builder mergeInitialDelay(Duration value)

The initial delay before starting to execute the checks.

.google.protobuf.Duration initial_delay = 7;

Parameter
NameDescription
valueDuration
Returns
TypeDescription
LivenessCheck.Builder

mergeTimeout(Duration value)

public LivenessCheck.Builder mergeTimeout(Duration value)

Time before the check is considered failed.

.google.protobuf.Duration timeout = 6;

Parameter
NameDescription
valueDuration
Returns
TypeDescription
LivenessCheck.Builder

mergeUnknownFields(UnknownFieldSet unknownFields)

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

setCheckInterval(Duration value)

public LivenessCheck.Builder setCheckInterval(Duration value)

Interval between health checks.

.google.protobuf.Duration check_interval = 5;

Parameter
NameDescription
valueDuration
Returns
TypeDescription
LivenessCheck.Builder

setCheckInterval(Duration.Builder builderForValue)

public LivenessCheck.Builder setCheckInterval(Duration.Builder builderForValue)

Interval between health checks.

.google.protobuf.Duration check_interval = 5;

Parameter
NameDescription
builderForValueBuilder
Returns
TypeDescription
LivenessCheck.Builder

setFailureThreshold(int value)

public LivenessCheck.Builder setFailureThreshold(int value)

Number of consecutive failed checks required before considering the VM unhealthy.

uint32 failure_threshold = 3;

Parameter
NameDescription
valueint

The failureThreshold to set.

Returns
TypeDescription
LivenessCheck.Builder

This builder for chaining.

setField(Descriptors.FieldDescriptor field, Object value)

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

setHost(String value)

public LivenessCheck.Builder setHost(String value)

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

string host = 2;

Parameter
NameDescription
valueString

The host to set.

Returns
TypeDescription
LivenessCheck.Builder

This builder for chaining.

setHostBytes(ByteString value)

public LivenessCheck.Builder setHostBytes(ByteString value)

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

string host = 2;

Parameter
NameDescription
valueByteString

The bytes for host to set.

Returns
TypeDescription
LivenessCheck.Builder

This builder for chaining.

setInitialDelay(Duration value)

public LivenessCheck.Builder setInitialDelay(Duration value)

The initial delay before starting to execute the checks.

.google.protobuf.Duration initial_delay = 7;

Parameter
NameDescription
valueDuration
Returns
TypeDescription
LivenessCheck.Builder

setInitialDelay(Duration.Builder builderForValue)

public LivenessCheck.Builder setInitialDelay(Duration.Builder builderForValue)

The initial delay before starting to execute the checks.

.google.protobuf.Duration initial_delay = 7;

Parameter
NameDescription
builderForValueBuilder
Returns
TypeDescription
LivenessCheck.Builder

setPath(String value)

public LivenessCheck.Builder setPath(String value)

The request path.

string path = 1;

Parameter
NameDescription
valueString

The path to set.

Returns
TypeDescription
LivenessCheck.Builder

This builder for chaining.

setPathBytes(ByteString value)

public LivenessCheck.Builder setPathBytes(ByteString value)

The request path.

string path = 1;

Parameter
NameDescription
valueByteString

The bytes for path to set.

Returns
TypeDescription
LivenessCheck.Builder

This builder for chaining.

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

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

setSuccessThreshold(int value)

public LivenessCheck.Builder setSuccessThreshold(int value)

Number of consecutive successful checks required before considering the VM healthy.

uint32 success_threshold = 4;

Parameter
NameDescription
valueint

The successThreshold to set.

Returns
TypeDescription
LivenessCheck.Builder

This builder for chaining.

setTimeout(Duration value)

public LivenessCheck.Builder setTimeout(Duration value)

Time before the check is considered failed.

.google.protobuf.Duration timeout = 6;

Parameter
NameDescription
valueDuration
Returns
TypeDescription
LivenessCheck.Builder

setTimeout(Duration.Builder builderForValue)

public LivenessCheck.Builder setTimeout(Duration.Builder builderForValue)

Time before the check is considered failed.

.google.protobuf.Duration timeout = 6;

Parameter
NameDescription
builderForValueBuilder
Returns
TypeDescription
LivenessCheck.Builder

setUnknownFields(UnknownFieldSet unknownFields)

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