Interface HealthCheckOrBuilder (1.29.0)

Version 1.29.0

• 1.65.0 (latest)
• 1.64.0
• 1.63.0
• 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 interface HealthCheckOrBuilder extends MessageOrBuilder

Implements

MessageOrBuilder

Methods

getCheckIntervalSec()

public abstract 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 abstract String getCreationTimestamp()

[Output Only] Creation timestamp in 3339 text format.

optional string creation_timestamp = 30525366;

Returns
Type	Description
String	The creationTimestamp.

getCreationTimestampBytes()

public abstract ByteString getCreationTimestampBytes()

[Output Only] Creation timestamp in 3339 text format.

optional string creation_timestamp = 30525366;

Returns
Type	Description
ByteString	The bytes for creationTimestamp.

getDescription()

public abstract 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 abstract 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.

getGrpcHealthCheck()

public abstract GRPCHealthCheck getGrpcHealthCheck()

optional .google.cloud.compute.v1.GRPCHealthCheck grpc_health_check = 85529574;

Returns
Type	Description
GRPCHealthCheck	The grpcHealthCheck.

getGrpcHealthCheckOrBuilder()

public abstract GRPCHealthCheckOrBuilder getGrpcHealthCheckOrBuilder()

optional .google.cloud.compute.v1.GRPCHealthCheck grpc_health_check = 85529574;

Returns
Type	Description
GRPCHealthCheckOrBuilder

getHealthyThreshold()

public abstract 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 abstract HTTP2HealthCheck getHttp2HealthCheck()

optional .google.cloud.compute.v1.HTTP2HealthCheck http2_health_check = 11360986;

Returns
Type	Description
HTTP2HealthCheck	The http2HealthCheck.

getHttp2HealthCheckOrBuilder()

public abstract HTTP2HealthCheckOrBuilder getHttp2HealthCheckOrBuilder()

optional .google.cloud.compute.v1.HTTP2HealthCheck http2_health_check = 11360986;

Returns
Type	Description
HTTP2HealthCheckOrBuilder

getHttpHealthCheck()

public abstract HTTPHealthCheck getHttpHealthCheck()

optional .google.cloud.compute.v1.HTTPHealthCheck http_health_check = 412586940;

Returns
Type	Description
HTTPHealthCheck	The httpHealthCheck.

getHttpHealthCheckOrBuilder()

public abstract HTTPHealthCheckOrBuilder getHttpHealthCheckOrBuilder()

optional .google.cloud.compute.v1.HTTPHealthCheck http_health_check = 412586940;

Returns
Type	Description
HTTPHealthCheckOrBuilder

getHttpsHealthCheck()

public abstract HTTPSHealthCheck getHttpsHealthCheck()

optional .google.cloud.compute.v1.HTTPSHealthCheck https_health_check = 436046905;

Returns
Type	Description
HTTPSHealthCheck	The httpsHealthCheck.

getHttpsHealthCheckOrBuilder()

public abstract HTTPSHealthCheckOrBuilder getHttpsHealthCheckOrBuilder()

optional .google.cloud.compute.v1.HTTPSHealthCheck https_health_check = 436046905;

Returns
Type	Description
HTTPSHealthCheckOrBuilder

getId()

public abstract 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 abstract String getKind()

Type of the resource.

optional string kind = 3292052;

Returns
Type	Description
String	The kind.

getKindBytes()

public abstract ByteString getKindBytes()

Type of the resource.

optional string kind = 3292052;

Returns
Type	Description
ByteString	The bytes for kind.

getLogConfig()

public abstract HealthCheckLogConfig getLogConfig()

Configure logging on this health check.

optional .google.cloud.compute.v1.HealthCheckLogConfig log_config = 351299741;

Returns
Type	Description
HealthCheckLogConfig	The logConfig.

getLogConfigOrBuilder()

public abstract HealthCheckLogConfigOrBuilder getLogConfigOrBuilder()

Configure logging on this health check.

optional .google.cloud.compute.v1.HealthCheckLogConfig log_config = 351299741;

Returns
Type	Description
HealthCheckLogConfigOrBuilder

getName()

public abstract 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 abstract 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 abstract 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 abstract 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 abstract String getSelfLink()

[Output Only] Server-defined URL for the resource.

optional string self_link = 456214797;

Returns
Type	Description
String	The selfLink.

getSelfLinkBytes()

public abstract 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 abstract SSLHealthCheck getSslHealthCheck()

optional .google.cloud.compute.v1.SSLHealthCheck ssl_health_check = 280032440;

Returns
Type	Description
SSLHealthCheck	The sslHealthCheck.

getSslHealthCheckOrBuilder()

public abstract SSLHealthCheckOrBuilder getSslHealthCheckOrBuilder()

optional .google.cloud.compute.v1.SSLHealthCheck ssl_health_check = 280032440;

Returns
Type	Description
SSLHealthCheckOrBuilder

getTcpHealthCheck()

public abstract TCPHealthCheck getTcpHealthCheck()

optional .google.cloud.compute.v1.TCPHealthCheck tcp_health_check = 469980419;

Returns
Type	Description
TCPHealthCheck	The tcpHealthCheck.

getTcpHealthCheckOrBuilder()

public abstract TCPHealthCheckOrBuilder getTcpHealthCheckOrBuilder()

optional .google.cloud.compute.v1.TCPHealthCheck tcp_health_check = 469980419;

Returns
Type	Description
TCPHealthCheckOrBuilder

getTimeoutSec()

public abstract 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 abstract 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 abstract 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 abstract 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 abstract 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 abstract 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 abstract 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 abstract boolean hasGrpcHealthCheck()

optional .google.cloud.compute.v1.GRPCHealthCheck grpc_health_check = 85529574;

Returns
Type	Description
boolean	Whether the grpcHealthCheck field is set.

hasHealthyThreshold()

public abstract 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 abstract boolean hasHttp2HealthCheck()

optional .google.cloud.compute.v1.HTTP2HealthCheck http2_health_check = 11360986;

Returns
Type	Description
boolean	Whether the http2HealthCheck field is set.

hasHttpHealthCheck()

public abstract boolean hasHttpHealthCheck()

optional .google.cloud.compute.v1.HTTPHealthCheck http_health_check = 412586940;

Returns
Type	Description
boolean	Whether the httpHealthCheck field is set.

hasHttpsHealthCheck()

public abstract boolean hasHttpsHealthCheck()

optional .google.cloud.compute.v1.HTTPSHealthCheck https_health_check = 436046905;

Returns
Type	Description
boolean	Whether the httpsHealthCheck field is set.

hasId()

public abstract 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 abstract boolean hasKind()

Type of the resource.

optional string kind = 3292052;

Returns
Type	Description
boolean	Whether the kind field is set.

hasLogConfig()

public abstract 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 abstract 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 abstract 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 abstract 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 abstract boolean hasSslHealthCheck()

optional .google.cloud.compute.v1.SSLHealthCheck ssl_health_check = 280032440;

Returns
Type	Description
boolean	Whether the sslHealthCheck field is set.

hasTcpHealthCheck()

public abstract boolean hasTcpHealthCheck()

optional .google.cloud.compute.v1.TCPHealthCheck tcp_health_check = 469980419;

Returns
Type	Description
boolean	Whether the tcpHealthCheck field is set.

hasTimeoutSec()

public abstract 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 abstract 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 abstract 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.