Package com.google.cloud.compute.v1
Interface HealthCheckOrBuilder
- All Superinterfaces:
com.google.protobuf.MessageLiteOrBuilder,com.google.protobuf.MessageOrBuilder
- All Known Implementing Classes:
HealthCheck,HealthCheck.Builder
@Generated
public interface HealthCheckOrBuilder
extends com.google.protobuf.MessageOrBuilder
-
Method Summary
Modifier and TypeMethodDescriptionintHow often (in seconds) to send a health check.Output only.com.google.protobuf.ByteStringOutput only.An optional description of this resource.com.google.protobuf.ByteStringAn optional description of this resource.optional .google.cloud.compute.v1.GRPCHealthCheck grpc_health_check = 85529574;optional .google.cloud.compute.v1.GRPCHealthCheck grpc_health_check = 85529574;optional .google.cloud.compute.v1.GRPCTLSHealthCheck grpc_tls_health_check = 267273258;optional .google.cloud.compute.v1.GRPCTLSHealthCheck grpc_tls_health_check = 267273258;intA so-far unhealthy instance will be marked healthy after this many consecutive successes.optional .google.cloud.compute.v1.HTTP2HealthCheck http2_health_check = 11360986;optional .google.cloud.compute.v1.HTTP2HealthCheck http2_health_check = 11360986;optional .google.cloud.compute.v1.HTTPHealthCheck http_health_check = 412586940;optional .google.cloud.compute.v1.HTTPHealthCheck http_health_check = 412586940;optional .google.cloud.compute.v1.HTTPSHealthCheck https_health_check = 436046905;optional .google.cloud.compute.v1.HTTPSHealthCheck https_health_check = 436046905;longgetId()[Output Only] The unique identifier for the resource.getKind()Output only.com.google.protobuf.ByteStringOutput only.Configure logging on this health check.Configure logging on this health check.getName()Name of the resource.com.google.protobuf.ByteStringName of the resource.Output only.com.google.protobuf.ByteStringOutput only.[Output Only] Server-defined URL for the resource.com.google.protobuf.ByteString[Output Only] Server-defined URL for the resource.getSourceRegions(int index) The list of cloud regions from which health checks are performed.com.google.protobuf.ByteStringgetSourceRegionsBytes(int index) The list of cloud regions from which health checks are performed.intThe list of cloud regions from which health checks are performed.The list of cloud regions from which health checks are performed.optional .google.cloud.compute.v1.SSLHealthCheck ssl_health_check = 280032440;optional .google.cloud.compute.v1.SSLHealthCheck ssl_health_check = 280032440;optional .google.cloud.compute.v1.TCPHealthCheck tcp_health_check = 469980419;optional .google.cloud.compute.v1.TCPHealthCheck tcp_health_check = 469980419;intHow long (in seconds) to wait before claiming failure.getType()Specifies the type of the healthCheck, either TCP,SSL, HTTP, HTTPS,HTTP2 or GRPC.com.google.protobuf.ByteStringSpecifies the type of the healthCheck, either TCP,SSL, HTTP, HTTPS,HTTP2 or GRPC.intA so-far healthy instance will be marked unhealthy after this many consecutive failures.booleanHow often (in seconds) to send a health check.booleanOutput only.booleanAn optional description of this resource.booleanoptional .google.cloud.compute.v1.GRPCHealthCheck grpc_health_check = 85529574;booleanoptional .google.cloud.compute.v1.GRPCTLSHealthCheck grpc_tls_health_check = 267273258;booleanA so-far unhealthy instance will be marked healthy after this many consecutive successes.booleanoptional .google.cloud.compute.v1.HTTP2HealthCheck http2_health_check = 11360986;booleanoptional .google.cloud.compute.v1.HTTPHealthCheck http_health_check = 412586940;booleanoptional .google.cloud.compute.v1.HTTPSHealthCheck https_health_check = 436046905;booleanhasId()[Output Only] The unique identifier for the resource.booleanhasKind()Output only.booleanConfigure logging on this health check.booleanhasName()Name of the resource.booleanOutput only.boolean[Output Only] Server-defined URL for the resource.booleanoptional .google.cloud.compute.v1.SSLHealthCheck ssl_health_check = 280032440;booleanoptional .google.cloud.compute.v1.TCPHealthCheck tcp_health_check = 469980419;booleanHow long (in seconds) to wait before claiming failure.booleanhasType()Specifies the type of the healthCheck, either TCP,SSL, HTTP, HTTPS,HTTP2 or GRPC.booleanA so-far healthy instance will be marked unhealthy after this many consecutive failures.Methods inherited from interface com.google.protobuf.MessageLiteOrBuilder
isInitializedMethods inherited from interface com.google.protobuf.MessageOrBuilder
findInitializationErrors, getAllFields, getDefaultInstanceForType, getDescriptorForType, getField, getInitializationErrorString, getOneofFieldDescriptor, getRepeatedField, getRepeatedFieldCount, getUnknownFields, hasField, hasOneof
-
Method Details
-
hasCheckIntervalSec
boolean hasCheckIntervalSec()How often (in seconds) to send a health check. The default value is 5 seconds.
optional int32 check_interval_sec = 345561006;- Returns:
- Whether the checkIntervalSec field is set.
-
getCheckIntervalSec
int getCheckIntervalSec()How often (in seconds) to send a health check. The default value is 5 seconds.
optional int32 check_interval_sec = 345561006;- Returns:
- The checkIntervalSec.
-
hasCreationTimestamp
boolean hasCreationTimestamp()Output only. [Output Only] Creation timestamp in3339 text format.
optional string creation_timestamp = 30525366;- Returns:
- Whether the creationTimestamp field is set.
-
getCreationTimestamp
String getCreationTimestamp()Output only. [Output Only] Creation timestamp in3339 text format.
optional string creation_timestamp = 30525366;- Returns:
- The creationTimestamp.
-
getCreationTimestampBytes
com.google.protobuf.ByteString getCreationTimestampBytes()Output only. [Output Only] Creation timestamp in3339 text format.
optional string creation_timestamp = 30525366;- Returns:
- The bytes for creationTimestamp.
-
hasDescription
boolean hasDescription()An optional description of this resource. Provide this property when you create the resource.
optional string description = 422937596;- Returns:
- Whether the description field is set.
-
getDescription
String getDescription()An optional description of this resource. Provide this property when you create the resource.
optional string description = 422937596;- Returns:
- The description.
-
getDescriptionBytes
com.google.protobuf.ByteString getDescriptionBytes()An optional description of this resource. Provide this property when you create the resource.
optional string description = 422937596;- Returns:
- The bytes for description.
-
hasGrpcHealthCheck
boolean hasGrpcHealthCheck()optional .google.cloud.compute.v1.GRPCHealthCheck grpc_health_check = 85529574;- Returns:
- Whether the grpcHealthCheck field is set.
-
getGrpcHealthCheck
GRPCHealthCheck getGrpcHealthCheck()optional .google.cloud.compute.v1.GRPCHealthCheck grpc_health_check = 85529574;- Returns:
- The grpcHealthCheck.
-
getGrpcHealthCheckOrBuilder
GRPCHealthCheckOrBuilder getGrpcHealthCheckOrBuilder()optional .google.cloud.compute.v1.GRPCHealthCheck grpc_health_check = 85529574; -
hasGrpcTlsHealthCheck
boolean hasGrpcTlsHealthCheck()optional .google.cloud.compute.v1.GRPCTLSHealthCheck grpc_tls_health_check = 267273258;- Returns:
- Whether the grpcTlsHealthCheck field is set.
-
getGrpcTlsHealthCheck
GRPCTLSHealthCheck getGrpcTlsHealthCheck()optional .google.cloud.compute.v1.GRPCTLSHealthCheck grpc_tls_health_check = 267273258;- Returns:
- The grpcTlsHealthCheck.
-
getGrpcTlsHealthCheckOrBuilder
GRPCTLSHealthCheckOrBuilder getGrpcTlsHealthCheckOrBuilder()optional .google.cloud.compute.v1.GRPCTLSHealthCheck grpc_tls_health_check = 267273258; -
hasHealthyThreshold
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:
- Whether the healthyThreshold field is set.
-
getHealthyThreshold
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:
- The healthyThreshold.
-
hasHttp2HealthCheck
boolean hasHttp2HealthCheck()optional .google.cloud.compute.v1.HTTP2HealthCheck http2_health_check = 11360986;- Returns:
- Whether the http2HealthCheck field is set.
-
getHttp2HealthCheck
HTTP2HealthCheck getHttp2HealthCheck()optional .google.cloud.compute.v1.HTTP2HealthCheck http2_health_check = 11360986;- Returns:
- The http2HealthCheck.
-
getHttp2HealthCheckOrBuilder
HTTP2HealthCheckOrBuilder getHttp2HealthCheckOrBuilder()optional .google.cloud.compute.v1.HTTP2HealthCheck http2_health_check = 11360986; -
hasHttpHealthCheck
boolean hasHttpHealthCheck()optional .google.cloud.compute.v1.HTTPHealthCheck http_health_check = 412586940;- Returns:
- Whether the httpHealthCheck field is set.
-
getHttpHealthCheck
HTTPHealthCheck getHttpHealthCheck()optional .google.cloud.compute.v1.HTTPHealthCheck http_health_check = 412586940;- Returns:
- The httpHealthCheck.
-
getHttpHealthCheckOrBuilder
HTTPHealthCheckOrBuilder getHttpHealthCheckOrBuilder()optional .google.cloud.compute.v1.HTTPHealthCheck http_health_check = 412586940; -
hasHttpsHealthCheck
boolean hasHttpsHealthCheck()optional .google.cloud.compute.v1.HTTPSHealthCheck https_health_check = 436046905;- Returns:
- Whether the httpsHealthCheck field is set.
-
getHttpsHealthCheck
HTTPSHealthCheck getHttpsHealthCheck()optional .google.cloud.compute.v1.HTTPSHealthCheck https_health_check = 436046905;- Returns:
- The httpsHealthCheck.
-
getHttpsHealthCheckOrBuilder
HTTPSHealthCheckOrBuilder getHttpsHealthCheckOrBuilder()optional .google.cloud.compute.v1.HTTPSHealthCheck https_health_check = 436046905; -
hasId
boolean hasId()[Output Only] The unique identifier for the resource. This identifier is defined by the server.
optional uint64 id = 3355;- Returns:
- Whether the id field is set.
-
getId
long getId()[Output Only] The unique identifier for the resource. This identifier is defined by the server.
optional uint64 id = 3355;- Returns:
- The id.
-
hasKind
boolean hasKind()Output only. Type of the resource.
optional string kind = 3292052;- Returns:
- Whether the kind field is set.
-
getKind
String getKind()Output only. Type of the resource.
optional string kind = 3292052;- Returns:
- The kind.
-
getKindBytes
com.google.protobuf.ByteString getKindBytes()Output only. Type of the resource.
optional string kind = 3292052;- Returns:
- The bytes for kind.
-
hasLogConfig
boolean hasLogConfig()Configure logging on this health check.
optional .google.cloud.compute.v1.HealthCheckLogConfig log_config = 351299741;- Returns:
- Whether the logConfig field is set.
-
getLogConfig
HealthCheckLogConfig getLogConfig()Configure logging on this health check.
optional .google.cloud.compute.v1.HealthCheckLogConfig log_config = 351299741;- Returns:
- The logConfig.
-
getLogConfigOrBuilder
HealthCheckLogConfigOrBuilder getLogConfigOrBuilder()Configure logging on this health check.
optional .google.cloud.compute.v1.HealthCheckLogConfig log_config = 351299741; -
hasName
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 withRFC1035. For example, a name that is 1-63 characters long, matches the regular expression `[a-z]([-a-z0-9]*[a-z0-9])?`, 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:
- Whether the name field is set.
-
getName
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 withRFC1035. For example, a name that is 1-63 characters long, matches the regular expression `[a-z]([-a-z0-9]*[a-z0-9])?`, 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:
- The name.
-
getNameBytes
com.google.protobuf.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 withRFC1035. For example, a name that is 1-63 characters long, matches the regular expression `[a-z]([-a-z0-9]*[a-z0-9])?`, 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:
- The bytes for name.
-
hasRegion
boolean hasRegion()Output only. [Output Only] Region where the health check resides. Not applicable to global health checks.
optional string region = 138946292;- Returns:
- Whether the region field is set.
-
getRegion
String getRegion()Output only. [Output Only] Region where the health check resides. Not applicable to global health checks.
optional string region = 138946292;- Returns:
- The region.
-
getRegionBytes
com.google.protobuf.ByteString getRegionBytes()Output only. [Output Only] Region where the health check resides. Not applicable to global health checks.
optional string region = 138946292;- Returns:
- The bytes for region.
-
hasSelfLink
boolean hasSelfLink()[Output Only] Server-defined URL for the resource.
optional string self_link = 456214797;- Returns:
- Whether the selfLink field is set.
-
getSelfLink
String getSelfLink()[Output Only] Server-defined URL for the resource.
optional string self_link = 456214797;- Returns:
- The selfLink.
-
getSelfLinkBytes
com.google.protobuf.ByteString getSelfLinkBytes()[Output Only] Server-defined URL for the resource.
optional string self_link = 456214797;- Returns:
- The bytes for selfLink.
-
getSourceRegionsList
The list of cloud regions from which health checks are performed. If any regions are specified, then exactly 3 regions should be specified. The region names must be valid names of Google Cloud regions. This can only be set for global health check. If this list is non-empty, then there are restrictions on what other health check fields are supported and what other resources can use this health check: - SSL, HTTP2, and GRPC protocols are not supported. - The TCP request field is not supported. - The proxyHeader field for HTTP, HTTPS, and TCP is not supported. - The checkIntervalSec field must be at least 30. - The health check cannot be used with BackendService nor with managed instance group auto-healing.
repeated string source_regions = 405568475;- Returns:
- A list containing the sourceRegions.
-
getSourceRegionsCount
int getSourceRegionsCount()The list of cloud regions from which health checks are performed. If any regions are specified, then exactly 3 regions should be specified. The region names must be valid names of Google Cloud regions. This can only be set for global health check. If this list is non-empty, then there are restrictions on what other health check fields are supported and what other resources can use this health check: - SSL, HTTP2, and GRPC protocols are not supported. - The TCP request field is not supported. - The proxyHeader field for HTTP, HTTPS, and TCP is not supported. - The checkIntervalSec field must be at least 30. - The health check cannot be used with BackendService nor with managed instance group auto-healing.
repeated string source_regions = 405568475;- Returns:
- The count of sourceRegions.
-
getSourceRegions
The list of cloud regions from which health checks are performed. If any regions are specified, then exactly 3 regions should be specified. The region names must be valid names of Google Cloud regions. This can only be set for global health check. If this list is non-empty, then there are restrictions on what other health check fields are supported and what other resources can use this health check: - SSL, HTTP2, and GRPC protocols are not supported. - The TCP request field is not supported. - The proxyHeader field for HTTP, HTTPS, and TCP is not supported. - The checkIntervalSec field must be at least 30. - The health check cannot be used with BackendService nor with managed instance group auto-healing.
repeated string source_regions = 405568475;- Parameters:
index- The index of the element to return.- Returns:
- The sourceRegions at the given index.
-
getSourceRegionsBytes
com.google.protobuf.ByteString getSourceRegionsBytes(int index) The list of cloud regions from which health checks are performed. If any regions are specified, then exactly 3 regions should be specified. The region names must be valid names of Google Cloud regions. This can only be set for global health check. If this list is non-empty, then there are restrictions on what other health check fields are supported and what other resources can use this health check: - SSL, HTTP2, and GRPC protocols are not supported. - The TCP request field is not supported. - The proxyHeader field for HTTP, HTTPS, and TCP is not supported. - The checkIntervalSec field must be at least 30. - The health check cannot be used with BackendService nor with managed instance group auto-healing.
repeated string source_regions = 405568475;- Parameters:
index- The index of the value to return.- Returns:
- The bytes of the sourceRegions at the given index.
-
hasSslHealthCheck
boolean hasSslHealthCheck()optional .google.cloud.compute.v1.SSLHealthCheck ssl_health_check = 280032440;- Returns:
- Whether the sslHealthCheck field is set.
-
getSslHealthCheck
SSLHealthCheck getSslHealthCheck()optional .google.cloud.compute.v1.SSLHealthCheck ssl_health_check = 280032440;- Returns:
- The sslHealthCheck.
-
getSslHealthCheckOrBuilder
SSLHealthCheckOrBuilder getSslHealthCheckOrBuilder()optional .google.cloud.compute.v1.SSLHealthCheck ssl_health_check = 280032440; -
hasTcpHealthCheck
boolean hasTcpHealthCheck()optional .google.cloud.compute.v1.TCPHealthCheck tcp_health_check = 469980419;- Returns:
- Whether the tcpHealthCheck field is set.
-
getTcpHealthCheck
TCPHealthCheck getTcpHealthCheck()optional .google.cloud.compute.v1.TCPHealthCheck tcp_health_check = 469980419;- Returns:
- The tcpHealthCheck.
-
getTcpHealthCheckOrBuilder
TCPHealthCheckOrBuilder getTcpHealthCheckOrBuilder()optional .google.cloud.compute.v1.TCPHealthCheck tcp_health_check = 469980419; -
hasTimeoutSec
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:
- Whether the timeoutSec field is set.
-
getTimeoutSec
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:
- The timeoutSec.
-
hasType
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 matchtype field. Check the Type enum for the list of possible values.
optional string type = 3575610;- Returns:
- Whether the type field is set.
-
getType
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 matchtype field. Check the Type enum for the list of possible values.
optional string type = 3575610;- Returns:
- The type.
-
getTypeBytes
com.google.protobuf.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 matchtype field. Check the Type enum for the list of possible values.
optional string type = 3575610;- Returns:
- The bytes for type.
-
hasUnhealthyThreshold
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:
- Whether the unhealthyThreshold field is set.
-
getUnhealthyThreshold
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:
- The unhealthyThreshold.
-