- 1.57.0 (latest)
- 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 final class HealthCheck extends GeneratedMessageV3 implements HealthCheckOrBuilder
Represents a Health Check resource. Google Compute Engine has two Health Check resources: * Global * Regional Internal HTTP(S) load balancers must use regional health checks (compute.v1.regionHealthChecks
). Traffic Director must use global health checks (compute.v1.HealthChecks
). Internal TCP/UDP load balancers can use either regional or global health checks (compute.v1.regionHealthChecks
or compute.v1.HealthChecks
). External HTTP(S), TCP proxy, and SSL proxy load balancers as well as managed instance group auto-healing must use global health checks (compute.v1.HealthChecks
). Backend service-based network load balancers must use regional health checks (compute.v1.regionHealthChecks
). Target pool-based network load balancers must use legacy HTTP health checks (compute.v1.httpHealthChecks
). For more information, see Health checks overview.
Protobuf type google.cloud.compute.v1.HealthCheck
Inheritance
Object > AbstractMessageLite<MessageType,BuilderType> > AbstractMessage > GeneratedMessageV3 > HealthCheckImplements
HealthCheckOrBuilderStatic Fields
CHECK_INTERVAL_SEC_FIELD_NUMBER
public static final int CHECK_INTERVAL_SEC_FIELD_NUMBER
Type | Description |
int |
CREATION_TIMESTAMP_FIELD_NUMBER
public static final int CREATION_TIMESTAMP_FIELD_NUMBER
Type | Description |
int |
DESCRIPTION_FIELD_NUMBER
public static final int DESCRIPTION_FIELD_NUMBER
Type | Description |
int |
GRPC_HEALTH_CHECK_FIELD_NUMBER
public static final int GRPC_HEALTH_CHECK_FIELD_NUMBER
Type | Description |
int |
HEALTHY_THRESHOLD_FIELD_NUMBER
public static final int HEALTHY_THRESHOLD_FIELD_NUMBER
Type | Description |
int |
HTTP2_HEALTH_CHECK_FIELD_NUMBER
public static final int HTTP2_HEALTH_CHECK_FIELD_NUMBER
Type | Description |
int |
HTTPS_HEALTH_CHECK_FIELD_NUMBER
public static final int HTTPS_HEALTH_CHECK_FIELD_NUMBER
Type | Description |
int |
HTTP_HEALTH_CHECK_FIELD_NUMBER
public static final int HTTP_HEALTH_CHECK_FIELD_NUMBER
Type | Description |
int |
ID_FIELD_NUMBER
public static final int ID_FIELD_NUMBER
Type | Description |
int |
KIND_FIELD_NUMBER
public static final int KIND_FIELD_NUMBER
Type | Description |
int |
LOG_CONFIG_FIELD_NUMBER
public static final int LOG_CONFIG_FIELD_NUMBER
Type | Description |
int |
NAME_FIELD_NUMBER
public static final int NAME_FIELD_NUMBER
Type | Description |
int |
REGION_FIELD_NUMBER
public static final int REGION_FIELD_NUMBER
Type | Description |
int |
SELF_LINK_FIELD_NUMBER
public static final int SELF_LINK_FIELD_NUMBER
Type | Description |
int |
SSL_HEALTH_CHECK_FIELD_NUMBER
public static final int SSL_HEALTH_CHECK_FIELD_NUMBER
Type | Description |
int |
TCP_HEALTH_CHECK_FIELD_NUMBER
public static final int TCP_HEALTH_CHECK_FIELD_NUMBER
Type | Description |
int |
TIMEOUT_SEC_FIELD_NUMBER
public static final int TIMEOUT_SEC_FIELD_NUMBER
Type | Description |
int |
TYPE_FIELD_NUMBER
public static final int TYPE_FIELD_NUMBER
Type | Description |
int |
UNHEALTHY_THRESHOLD_FIELD_NUMBER
public static final int UNHEALTHY_THRESHOLD_FIELD_NUMBER
Type | Description |
int |
Static Methods
getDefaultInstance()
public static HealthCheck getDefaultInstance()
Type | Description |
HealthCheck |
getDescriptor()
public static final Descriptors.Descriptor getDescriptor()
Type | Description |
Descriptor |
newBuilder()
public static HealthCheck.Builder newBuilder()
Type | Description |
HealthCheck.Builder |
newBuilder(HealthCheck prototype)
public static HealthCheck.Builder newBuilder(HealthCheck prototype)
Name | Description |
prototype | HealthCheck |
Type | Description |
HealthCheck.Builder |
parseDelimitedFrom(InputStream input)
public static HealthCheck parseDelimitedFrom(InputStream input)
Name | Description |
input | InputStream |
Type | Description |
HealthCheck |
Type | Description |
IOException |
parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
public static HealthCheck parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
Name | Description |
input | InputStream |
extensionRegistry | ExtensionRegistryLite |
Type | Description |
HealthCheck |
Type | Description |
IOException |
parseFrom(byte[] data)
public static HealthCheck parseFrom(byte[] data)
Name | Description |
data | byte[] |
Type | Description |
HealthCheck |
Type | Description |
InvalidProtocolBufferException |
parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)
public static HealthCheck parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)
Name | Description |
data | byte[] |
extensionRegistry | ExtensionRegistryLite |
Type | Description |
HealthCheck |
Type | Description |
InvalidProtocolBufferException |
parseFrom(ByteString data)
public static HealthCheck parseFrom(ByteString data)
Name | Description |
data | ByteString |
Type | Description |
HealthCheck |
Type | Description |
InvalidProtocolBufferException |
parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)
public static HealthCheck parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)
Name | Description |
data | ByteString |
extensionRegistry | ExtensionRegistryLite |
Type | Description |
HealthCheck |
Type | Description |
InvalidProtocolBufferException |
parseFrom(CodedInputStream input)
public static HealthCheck parseFrom(CodedInputStream input)
Name | Description |
input | CodedInputStream |
Type | Description |
HealthCheck |
Type | Description |
IOException |
parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
public static HealthCheck parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
Name | Description |
input | CodedInputStream |
extensionRegistry | ExtensionRegistryLite |
Type | Description |
HealthCheck |
Type | Description |
IOException |
parseFrom(InputStream input)
public static HealthCheck parseFrom(InputStream input)
Name | Description |
input | InputStream |
Type | Description |
HealthCheck |
Type | Description |
IOException |
parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
public static HealthCheck parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
Name | Description |
input | InputStream |
extensionRegistry | ExtensionRegistryLite |
Type | Description |
HealthCheck |
Type | Description |
IOException |
parseFrom(ByteBuffer data)
public static HealthCheck parseFrom(ByteBuffer data)
Name | Description |
data | ByteBuffer |
Type | Description |
HealthCheck |
Type | Description |
InvalidProtocolBufferException |
parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)
public static HealthCheck parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)
Name | Description |
data | ByteBuffer |
extensionRegistry | ExtensionRegistryLite |
Type | Description |
HealthCheck |
Type | Description |
InvalidProtocolBufferException |
parser()
public static Parser<HealthCheck> parser()
Type | Description |
Parser<HealthCheck> |
Methods
equals(Object obj)
public boolean equals(Object obj)
Name | Description |
obj | Object |
Type | Description |
boolean |
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;
Type | Description |
int | The checkIntervalSec. |
getCreationTimestamp()
public String getCreationTimestamp()
[Output Only] Creation timestamp in 3339 text format.
optional string creation_timestamp = 30525366;
Type | Description |
String | The creationTimestamp. |
getCreationTimestampBytes()
public ByteString getCreationTimestampBytes()
[Output Only] Creation timestamp in 3339 text format.
optional string creation_timestamp = 30525366;
Type | Description |
ByteString | The bytes for creationTimestamp. |
getDefaultInstanceForType()
public HealthCheck getDefaultInstanceForType()
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;
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;
Type | Description |
ByteString | The bytes for description. |
getGrpcHealthCheck()
public GRPCHealthCheck getGrpcHealthCheck()
optional .google.cloud.compute.v1.GRPCHealthCheck grpc_health_check = 85529574;
Type | Description |
GRPCHealthCheck | The grpcHealthCheck. |
getGrpcHealthCheckOrBuilder()
public GRPCHealthCheckOrBuilder getGrpcHealthCheckOrBuilder()
optional .google.cloud.compute.v1.GRPCHealthCheck grpc_health_check = 85529574;
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;
Type | Description |
int | The healthyThreshold. |
getHttp2HealthCheck()
public HTTP2HealthCheck getHttp2HealthCheck()
optional .google.cloud.compute.v1.HTTP2HealthCheck http2_health_check = 11360986;
Type | Description |
HTTP2HealthCheck | The http2HealthCheck. |
getHttp2HealthCheckOrBuilder()
public HTTP2HealthCheckOrBuilder getHttp2HealthCheckOrBuilder()
optional .google.cloud.compute.v1.HTTP2HealthCheck http2_health_check = 11360986;
Type | Description |
HTTP2HealthCheckOrBuilder |
getHttpHealthCheck()
public HTTPHealthCheck getHttpHealthCheck()
optional .google.cloud.compute.v1.HTTPHealthCheck http_health_check = 412586940;
Type | Description |
HTTPHealthCheck | The httpHealthCheck. |
getHttpHealthCheckOrBuilder()
public HTTPHealthCheckOrBuilder getHttpHealthCheckOrBuilder()
optional .google.cloud.compute.v1.HTTPHealthCheck http_health_check = 412586940;
Type | Description |
HTTPHealthCheckOrBuilder |
getHttpsHealthCheck()
public HTTPSHealthCheck getHttpsHealthCheck()
optional .google.cloud.compute.v1.HTTPSHealthCheck https_health_check = 436046905;
Type | Description |
HTTPSHealthCheck | The httpsHealthCheck. |
getHttpsHealthCheckOrBuilder()
public HTTPSHealthCheckOrBuilder getHttpsHealthCheckOrBuilder()
optional .google.cloud.compute.v1.HTTPSHealthCheck https_health_check = 436046905;
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;
Type | Description |
long | The id. |
getKind()
public String getKind()
Type of the resource.
optional string kind = 3292052;
Type | Description |
String | The kind. |
getKindBytes()
public ByteString getKindBytes()
Type of the resource.
optional string kind = 3292052;
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;
Type | Description |
HealthCheckLogConfig | The logConfig. |
getLogConfigOrBuilder()
public HealthCheckLogConfigOrBuilder getLogConfigOrBuilder()
Configure logging on this health check.
optional .google.cloud.compute.v1.HealthCheckLogConfig log_config = 351299741;
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;
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;
Type | Description |
ByteString | The bytes for name. |
getParserForType()
public Parser<HealthCheck> getParserForType()
Type | Description |
Parser<HealthCheck> |
getRegion()
public String getRegion()
[Output Only] Region where the health check resides. Not applicable to global health checks.
optional string region = 138946292;
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;
Type | Description |
ByteString | The bytes for region. |
getSelfLink()
public String getSelfLink()
[Output Only] Server-defined URL for the resource.
optional string self_link = 456214797;
Type | Description |
String | The selfLink. |
getSelfLinkBytes()
public ByteString getSelfLinkBytes()
[Output Only] Server-defined URL for the resource.
optional string self_link = 456214797;
Type | Description |
ByteString | The bytes for selfLink. |
getSerializedSize()
public int getSerializedSize()
Type | Description |
int |
getSslHealthCheck()
public SSLHealthCheck getSslHealthCheck()
optional .google.cloud.compute.v1.SSLHealthCheck ssl_health_check = 280032440;
Type | Description |
SSLHealthCheck | The sslHealthCheck. |
getSslHealthCheckOrBuilder()
public SSLHealthCheckOrBuilder getSslHealthCheckOrBuilder()
optional .google.cloud.compute.v1.SSLHealthCheck ssl_health_check = 280032440;
Type | Description |
SSLHealthCheckOrBuilder |
getTcpHealthCheck()
public TCPHealthCheck getTcpHealthCheck()
optional .google.cloud.compute.v1.TCPHealthCheck tcp_health_check = 469980419;
Type | Description |
TCPHealthCheck | The tcpHealthCheck. |
getTcpHealthCheckOrBuilder()
public TCPHealthCheckOrBuilder getTcpHealthCheckOrBuilder()
optional .google.cloud.compute.v1.TCPHealthCheck tcp_health_check = 469980419;
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;
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;
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;
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;
Type | Description |
int | The unhealthyThreshold. |
getUnknownFields()
public final UnknownFieldSet getUnknownFields()
Type | Description |
UnknownFieldSet |
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;
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;
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;
Type | Description |
boolean | Whether the description field is set. |
hasGrpcHealthCheck()
public boolean hasGrpcHealthCheck()
optional .google.cloud.compute.v1.GRPCHealthCheck grpc_health_check = 85529574;
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;
Type | Description |
boolean | Whether the healthyThreshold field is set. |
hasHttp2HealthCheck()
public boolean hasHttp2HealthCheck()
optional .google.cloud.compute.v1.HTTP2HealthCheck http2_health_check = 11360986;
Type | Description |
boolean | Whether the http2HealthCheck field is set. |
hasHttpHealthCheck()
public boolean hasHttpHealthCheck()
optional .google.cloud.compute.v1.HTTPHealthCheck http_health_check = 412586940;
Type | Description |
boolean | Whether the httpHealthCheck field is set. |
hasHttpsHealthCheck()
public boolean hasHttpsHealthCheck()
optional .google.cloud.compute.v1.HTTPSHealthCheck https_health_check = 436046905;
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;
Type | Description |
boolean | Whether the id field is set. |
hasKind()
public boolean hasKind()
Type of the resource.
optional string kind = 3292052;
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;
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;
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;
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;
Type | Description |
boolean | Whether the selfLink field is set. |
hasSslHealthCheck()
public boolean hasSslHealthCheck()
optional .google.cloud.compute.v1.SSLHealthCheck ssl_health_check = 280032440;
Type | Description |
boolean | Whether the sslHealthCheck field is set. |
hasTcpHealthCheck()
public boolean hasTcpHealthCheck()
optional .google.cloud.compute.v1.TCPHealthCheck tcp_health_check = 469980419;
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;
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;
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;
Type | Description |
boolean | Whether the unhealthyThreshold field is set. |
hashCode()
public int hashCode()
Type | Description |
int |
internalGetFieldAccessorTable()
protected GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
Type | Description |
FieldAccessorTable |
isInitialized()
public final boolean isInitialized()
Type | Description |
boolean |
newBuilderForType()
public HealthCheck.Builder newBuilderForType()
Type | Description |
HealthCheck.Builder |
newBuilderForType(GeneratedMessageV3.BuilderParent parent)
protected HealthCheck.Builder newBuilderForType(GeneratedMessageV3.BuilderParent parent)
Name | Description |
parent | BuilderParent |
Type | Description |
HealthCheck.Builder |
newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)
protected Object newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)
Name | Description |
unused | UnusedPrivateParameter |
Type | Description |
Object |
toBuilder()
public HealthCheck.Builder toBuilder()
Type | Description |
HealthCheck.Builder |
writeTo(CodedOutputStream output)
public void writeTo(CodedOutputStream output)
Name | Description |
output | CodedOutputStream |
Type | Description |
IOException |