- 1.63.0 (latest)
- 1.62.0
- 1.61.0
- 1.59.0
- 1.58.0
- 1.57.0
- 1.56.0
- 1.55.0
- 1.54.0
- 1.53.0
- 1.52.0
- 1.51.0
- 1.50.0
- 1.49.0
- 1.47.0
- 1.46.0
- 1.45.0
- 1.44.0
- 1.43.0
- 1.42.0
- 1.41.0
- 1.40.0
- 1.39.0
- 1.38.0
- 1.37.0
- 1.34.0
- 1.33.0
- 1.32.0
- 1.31.0
- 1.30.0
- 1.29.0
- 1.28.0
- 1.27.0
- 1.26.0
- 1.25.0
- 1.24.0
- 1.23.0
- 1.22.0
- 1.21.0
- 1.20.0
- 1.19.0
- 1.18.0
- 1.17.0
- 1.16.0
- 1.15.0
- 1.14.0
- 1.13.0
- 1.12.1
- 1.11.0
- 1.9.1
- 1.8.1
- 1.7.2
- 1.6.0-beta
public static final class HealthCheck.Builder extends GeneratedMessageV3.Builder<HealthCheck.Builder> implements HealthCheckOrBuilder
Represents a health check resource. Google Compute Engine has two health check resources: * Regional * Global These health check resources can be used for load balancing and for autohealing VMs in a managed instance group (MIG). Load balancing Health check requirements vary depending on the type of load balancer. For details about the type of health check supported for each load balancer and corresponding backend type, see Health checks overview: Load balancer guide. Autohealing in MIGs The health checks that you use for autohealing VMs in a MIG can be either regional or global. For more information, see Set up an application health check and autohealing. For more information, see Health checks overview.
Protobuf type google.cloud.compute.v1.HealthCheck
Inheritance
Object > AbstractMessageLite.Builder<MessageType,BuilderType> > AbstractMessage.Builder<BuilderType> > GeneratedMessageV3.Builder > HealthCheck.BuilderImplements
HealthCheckOrBuilderStatic Methods
getDescriptor()
public static final Descriptors.Descriptor getDescriptor()
Returns | |
---|---|
Type | Description |
Descriptor |
Methods
addRepeatedField(Descriptors.FieldDescriptor field, Object value)
public HealthCheck.Builder addRepeatedField(Descriptors.FieldDescriptor field, Object value)
Parameters | |
---|---|
Name | Description |
field |
FieldDescriptor |
value |
Object |
Returns | |
---|---|
Type | Description |
HealthCheck.Builder |
build()
public HealthCheck build()
Returns | |
---|---|
Type | Description |
HealthCheck |
buildPartial()
public HealthCheck buildPartial()
Returns | |
---|---|
Type | Description |
HealthCheck |
clear()
public HealthCheck.Builder clear()
Returns | |
---|---|
Type | Description |
HealthCheck.Builder |
clearCheckIntervalSec()
public HealthCheck.Builder clearCheckIntervalSec()
How often (in seconds) to send a health check. The default value is 5 seconds.
optional int32 check_interval_sec = 345561006;
Returns | |
---|---|
Type | Description |
HealthCheck.Builder |
This builder for chaining. |
clearCreationTimestamp()
public HealthCheck.Builder clearCreationTimestamp()
[Output Only] Creation timestamp in 3339 text format.
optional string creation_timestamp = 30525366;
Returns | |
---|---|
Type | Description |
HealthCheck.Builder |
This builder for chaining. |
clearDescription()
public HealthCheck.Builder clearDescription()
An optional description of this resource. Provide this property when you create the resource.
optional string description = 422937596;
Returns | |
---|---|
Type | Description |
HealthCheck.Builder |
This builder for chaining. |
clearField(Descriptors.FieldDescriptor field)
public HealthCheck.Builder clearField(Descriptors.FieldDescriptor field)
Parameter | |
---|---|
Name | Description |
field |
FieldDescriptor |
Returns | |
---|---|
Type | Description |
HealthCheck.Builder |
clearGrpcHealthCheck()
public HealthCheck.Builder clearGrpcHealthCheck()
optional .google.cloud.compute.v1.GRPCHealthCheck grpc_health_check = 85529574;
Returns | |
---|---|
Type | Description |
HealthCheck.Builder |
clearHealthyThreshold()
public HealthCheck.Builder clearHealthyThreshold()
A so-far unhealthy instance will be marked healthy after this many consecutive successes. The default value is 2.
optional int32 healthy_threshold = 403212361;
Returns | |
---|---|
Type | Description |
HealthCheck.Builder |
This builder for chaining. |
clearHttp2HealthCheck()
public HealthCheck.Builder clearHttp2HealthCheck()
optional .google.cloud.compute.v1.HTTP2HealthCheck http2_health_check = 11360986;
Returns | |
---|---|
Type | Description |
HealthCheck.Builder |
clearHttpHealthCheck()
public HealthCheck.Builder clearHttpHealthCheck()
optional .google.cloud.compute.v1.HTTPHealthCheck http_health_check = 412586940;
Returns | |
---|---|
Type | Description |
HealthCheck.Builder |
clearHttpsHealthCheck()
public HealthCheck.Builder clearHttpsHealthCheck()
optional .google.cloud.compute.v1.HTTPSHealthCheck https_health_check = 436046905;
Returns | |
---|---|
Type | Description |
HealthCheck.Builder |
clearId()
public HealthCheck.Builder clearId()
[Output Only] The unique identifier for the resource. This identifier is defined by the server.
optional uint64 id = 3355;
Returns | |
---|---|
Type | Description |
HealthCheck.Builder |
This builder for chaining. |
clearKind()
public HealthCheck.Builder clearKind()
Type of the resource.
optional string kind = 3292052;
Returns | |
---|---|
Type | Description |
HealthCheck.Builder |
This builder for chaining. |
clearLogConfig()
public HealthCheck.Builder clearLogConfig()
Configure logging on this health check.
optional .google.cloud.compute.v1.HealthCheckLogConfig log_config = 351299741;
Returns | |
---|---|
Type | Description |
HealthCheck.Builder |
clearName()
public HealthCheck.Builder clearName()
Name of the resource. Provided by the client when the resource is created. The name must be 1-63 characters long, and comply with RFC1035. For example, a name that is 1-63 characters long, matches the regular expression a-z?
, and otherwise complies with RFC1035. This regular expression describes a name where the first character is a lowercase letter, and all following characters are a dash, lowercase letter, or digit, except the last character, which isn't a dash.
optional string name = 3373707;
Returns | |
---|---|
Type | Description |
HealthCheck.Builder |
This builder for chaining. |
clearOneof(Descriptors.OneofDescriptor oneof)
public HealthCheck.Builder clearOneof(Descriptors.OneofDescriptor oneof)
Parameter | |
---|---|
Name | Description |
oneof |
OneofDescriptor |
Returns | |
---|---|
Type | Description |
HealthCheck.Builder |
clearRegion()
public HealthCheck.Builder clearRegion()
[Output Only] Region where the health check resides. Not applicable to global health checks.
optional string region = 138946292;
Returns | |
---|---|
Type | Description |
HealthCheck.Builder |
This builder for chaining. |
clearSelfLink()
public HealthCheck.Builder clearSelfLink()
[Output Only] Server-defined URL for the resource.
optional string self_link = 456214797;
Returns | |
---|---|
Type | Description |
HealthCheck.Builder |
This builder for chaining. |
clearSslHealthCheck()
public HealthCheck.Builder clearSslHealthCheck()
optional .google.cloud.compute.v1.SSLHealthCheck ssl_health_check = 280032440;
Returns | |
---|---|
Type | Description |
HealthCheck.Builder |
clearTcpHealthCheck()
public HealthCheck.Builder clearTcpHealthCheck()
optional .google.cloud.compute.v1.TCPHealthCheck tcp_health_check = 469980419;
Returns | |
---|---|
Type | Description |
HealthCheck.Builder |
clearTimeoutSec()
public HealthCheck.Builder clearTimeoutSec()
How long (in seconds) to wait before claiming failure. The default value is 5 seconds. It is invalid for timeoutSec to have greater value than checkIntervalSec.
optional int32 timeout_sec = 79994995;
Returns | |
---|---|
Type | Description |
HealthCheck.Builder |
This builder for chaining. |
clearType()
public HealthCheck.Builder clearType()
Specifies the type of the healthCheck, either TCP, SSL, HTTP, HTTPS, HTTP2 or GRPC. Exactly one of the protocol-specific health check fields must be specified, which must match type field. Check the Type enum for the list of possible values.
optional string type = 3575610;
Returns | |
---|---|
Type | Description |
HealthCheck.Builder |
This builder for chaining. |
clearUnhealthyThreshold()
public HealthCheck.Builder clearUnhealthyThreshold()
A so-far healthy instance will be marked unhealthy after this many consecutive failures. The default value is 2.
optional int32 unhealthy_threshold = 227958480;
Returns | |
---|---|
Type | Description |
HealthCheck.Builder |
This builder for chaining. |
clone()
public HealthCheck.Builder clone()
Returns | |
---|---|
Type | Description |
HealthCheck.Builder |
getCheckIntervalSec()
public int getCheckIntervalSec()
How often (in seconds) to send a health check. The default value is 5 seconds.
optional int32 check_interval_sec = 345561006;
Returns | |
---|---|
Type | Description |
int |
The checkIntervalSec. |
getCreationTimestamp()
public String getCreationTimestamp()
[Output Only] Creation timestamp in 3339 text format.
optional string creation_timestamp = 30525366;
Returns | |
---|---|
Type | Description |
String |
The creationTimestamp. |
getCreationTimestampBytes()
public ByteString getCreationTimestampBytes()
[Output Only] Creation timestamp in 3339 text format.
optional string creation_timestamp = 30525366;
Returns | |
---|---|
Type | Description |
ByteString |
The bytes for creationTimestamp. |
getDefaultInstanceForType()
public HealthCheck getDefaultInstanceForType()
Returns | |
---|---|
Type | Description |
HealthCheck |
getDescription()
public String getDescription()
An optional description of this resource. Provide this property when you create the resource.
optional string description = 422937596;
Returns | |
---|---|
Type | Description |
String |
The description. |
getDescriptionBytes()
public ByteString getDescriptionBytes()
An optional description of this resource. Provide this property when you create the resource.
optional string description = 422937596;
Returns | |
---|---|
Type | Description |
ByteString |
The bytes for description. |
getDescriptorForType()
public Descriptors.Descriptor getDescriptorForType()
Returns | |
---|---|
Type | Description |
Descriptor |
getGrpcHealthCheck()
public GRPCHealthCheck getGrpcHealthCheck()
optional .google.cloud.compute.v1.GRPCHealthCheck grpc_health_check = 85529574;
Returns | |
---|---|
Type | Description |
GRPCHealthCheck |
The grpcHealthCheck. |
getGrpcHealthCheckBuilder()
public GRPCHealthCheck.Builder getGrpcHealthCheckBuilder()
optional .google.cloud.compute.v1.GRPCHealthCheck grpc_health_check = 85529574;
Returns | |
---|---|
Type | Description |
GRPCHealthCheck.Builder |
getGrpcHealthCheckOrBuilder()
public GRPCHealthCheckOrBuilder getGrpcHealthCheckOrBuilder()
optional .google.cloud.compute.v1.GRPCHealthCheck grpc_health_check = 85529574;
Returns | |
---|---|
Type | Description |
GRPCHealthCheckOrBuilder |
getHealthyThreshold()
public int getHealthyThreshold()
A so-far unhealthy instance will be marked healthy after this many consecutive successes. The default value is 2.
optional int32 healthy_threshold = 403212361;
Returns | |
---|---|
Type | Description |
int |
The healthyThreshold. |
getHttp2HealthCheck()
public HTTP2HealthCheck getHttp2HealthCheck()
optional .google.cloud.compute.v1.HTTP2HealthCheck http2_health_check = 11360986;
Returns | |
---|---|
Type | Description |
HTTP2HealthCheck |
The http2HealthCheck. |
getHttp2HealthCheckBuilder()
public HTTP2HealthCheck.Builder getHttp2HealthCheckBuilder()
optional .google.cloud.compute.v1.HTTP2HealthCheck http2_health_check = 11360986;
Returns | |
---|---|
Type | Description |
HTTP2HealthCheck.Builder |
getHttp2HealthCheckOrBuilder()
public HTTP2HealthCheckOrBuilder getHttp2HealthCheckOrBuilder()
optional .google.cloud.compute.v1.HTTP2HealthCheck http2_health_check = 11360986;
Returns | |
---|---|
Type | Description |
HTTP2HealthCheckOrBuilder |
getHttpHealthCheck()
public HTTPHealthCheck getHttpHealthCheck()
optional .google.cloud.compute.v1.HTTPHealthCheck http_health_check = 412586940;
Returns | |
---|---|
Type | Description |
HTTPHealthCheck |
The httpHealthCheck. |
getHttpHealthCheckBuilder()
public HTTPHealthCheck.Builder getHttpHealthCheckBuilder()
optional .google.cloud.compute.v1.HTTPHealthCheck http_health_check = 412586940;
Returns | |
---|---|
Type | Description |
HTTPHealthCheck.Builder |
getHttpHealthCheckOrBuilder()
public HTTPHealthCheckOrBuilder getHttpHealthCheckOrBuilder()
optional .google.cloud.compute.v1.HTTPHealthCheck http_health_check = 412586940;
Returns | |
---|---|
Type | Description |
HTTPHealthCheckOrBuilder |
getHttpsHealthCheck()
public HTTPSHealthCheck getHttpsHealthCheck()
optional .google.cloud.compute.v1.HTTPSHealthCheck https_health_check = 436046905;
Returns | |
---|---|
Type | Description |
HTTPSHealthCheck |
The httpsHealthCheck. |
getHttpsHealthCheckBuilder()
public HTTPSHealthCheck.Builder getHttpsHealthCheckBuilder()
optional .google.cloud.compute.v1.HTTPSHealthCheck https_health_check = 436046905;
Returns | |
---|---|
Type | Description |
HTTPSHealthCheck.Builder |
getHttpsHealthCheckOrBuilder()
public HTTPSHealthCheckOrBuilder getHttpsHealthCheckOrBuilder()
optional .google.cloud.compute.v1.HTTPSHealthCheck https_health_check = 436046905;
Returns | |
---|---|
Type | Description |
HTTPSHealthCheckOrBuilder |
getId()
public long getId()
[Output Only] The unique identifier for the resource. This identifier is defined by the server.
optional uint64 id = 3355;
Returns | |
---|---|
Type | Description |
long |
The id. |
getKind()
public String getKind()
Type of the resource.
optional string kind = 3292052;
Returns | |
---|---|
Type | Description |
String |
The kind. |
getKindBytes()
public ByteString getKindBytes()
Type of the resource.
optional string kind = 3292052;
Returns | |
---|---|
Type | Description |
ByteString |
The bytes for kind. |
getLogConfig()
public HealthCheckLogConfig getLogConfig()
Configure logging on this health check.
optional .google.cloud.compute.v1.HealthCheckLogConfig log_config = 351299741;
Returns | |
---|---|
Type | Description |
HealthCheckLogConfig |
The logConfig. |
getLogConfigBuilder()
public HealthCheckLogConfig.Builder getLogConfigBuilder()
Configure logging on this health check.
optional .google.cloud.compute.v1.HealthCheckLogConfig log_config = 351299741;
Returns | |
---|---|
Type | Description |
HealthCheckLogConfig.Builder |
getLogConfigOrBuilder()
public HealthCheckLogConfigOrBuilder getLogConfigOrBuilder()
Configure logging on this health check.
optional .google.cloud.compute.v1.HealthCheckLogConfig log_config = 351299741;
Returns | |
---|---|
Type | Description |
HealthCheckLogConfigOrBuilder |
getName()
public String getName()
Name of the resource. Provided by the client when the resource is created. The name must be 1-63 characters long, and comply with RFC1035. For example, a name that is 1-63 characters long, matches the regular expression a-z?
, and otherwise complies with RFC1035. This regular expression describes a name where the first character is a lowercase letter, and all following characters are a dash, lowercase letter, or digit, except the last character, which isn't a dash.
optional string name = 3373707;
Returns | |
---|---|
Type | Description |
String |
The name. |
getNameBytes()
public ByteString getNameBytes()
Name of the resource. Provided by the client when the resource is created. The name must be 1-63 characters long, and comply with RFC1035. For example, a name that is 1-63 characters long, matches the regular expression a-z?
, and otherwise complies with RFC1035. This regular expression describes a name where the first character is a lowercase letter, and all following characters are a dash, lowercase letter, or digit, except the last character, which isn't a dash.
optional string name = 3373707;
Returns | |
---|---|
Type | Description |
ByteString |
The bytes for name. |
getRegion()
public String getRegion()
[Output Only] Region where the health check resides. Not applicable to global health checks.
optional string region = 138946292;
Returns | |
---|---|
Type | Description |
String |
The region. |
getRegionBytes()
public ByteString getRegionBytes()
[Output Only] Region where the health check resides. Not applicable to global health checks.
optional string region = 138946292;
Returns | |
---|---|
Type | Description |
ByteString |
The bytes for region. |
getSelfLink()
public String getSelfLink()
[Output Only] Server-defined URL for the resource.
optional string self_link = 456214797;
Returns | |
---|---|
Type | Description |
String |
The selfLink. |
getSelfLinkBytes()
public ByteString getSelfLinkBytes()
[Output Only] Server-defined URL for the resource.
optional string self_link = 456214797;
Returns | |
---|---|
Type | Description |
ByteString |
The bytes for selfLink. |
getSslHealthCheck()
public SSLHealthCheck getSslHealthCheck()
optional .google.cloud.compute.v1.SSLHealthCheck ssl_health_check = 280032440;
Returns | |
---|---|
Type | Description |
SSLHealthCheck |
The sslHealthCheck. |
getSslHealthCheckBuilder()
public SSLHealthCheck.Builder getSslHealthCheckBuilder()
optional .google.cloud.compute.v1.SSLHealthCheck ssl_health_check = 280032440;
Returns | |
---|---|
Type | Description |
SSLHealthCheck.Builder |
getSslHealthCheckOrBuilder()
public SSLHealthCheckOrBuilder getSslHealthCheckOrBuilder()
optional .google.cloud.compute.v1.SSLHealthCheck ssl_health_check = 280032440;
Returns | |
---|---|
Type | Description |
SSLHealthCheckOrBuilder |
getTcpHealthCheck()
public TCPHealthCheck getTcpHealthCheck()
optional .google.cloud.compute.v1.TCPHealthCheck tcp_health_check = 469980419;
Returns | |
---|---|
Type | Description |
TCPHealthCheck |
The tcpHealthCheck. |
getTcpHealthCheckBuilder()
public TCPHealthCheck.Builder getTcpHealthCheckBuilder()
optional .google.cloud.compute.v1.TCPHealthCheck tcp_health_check = 469980419;
Returns | |
---|---|
Type | Description |
TCPHealthCheck.Builder |
getTcpHealthCheckOrBuilder()
public TCPHealthCheckOrBuilder getTcpHealthCheckOrBuilder()
optional .google.cloud.compute.v1.TCPHealthCheck tcp_health_check = 469980419;
Returns | |
---|---|
Type | Description |
TCPHealthCheckOrBuilder |
getTimeoutSec()
public int getTimeoutSec()
How long (in seconds) to wait before claiming failure. The default value is 5 seconds. It is invalid for timeoutSec to have greater value than checkIntervalSec.
optional int32 timeout_sec = 79994995;
Returns | |
---|---|
Type | Description |
int |
The timeoutSec. |
getType()
public String getType()
Specifies the type of the healthCheck, either TCP, SSL, HTTP, HTTPS, HTTP2 or GRPC. Exactly one of the protocol-specific health check fields must be specified, which must match type field. Check the Type enum for the list of possible values.
optional string type = 3575610;
Returns | |
---|---|
Type | Description |
String |
The type. |
getTypeBytes()
public ByteString getTypeBytes()
Specifies the type of the healthCheck, either TCP, SSL, HTTP, HTTPS, HTTP2 or GRPC. Exactly one of the protocol-specific health check fields must be specified, which must match type field. Check the Type enum for the list of possible values.
optional string type = 3575610;
Returns | |
---|---|
Type | Description |
ByteString |
The bytes for type. |
getUnhealthyThreshold()
public int getUnhealthyThreshold()
A so-far healthy instance will be marked unhealthy after this many consecutive failures. The default value is 2.
optional int32 unhealthy_threshold = 227958480;
Returns | |
---|---|
Type | Description |
int |
The unhealthyThreshold. |
hasCheckIntervalSec()
public boolean hasCheckIntervalSec()
How often (in seconds) to send a health check. The default value is 5 seconds.
optional int32 check_interval_sec = 345561006;
Returns | |
---|---|
Type | Description |
boolean |
Whether the checkIntervalSec field is set. |
hasCreationTimestamp()
public boolean hasCreationTimestamp()
[Output Only] Creation timestamp in 3339 text format.
optional string creation_timestamp = 30525366;
Returns | |
---|---|
Type | Description |
boolean |
Whether the creationTimestamp field is set. |
hasDescription()
public boolean hasDescription()
An optional description of this resource. Provide this property when you create the resource.
optional string description = 422937596;
Returns | |
---|---|
Type | Description |
boolean |
Whether the description field is set. |
hasGrpcHealthCheck()
public boolean hasGrpcHealthCheck()
optional .google.cloud.compute.v1.GRPCHealthCheck grpc_health_check = 85529574;
Returns | |
---|---|
Type | Description |
boolean |
Whether the grpcHealthCheck field is set. |
hasHealthyThreshold()
public boolean hasHealthyThreshold()
A so-far unhealthy instance will be marked healthy after this many consecutive successes. The default value is 2.
optional int32 healthy_threshold = 403212361;
Returns | |
---|---|
Type | Description |
boolean |
Whether the healthyThreshold field is set. |
hasHttp2HealthCheck()
public boolean hasHttp2HealthCheck()
optional .google.cloud.compute.v1.HTTP2HealthCheck http2_health_check = 11360986;
Returns | |
---|---|
Type | Description |
boolean |
Whether the http2HealthCheck field is set. |
hasHttpHealthCheck()
public boolean hasHttpHealthCheck()
optional .google.cloud.compute.v1.HTTPHealthCheck http_health_check = 412586940;
Returns | |
---|---|
Type | Description |
boolean |
Whether the httpHealthCheck field is set. |
hasHttpsHealthCheck()
public boolean hasHttpsHealthCheck()
optional .google.cloud.compute.v1.HTTPSHealthCheck https_health_check = 436046905;
Returns | |
---|---|
Type | Description |
boolean |
Whether the httpsHealthCheck field is set. |
hasId()
public boolean hasId()
[Output Only] The unique identifier for the resource. This identifier is defined by the server.
optional uint64 id = 3355;
Returns | |
---|---|
Type | Description |
boolean |
Whether the id field is set. |
hasKind()
public boolean hasKind()
Type of the resource.
optional string kind = 3292052;
Returns | |
---|---|
Type | Description |
boolean |
Whether the kind field is set. |
hasLogConfig()
public boolean hasLogConfig()
Configure logging on this health check.
optional .google.cloud.compute.v1.HealthCheckLogConfig log_config = 351299741;
Returns | |
---|---|
Type | Description |
boolean |
Whether the logConfig field is set. |
hasName()
public boolean hasName()
Name of the resource. Provided by the client when the resource is created. The name must be 1-63 characters long, and comply with RFC1035. For example, a name that is 1-63 characters long, matches the regular expression a-z?
, and otherwise complies with RFC1035. This regular expression describes a name where the first character is a lowercase letter, and all following characters are a dash, lowercase letter, or digit, except the last character, which isn't a dash.
optional string name = 3373707;
Returns | |
---|---|
Type | Description |
boolean |
Whether the name field is set. |
hasRegion()
public boolean hasRegion()
[Output Only] Region where the health check resides. Not applicable to global health checks.
optional string region = 138946292;
Returns | |
---|---|
Type | Description |
boolean |
Whether the region field is set. |
hasSelfLink()
public boolean hasSelfLink()
[Output Only] Server-defined URL for the resource.
optional string self_link = 456214797;
Returns | |
---|---|
Type | Description |
boolean |
Whether the selfLink field is set. |
hasSslHealthCheck()
public boolean hasSslHealthCheck()
optional .google.cloud.compute.v1.SSLHealthCheck ssl_health_check = 280032440;
Returns | |
---|---|
Type | Description |
boolean |
Whether the sslHealthCheck field is set. |
hasTcpHealthCheck()
public boolean hasTcpHealthCheck()
optional .google.cloud.compute.v1.TCPHealthCheck tcp_health_check = 469980419;
Returns | |
---|---|
Type | Description |
boolean |
Whether the tcpHealthCheck field is set. |
hasTimeoutSec()
public boolean hasTimeoutSec()
How long (in seconds) to wait before claiming failure. The default value is 5 seconds. It is invalid for timeoutSec to have greater value than checkIntervalSec.
optional int32 timeout_sec = 79994995;
Returns | |
---|---|
Type | Description |
boolean |
Whether the timeoutSec field is set. |
hasType()
public boolean hasType()
Specifies the type of the healthCheck, either TCP, SSL, HTTP, HTTPS, HTTP2 or GRPC. Exactly one of the protocol-specific health check fields must be specified, which must match type field. Check the Type enum for the list of possible values.
optional string type = 3575610;
Returns | |
---|---|
Type | Description |
boolean |
Whether the type field is set. |
hasUnhealthyThreshold()
public boolean hasUnhealthyThreshold()
A so-far healthy instance will be marked unhealthy after this many consecutive failures. The default value is 2.
optional int32 unhealthy_threshold = 227958480;
Returns | |
---|---|
Type | Description |
boolean |
Whether the unhealthyThreshold field is set. |
internalGetFieldAccessorTable()
protected GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
Returns | |
---|---|
Type | Description |
FieldAccessorTable |
isInitialized()
public final boolean isInitialized()
Returns | |
---|---|
Type | Description |
boolean |
mergeFrom(HealthCheck other)
public HealthCheck.Builder mergeFrom(HealthCheck other)
Parameter | |
---|---|
Name | Description |
other |
HealthCheck |
Returns | |
---|---|
Type | Description |
HealthCheck.Builder |
mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
public HealthCheck.Builder mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
Parameters | |
---|---|
Name | Description |
input |
CodedInputStream |
extensionRegistry |
ExtensionRegistryLite |
Returns | |
---|---|
Type | Description |
HealthCheck.Builder |
Exceptions | |
---|---|
Type | Description |
IOException |
mergeFrom(Message other)
public HealthCheck.Builder mergeFrom(Message other)
Parameter | |
---|---|
Name | Description |
other |
Message |
Returns | |
---|---|
Type | Description |
HealthCheck.Builder |
mergeGrpcHealthCheck(GRPCHealthCheck value)
public HealthCheck.Builder mergeGrpcHealthCheck(GRPCHealthCheck value)
optional .google.cloud.compute.v1.GRPCHealthCheck grpc_health_check = 85529574;
Parameter | |
---|---|
Name | Description |
value |
GRPCHealthCheck |
Returns | |
---|---|
Type | Description |
HealthCheck.Builder |
mergeHttp2HealthCheck(HTTP2HealthCheck value)
public HealthCheck.Builder mergeHttp2HealthCheck(HTTP2HealthCheck value)
optional .google.cloud.compute.v1.HTTP2HealthCheck http2_health_check = 11360986;
Parameter | |
---|---|
Name | Description |
value |
HTTP2HealthCheck |
Returns | |
---|---|
Type | Description |
HealthCheck.Builder |
mergeHttpHealthCheck(HTTPHealthCheck value)
public HealthCheck.Builder mergeHttpHealthCheck(HTTPHealthCheck value)
optional .google.cloud.compute.v1.HTTPHealthCheck http_health_check = 412586940;
Parameter | |
---|---|
Name | Description |
value |
HTTPHealthCheck |
Returns | |
---|---|
Type | Description |
HealthCheck.Builder |
mergeHttpsHealthCheck(HTTPSHealthCheck value)
public HealthCheck.Builder mergeHttpsHealthCheck(HTTPSHealthCheck value)
optional .google.cloud.compute.v1.HTTPSHealthCheck https_health_check = 436046905;
Parameter | |
---|---|
Name | Description |
value |
HTTPSHealthCheck |
Returns | |
---|---|
Type | Description |
HealthCheck.Builder |
mergeLogConfig(HealthCheckLogConfig value)
public HealthCheck.Builder mergeLogConfig(HealthCheckLogConfig value)
Configure logging on this health check.
optional .google.cloud.compute.v1.HealthCheckLogConfig log_config = 351299741;
Parameter | |
---|---|
Name | Description |
value |
HealthCheckLogConfig |
Returns | |
---|---|
Type | Description |
HealthCheck.Builder |
mergeSslHealthCheck(SSLHealthCheck value)
public HealthCheck.Builder mergeSslHealthCheck(SSLHealthCheck value)
optional .google.cloud.compute.v1.SSLHealthCheck ssl_health_check = 280032440;
Parameter | |
---|---|
Name | Description |
value |
SSLHealthCheck |
Returns | |
---|---|
Type | Description |
HealthCheck.Builder |
mergeTcpHealthCheck(TCPHealthCheck value)
public HealthCheck.Builder mergeTcpHealthCheck(TCPHealthCheck value)
optional .google.cloud.compute.v1.TCPHealthCheck tcp_health_check = 469980419;
Parameter | |
---|---|
Name | Description |
value |
TCPHealthCheck |
Returns | |
---|---|
Type | Description |
HealthCheck.Builder |
mergeUnknownFields(UnknownFieldSet unknownFields)
public final HealthCheck.Builder mergeUnknownFields(UnknownFieldSet unknownFields)
Parameter | |
---|---|
Name | Description |
unknownFields |
UnknownFieldSet |
Returns | |
---|---|
Type | Description |
HealthCheck.Builder |
setCheckIntervalSec(int value)
public HealthCheck.Builder setCheckIntervalSec(int value)
How often (in seconds) to send a health check. The default value is 5 seconds.
optional int32 check_interval_sec = 345561006;
Parameter | |
---|---|
Name | Description |
value |
int The checkIntervalSec to set. |
Returns | |
---|---|
Type | Description |
HealthCheck.Builder |
This builder for chaining. |
setCreationTimestamp(String value)
public HealthCheck.Builder setCreationTimestamp(String value)
[Output Only] Creation timestamp in 3339 text format.
optional string creation_timestamp = 30525366;
Parameter | |
---|---|
Name | Description |
value |
String The creationTimestamp to set. |
Returns | |
---|---|
Type | Description |
HealthCheck.Builder |
This builder for chaining. |
setCreationTimestampBytes(ByteString value)
public HealthCheck.Builder setCreationTimestampBytes(ByteString value)
[Output Only] Creation timestamp in 3339 text format.
optional string creation_timestamp = 30525366;
Parameter | |
---|---|
Name | Description |
value |
ByteString The bytes for creationTimestamp to set. |
Returns | |
---|---|
Type | Description |
HealthCheck.Builder |
This builder for chaining. |
setDescription(String value)
public HealthCheck.Builder setDescription(String value)
An optional description of this resource. Provide this property when you create the resource.
optional string description = 422937596;
Parameter | |
---|---|
Name | Description |
value |
String The description to set. |
Returns | |
---|---|
Type | Description |
HealthCheck.Builder |
This builder for chaining. |
setDescriptionBytes(ByteString value)
public HealthCheck.Builder setDescriptionBytes(ByteString value)
An optional description of this resource. Provide this property when you create the resource.
optional string description = 422937596;
Parameter | |
---|---|
Name | Description |
value |
ByteString The bytes for description to set. |
Returns | |
---|---|
Type | Description |
HealthCheck.Builder |
This builder for chaining. |
setField(Descriptors.FieldDescriptor field, Object value)
public HealthCheck.Builder setField(Descriptors.FieldDescriptor field, Object value)
Parameters | |
---|---|
Name | Description |
field |
FieldDescriptor |
value |
Object |
Returns | |
---|---|
Type | Description |
HealthCheck.Builder |
setGrpcHealthCheck(GRPCHealthCheck value)
public HealthCheck.Builder setGrpcHealthCheck(GRPCHealthCheck value)
optional .google.cloud.compute.v1.GRPCHealthCheck grpc_health_check = 85529574;
Parameter | |
---|---|
Name | Description |
value |
GRPCHealthCheck |
Returns | |
---|---|
Type | Description |
HealthCheck.Builder |
setGrpcHealthCheck(GRPCHealthCheck.Builder builderForValue)
public HealthCheck.Builder setGrpcHealthCheck(GRPCHealthCheck.Builder builderForValue)
optional .google.cloud.compute.v1.GRPCHealthCheck grpc_health_check = 85529574;
Parameter | |
---|---|
Name | Description |
builderForValue |
GRPCHealthCheck.Builder |
Returns | |
---|---|
Type | Description |
HealthCheck.Builder |
setHealthyThreshold(int value)
public HealthCheck.Builder setHealthyThreshold(int value)
A so-far unhealthy instance will be marked healthy after this many consecutive successes. The default value is 2.
optional int32 healthy_threshold = 403212361;
Parameter | |
---|---|
Name | Description |
value |
int The healthyThreshold to set. |
Returns | |
---|---|
Type | Description |
HealthCheck.Builder |
This builder for chaining. |
setHttp2HealthCheck(HTTP2HealthCheck value)
public HealthCheck.Builder setHttp2HealthCheck(HTTP2HealthCheck value)
optional .google.cloud.compute.v1.HTTP2HealthCheck http2_health_check = 11360986;
Parameter | |
---|---|
Name | Description |
value |
HTTP2HealthCheck |
Returns | |
---|---|
Type | Description |
HealthCheck.Builder |
setHttp2HealthCheck(HTTP2HealthCheck.Builder builderForValue)
public HealthCheck.Builder setHttp2HealthCheck(HTTP2HealthCheck.Builder builderForValue)
optional .google.cloud.compute.v1.HTTP2HealthCheck http2_health_check = 11360986;
Parameter | |
---|---|
Name | Description |
builderForValue |
HTTP2HealthCheck.Builder |
Returns | |
---|---|
Type | Description |
HealthCheck.Builder |
setHttpHealthCheck(HTTPHealthCheck value)
public HealthCheck.Builder setHttpHealthCheck(HTTPHealthCheck value)
optional .google.cloud.compute.v1.HTTPHealthCheck http_health_check = 412586940;
Parameter | |
---|---|
Name | Description |
value |
HTTPHealthCheck |
Returns | |
---|---|
Type | Description |
HealthCheck.Builder |
setHttpHealthCheck(HTTPHealthCheck.Builder builderForValue)
public HealthCheck.Builder setHttpHealthCheck(HTTPHealthCheck.Builder builderForValue)
optional .google.cloud.compute.v1.HTTPHealthCheck http_health_check = 412586940;
Parameter | |
---|---|
Name | Description |
builderForValue |
HTTPHealthCheck.Builder |
Returns | |
---|---|
Type | Description |
HealthCheck.Builder |
setHttpsHealthCheck(HTTPSHealthCheck value)
public HealthCheck.Builder setHttpsHealthCheck(HTTPSHealthCheck value)
optional .google.cloud.compute.v1.HTTPSHealthCheck https_health_check = 436046905;
Parameter | |
---|---|
Name | Description |
value |
HTTPSHealthCheck |
Returns | |
---|---|
Type | Description |
HealthCheck.Builder |
setHttpsHealthCheck(HTTPSHealthCheck.Builder builderForValue)
public HealthCheck.Builder setHttpsHealthCheck(HTTPSHealthCheck.Builder builderForValue)
optional .google.cloud.compute.v1.HTTPSHealthCheck https_health_check = 436046905;
Parameter | |
---|---|
Name | Description |
builderForValue |
HTTPSHealthCheck.Builder |
Returns | |
---|---|
Type | Description |
HealthCheck.Builder |
setId(long value)
public HealthCheck.Builder setId(long value)
[Output Only] The unique identifier for the resource. This identifier is defined by the server.
optional uint64 id = 3355;
Parameter | |
---|---|
Name | Description |
value |
long The id to set. |
Returns | |
---|---|
Type | Description |
HealthCheck.Builder |
This builder for chaining. |
setKind(String value)
public HealthCheck.Builder setKind(String value)
Type of the resource.
optional string kind = 3292052;
Parameter | |
---|---|
Name | Description |
value |
String The kind to set. |
Returns | |
---|---|
Type | Description |
HealthCheck.Builder |
This builder for chaining. |
setKindBytes(ByteString value)
public HealthCheck.Builder setKindBytes(ByteString value)
Type of the resource.
optional string kind = 3292052;
Parameter | |
---|---|
Name | Description |
value |
ByteString The bytes for kind to set. |
Returns | |
---|---|
Type | Description |
HealthCheck.Builder |
This builder for chaining. |
setLogConfig(HealthCheckLogConfig value)
public HealthCheck.Builder setLogConfig(HealthCheckLogConfig value)
Configure logging on this health check.
optional .google.cloud.compute.v1.HealthCheckLogConfig log_config = 351299741;
Parameter | |
---|---|
Name | Description |
value |
HealthCheckLogConfig |
Returns | |
---|---|
Type | Description |
HealthCheck.Builder |
setLogConfig(HealthCheckLogConfig.Builder builderForValue)
public HealthCheck.Builder setLogConfig(HealthCheckLogConfig.Builder builderForValue)
Configure logging on this health check.
optional .google.cloud.compute.v1.HealthCheckLogConfig log_config = 351299741;
Parameter | |
---|---|
Name | Description |
builderForValue |
HealthCheckLogConfig.Builder |
Returns | |
---|---|
Type | Description |
HealthCheck.Builder |
setName(String value)
public HealthCheck.Builder setName(String value)
Name of the resource. Provided by the client when the resource is created. The name must be 1-63 characters long, and comply with RFC1035. For example, a name that is 1-63 characters long, matches the regular expression a-z?
, and otherwise complies with RFC1035. This regular expression describes a name where the first character is a lowercase letter, and all following characters are a dash, lowercase letter, or digit, except the last character, which isn't a dash.
optional string name = 3373707;
Parameter | |
---|---|
Name | Description |
value |
String The name to set. |
Returns | |
---|---|
Type | Description |
HealthCheck.Builder |
This builder for chaining. |
setNameBytes(ByteString value)
public HealthCheck.Builder setNameBytes(ByteString value)
Name of the resource. Provided by the client when the resource is created. The name must be 1-63 characters long, and comply with RFC1035. For example, a name that is 1-63 characters long, matches the regular expression a-z?
, and otherwise complies with RFC1035. This regular expression describes a name where the first character is a lowercase letter, and all following characters are a dash, lowercase letter, or digit, except the last character, which isn't a dash.
optional string name = 3373707;
Parameter | |
---|---|
Name | Description |
value |
ByteString The bytes for name to set. |
Returns | |
---|---|
Type | Description |
HealthCheck.Builder |
This builder for chaining. |
setRegion(String value)
public HealthCheck.Builder setRegion(String value)
[Output Only] Region where the health check resides. Not applicable to global health checks.
optional string region = 138946292;
Parameter | |
---|---|
Name | Description |
value |
String The region to set. |
Returns | |
---|---|
Type | Description |
HealthCheck.Builder |
This builder for chaining. |
setRegionBytes(ByteString value)
public HealthCheck.Builder setRegionBytes(ByteString value)
[Output Only] Region where the health check resides. Not applicable to global health checks.
optional string region = 138946292;
Parameter | |
---|---|
Name | Description |
value |
ByteString The bytes for region to set. |
Returns | |
---|---|
Type | Description |
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 | |
---|---|
Name | Description |
field |
FieldDescriptor |
index |
int |
value |
Object |
Returns | |
---|---|
Type | Description |
HealthCheck.Builder |
setSelfLink(String value)
public HealthCheck.Builder setSelfLink(String value)
[Output Only] Server-defined URL for the resource.
optional string self_link = 456214797;
Parameter | |
---|---|
Name | Description |
value |
String The selfLink to set. |
Returns | |
---|---|
Type | Description |
HealthCheck.Builder |
This builder for chaining. |
setSelfLinkBytes(ByteString value)
public HealthCheck.Builder setSelfLinkBytes(ByteString value)
[Output Only] Server-defined URL for the resource.
optional string self_link = 456214797;
Parameter | |
---|---|
Name | Description |
value |
ByteString The bytes for selfLink to set. |
Returns | |
---|---|
Type | Description |
HealthCheck.Builder |
This builder for chaining. |
setSslHealthCheck(SSLHealthCheck value)
public HealthCheck.Builder setSslHealthCheck(SSLHealthCheck value)
optional .google.cloud.compute.v1.SSLHealthCheck ssl_health_check = 280032440;
Parameter | |
---|---|
Name | Description |
value |
SSLHealthCheck |
Returns | |
---|---|
Type | Description |
HealthCheck.Builder |
setSslHealthCheck(SSLHealthCheck.Builder builderForValue)
public HealthCheck.Builder setSslHealthCheck(SSLHealthCheck.Builder builderForValue)
optional .google.cloud.compute.v1.SSLHealthCheck ssl_health_check = 280032440;
Parameter | |
---|---|
Name | Description |
builderForValue |
SSLHealthCheck.Builder |
Returns | |
---|---|
Type | Description |
HealthCheck.Builder |
setTcpHealthCheck(TCPHealthCheck value)
public HealthCheck.Builder setTcpHealthCheck(TCPHealthCheck value)
optional .google.cloud.compute.v1.TCPHealthCheck tcp_health_check = 469980419;
Parameter | |
---|---|
Name | Description |
value |
TCPHealthCheck |
Returns | |
---|---|
Type | Description |
HealthCheck.Builder |
setTcpHealthCheck(TCPHealthCheck.Builder builderForValue)
public HealthCheck.Builder setTcpHealthCheck(TCPHealthCheck.Builder builderForValue)
optional .google.cloud.compute.v1.TCPHealthCheck tcp_health_check = 469980419;
Parameter | |
---|---|
Name | Description |
builderForValue |
TCPHealthCheck.Builder |
Returns | |
---|---|
Type | Description |
HealthCheck.Builder |
setTimeoutSec(int value)
public HealthCheck.Builder setTimeoutSec(int value)
How long (in seconds) to wait before claiming failure. The default value is 5 seconds. It is invalid for timeoutSec to have greater value than checkIntervalSec.
optional int32 timeout_sec = 79994995;
Parameter | |
---|---|
Name | Description |
value |
int The timeoutSec to set. |
Returns | |
---|---|
Type | Description |
HealthCheck.Builder |
This builder for chaining. |
setType(String value)
public HealthCheck.Builder setType(String value)
Specifies the type of the healthCheck, either TCP, SSL, HTTP, HTTPS, HTTP2 or GRPC. Exactly one of the protocol-specific health check fields must be specified, which must match type field. Check the Type enum for the list of possible values.
optional string type = 3575610;
Parameter | |
---|---|
Name | Description |
value |
String The type to set. |
Returns | |
---|---|
Type | Description |
HealthCheck.Builder |
This builder for chaining. |
setTypeBytes(ByteString value)
public HealthCheck.Builder setTypeBytes(ByteString value)
Specifies the type of the healthCheck, either TCP, SSL, HTTP, HTTPS, HTTP2 or GRPC. Exactly one of the protocol-specific health check fields must be specified, which must match type field. Check the Type enum for the list of possible values.
optional string type = 3575610;
Parameter | |
---|---|
Name | Description |
value |
ByteString The bytes for type to set. |
Returns | |
---|---|
Type | Description |
HealthCheck.Builder |
This builder for chaining. |
setUnhealthyThreshold(int value)
public HealthCheck.Builder setUnhealthyThreshold(int value)
A so-far healthy instance will be marked unhealthy after this many consecutive failures. The default value is 2.
optional int32 unhealthy_threshold = 227958480;
Parameter | |
---|---|
Name | Description |
value |
int The unhealthyThreshold to set. |
Returns | |
---|---|
Type | Description |
HealthCheck.Builder |
This builder for chaining. |
setUnknownFields(UnknownFieldSet unknownFields)
public final HealthCheck.Builder setUnknownFields(UnknownFieldSet unknownFields)
Parameter | |
---|---|
Name | Description |
unknownFields |
UnknownFieldSet |
Returns | |
---|---|
Type | Description |
HealthCheck.Builder |