HealthCheck.Builder (java API)

java.lang.Object
- com.google.protobuf.AbstractMessageLite.Builder
- - com.google.protobuf.AbstractMessage.Builder<BuilderType>
  - - com.google.protobuf.GeneratedMessageV3.Builder<HealthCheck.Builder>
    - - com.google.appengine.v1.HealthCheck.Builder

All Implemented Interfaces:: HealthCheckOrBuilder, Message.Builder, MessageLite.Builder, MessageLiteOrBuilder, MessageOrBuilder, java.lang.Cloneable

Enclosing class:: HealthCheck

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

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`HealthCheck.Builder`	`addRepeatedField(Descriptors.FieldDescriptor field, java.lang.Object value)`
`HealthCheck`	`build()`
`HealthCheck`	`buildPartial()`
`HealthCheck.Builder`	`clear()`
`HealthCheck.Builder`	`clearCheckInterval()` Interval between health checks.
`HealthCheck.Builder`	`clearDisableHealthCheck()` Whether to explicitly disable health checks for this instance.
`HealthCheck.Builder`	`clearField(Descriptors.FieldDescriptor field)`
`HealthCheck.Builder`	`clearHealthyThreshold()` Number of consecutive successful health checks required before receiving traffic.
`HealthCheck.Builder`	`clearHost()` Host header to send when performing an HTTP health check.
`HealthCheck.Builder`	`clearOneof(Descriptors.OneofDescriptor oneof)`
`HealthCheck.Builder`	`clearRestartThreshold()` Number of consecutive failed health checks required before an instance is restarted.
`HealthCheck.Builder`	`clearTimeout()` Time before the health check is considered failed.
`HealthCheck.Builder`	`clearUnhealthyThreshold()` Number of consecutive failed health checks required before removing traffic.
`HealthCheck.Builder`	`clone()`
`Duration`	`getCheckInterval()` Interval between health checks.
`Duration.Builder`	`getCheckIntervalBuilder()` Interval between health checks.
`DurationOrBuilder`	`getCheckIntervalOrBuilder()` Interval between health checks.
`HealthCheck`	`getDefaultInstanceForType()`
`static Descriptors.Descriptor`	`getDescriptor()`
`Descriptors.Descriptor`	`getDescriptorForType()`
`boolean`	`getDisableHealthCheck()` Whether to explicitly disable health checks for this instance.
`int`	`getHealthyThreshold()` Number of consecutive successful health checks required before receiving traffic.
`java.lang.String`	`getHost()` Host header to send when performing an HTTP health check.
`ByteString`	`getHostBytes()` Host header to send when performing an HTTP health check.
`int`	`getRestartThreshold()` Number of consecutive failed health checks required before an instance is restarted.
`Duration`	`getTimeout()` Time before the health check is considered failed.
`Duration.Builder`	`getTimeoutBuilder()` Time before the health check is considered failed.
`DurationOrBuilder`	`getTimeoutOrBuilder()` Time before the health check is considered failed.
`int`	`getUnhealthyThreshold()` Number of consecutive failed health checks required before removing traffic.
`boolean`	`hasCheckInterval()` Interval between health checks.
`boolean`	`hasTimeout()` Time before the health check is considered failed.
`protected GeneratedMessageV3.FieldAccessorTable`	`internalGetFieldAccessorTable()`
`boolean`	`isInitialized()`
`HealthCheck.Builder`	`mergeCheckInterval(Duration value)` Interval between health checks.
`HealthCheck.Builder`	`mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)`
`HealthCheck.Builder`	`mergeFrom(HealthCheck other)`
`HealthCheck.Builder`	`mergeFrom(Message other)`
`HealthCheck.Builder`	`mergeTimeout(Duration value)` Time before the health check is considered failed.
`HealthCheck.Builder`	`mergeUnknownFields(UnknownFieldSet unknownFields)`
`HealthCheck.Builder`	`setCheckInterval(Duration.Builder builderForValue)` Interval between health checks.
`HealthCheck.Builder`	`setCheckInterval(Duration value)` Interval between health checks.
`HealthCheck.Builder`	`setDisableHealthCheck(boolean value)` Whether to explicitly disable health checks for this instance.
`HealthCheck.Builder`	`setField(Descriptors.FieldDescriptor field, java.lang.Object value)`
`HealthCheck.Builder`	`setHealthyThreshold(int value)` Number of consecutive successful health checks required before receiving traffic.
`HealthCheck.Builder`	`setHost(java.lang.String value)` Host header to send when performing an HTTP health check.
`HealthCheck.Builder`	`setHostBytes(ByteString value)` Host header to send when performing an HTTP health check.
`HealthCheck.Builder`	`setRepeatedField(Descriptors.FieldDescriptor field, int index, java.lang.Object value)`
`HealthCheck.Builder`	`setRestartThreshold(int value)` Number of consecutive failed health checks required before an instance is restarted.
`HealthCheck.Builder`	`setTimeout(Duration.Builder builderForValue)` Time before the health check is considered failed.
`HealthCheck.Builder`	`setTimeout(Duration value)` Time before the health check is considered failed.
`HealthCheck.Builder`	`setUnhealthyThreshold(int value)` Number of consecutive failed health checks required before removing traffic.
`HealthCheck.Builder`	`setUnknownFields(UnknownFieldSet unknownFields)`

Methods inherited from class com.google.protobuf.GeneratedMessageV3.Builder
getAllFields, getField, getFieldBuilder, getOneofFieldDescriptor, getParentForChildren, getRepeatedField, getRepeatedFieldBuilder, getRepeatedFieldCount, getUnknownFields, hasField, hasOneof, internalGetMapField, internalGetMutableMapField, isClean, markClean, newBuilderForField, onBuilt, onChanged, setUnknownFieldsProto3

Methods inherited from class com.google.protobuf.AbstractMessage.Builder
findInitializationErrors, getInitializationErrorString, internalMergeFrom, mergeDelimitedFrom, mergeDelimitedFrom, mergeFrom, mergeFrom, mergeFrom, mergeFrom, mergeFrom, mergeFrom, mergeFrom, mergeFrom, mergeFrom, newUninitializedMessageException, toString

Methods inherited from class com.google.protobuf.AbstractMessageLite.Builder
addAll, addAll, mergeFrom, newUninitializedMessageException

Methods inherited from class java.lang.Object
equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Methods inherited from interface com.google.protobuf.MessageOrBuilder
findInitializationErrors, getAllFields, getField, getInitializationErrorString, getOneofFieldDescriptor, getRepeatedField, getRepeatedFieldCount, getUnknownFields, hasField, hasOneof

Methods inherited from interface com.google.protobuf.MessageLite.Builder
mergeFrom

Method Detail

getDescriptor

public static final Descriptors.Descriptor getDescriptor()

internalGetFieldAccessorTable
```
protected GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
```
Specified by:

internalGetFieldAccessorTable in class GeneratedMessageV3.Builder<HealthCheck.Builder>

clear
```
public HealthCheck.Builder clear()
```
Specified by:

clear in interface Message.Builder

Specified by:

clear in interface MessageLite.Builder

Overrides:

clear in class GeneratedMessageV3.Builder<HealthCheck.Builder>

getDescriptorForType
```
public Descriptors.Descriptor getDescriptorForType()
```
Specified by:

getDescriptorForType in interface Message.Builder

Specified by:

getDescriptorForType in interface MessageOrBuilder

Overrides:

getDescriptorForType in class GeneratedMessageV3.Builder<HealthCheck.Builder>

getDefaultInstanceForType
```
public HealthCheck getDefaultInstanceForType()
```
Specified by:

getDefaultInstanceForType in interface MessageLiteOrBuilder

Specified by:

getDefaultInstanceForType in interface MessageOrBuilder

build
```
public HealthCheck build()
```
Specified by:

build in interface Message.Builder

Specified by:

build in interface MessageLite.Builder

buildPartial
```
public HealthCheck buildPartial()
```
Specified by:

buildPartial in interface Message.Builder

Specified by:

buildPartial in interface MessageLite.Builder

clone
```
public HealthCheck.Builder clone()
```
Specified by:

clone in interface Message.Builder

Specified by:

clone in interface MessageLite.Builder

Overrides:

clone in class GeneratedMessageV3.Builder<HealthCheck.Builder>

setField

public HealthCheck.Builder setField(Descriptors.FieldDescriptor field,
                                    java.lang.Object value)

Specified by:: setField in interface Message.Builder
Overrides:: setField in class GeneratedMessageV3.Builder<HealthCheck.Builder>

clearField
```
public HealthCheck.Builder clearField(Descriptors.FieldDescriptor field)
```
Specified by:

clearField in interface Message.Builder

Overrides:

clearField in class GeneratedMessageV3.Builder<HealthCheck.Builder>

clearOneof
```
public HealthCheck.Builder clearOneof(Descriptors.OneofDescriptor oneof)
```
Specified by:

clearOneof in interface Message.Builder

Overrides:

clearOneof in class GeneratedMessageV3.Builder<HealthCheck.Builder>

setRepeatedField

public HealthCheck.Builder setRepeatedField(Descriptors.FieldDescriptor field,
                                            int index,
                                            java.lang.Object value)

Specified by:: setRepeatedField in interface Message.Builder
Overrides:: setRepeatedField in class GeneratedMessageV3.Builder<HealthCheck.Builder>

addRepeatedField

public HealthCheck.Builder addRepeatedField(Descriptors.FieldDescriptor field,
                                            java.lang.Object value)

Specified by:: addRepeatedField in interface Message.Builder
Overrides:: addRepeatedField in class GeneratedMessageV3.Builder<HealthCheck.Builder>

mergeFrom
```
public HealthCheck.Builder mergeFrom(Message other)
```
Specified by:

mergeFrom in interface Message.Builder

Overrides:

mergeFrom in class AbstractMessage.Builder<HealthCheck.Builder>

mergeFrom

public HealthCheck.Builder mergeFrom(HealthCheck other)

isInitialized
```
public final boolean isInitialized()
```
Specified by:

isInitialized in interface MessageLiteOrBuilder

Overrides:

isInitialized in class GeneratedMessageV3.Builder<HealthCheck.Builder>

mergeFrom

public HealthCheck.Builder mergeFrom(CodedInputStream input,
                                     ExtensionRegistryLite extensionRegistry)
                              throws java.io.IOException

Specified by:: mergeFrom in interface Message.Builder
Specified by:: mergeFrom in interface MessageLite.Builder
Overrides:: mergeFrom in class AbstractMessage.Builder<HealthCheck.Builder>
Throws:: java.io.IOException

getDisableHealthCheck
```
public boolean getDisableHealthCheck()
```
```
 Whether to explicitly disable health checks for this instance.
 
```
bool disable_health_check = 1;
Specified by:

getDisableHealthCheck in interface HealthCheckOrBuilder

setDisableHealthCheck

public HealthCheck.Builder setDisableHealthCheck(boolean value)

 Whether to explicitly disable health checks for this instance.

bool disable_health_check = 1;

clearDisableHealthCheck

public HealthCheck.Builder clearDisableHealthCheck()

 Whether to explicitly disable health checks for this instance.

bool disable_health_check = 1;

getHost

public java.lang.String getHost()

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

string host = 2;

Specified by:: getHost in interface HealthCheckOrBuilder

getHostBytes

public ByteString getHostBytes()

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

string host = 2;

Specified by:: getHostBytes in interface HealthCheckOrBuilder

setHost

public HealthCheck.Builder setHost(java.lang.String value)

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

string host = 2;

clearHost

public HealthCheck.Builder clearHost()

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

string host = 2;

setHostBytes

public HealthCheck.Builder setHostBytes(ByteString value)

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

string host = 2;

getHealthyThreshold

public int getHealthyThreshold()

 Number of consecutive successful health checks required before receiving
 traffic.

uint32 healthy_threshold = 3;

Specified by:: getHealthyThreshold in interface HealthCheckOrBuilder

setHealthyThreshold

public HealthCheck.Builder setHealthyThreshold(int value)

 Number of consecutive successful health checks required before receiving
 traffic.

uint32 healthy_threshold = 3;

clearHealthyThreshold

public HealthCheck.Builder clearHealthyThreshold()

 Number of consecutive successful health checks required before receiving
 traffic.

uint32 healthy_threshold = 3;

getUnhealthyThreshold

public int getUnhealthyThreshold()

 Number of consecutive failed health checks required before removing
 traffic.

uint32 unhealthy_threshold = 4;

Specified by:: getUnhealthyThreshold in interface HealthCheckOrBuilder

setUnhealthyThreshold

public HealthCheck.Builder setUnhealthyThreshold(int value)

 Number of consecutive failed health checks required before removing
 traffic.

uint32 unhealthy_threshold = 4;

clearUnhealthyThreshold

public HealthCheck.Builder clearUnhealthyThreshold()

 Number of consecutive failed health checks required before removing
 traffic.

uint32 unhealthy_threshold = 4;

getRestartThreshold

public int getRestartThreshold()

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

uint32 restart_threshold = 5;

Specified by:: getRestartThreshold in interface HealthCheckOrBuilder

setRestartThreshold

public HealthCheck.Builder setRestartThreshold(int value)

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

uint32 restart_threshold = 5;

clearRestartThreshold

public HealthCheck.Builder clearRestartThreshold()

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

uint32 restart_threshold = 5;

hasCheckInterval
```
public boolean hasCheckInterval()
```
```
 Interval between health checks.
 
```
.google.protobuf.Duration check_interval = 6;
Specified by:

hasCheckInterval in interface HealthCheckOrBuilder

getCheckInterval
```
public Duration getCheckInterval()
```
```
 Interval between health checks.
 
```
.google.protobuf.Duration check_interval = 6;
Specified by:

getCheckInterval in interface HealthCheckOrBuilder

setCheckInterval

public HealthCheck.Builder setCheckInterval(Duration value)

 Interval between health checks.

.google.protobuf.Duration check_interval = 6;

setCheckInterval

public HealthCheck.Builder setCheckInterval(Duration.Builder builderForValue)

 Interval between health checks.

.google.protobuf.Duration check_interval = 6;

mergeCheckInterval

public HealthCheck.Builder mergeCheckInterval(Duration value)

 Interval between health checks.

.google.protobuf.Duration check_interval = 6;

clearCheckInterval

public HealthCheck.Builder clearCheckInterval()

 Interval between health checks.

.google.protobuf.Duration check_interval = 6;

getCheckIntervalBuilder

public Duration.Builder getCheckIntervalBuilder()

 Interval between health checks.

.google.protobuf.Duration check_interval = 6;

getCheckIntervalOrBuilder
```
public DurationOrBuilder getCheckIntervalOrBuilder()
```
```
 Interval between health checks.
 
```
.google.protobuf.Duration check_interval = 6;
Specified by:

getCheckIntervalOrBuilder in interface HealthCheckOrBuilder

hasTimeout
```
public boolean hasTimeout()
```
```
 Time before the health check is considered failed.
 
```
.google.protobuf.Duration timeout = 7;
Specified by:

hasTimeout in interface HealthCheckOrBuilder

getTimeout
```
public Duration getTimeout()
```
```
 Time before the health check is considered failed.
 
```
.google.protobuf.Duration timeout = 7;
Specified by:

getTimeout in interface HealthCheckOrBuilder