Package com.google.cloud.compute.v1

Class HealthCheck

  • All Implemented Interfaces:
    HealthCheckOrBuilder, com.google.protobuf.Message, com.google.protobuf.MessageLite, com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder, Serializable
    public final class HealthCheck
extends com.google.protobuf.GeneratedMessageV3
implements HealthCheckOrBuilder
     Represents a Health Check resource. Google Compute Engine has two Health Check resources: * [Global](/compute/docs/reference/rest/v1/healthChecks) * [Regional](/compute/docs/reference/rest/v1/regionHealthChecks) 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
    See Also:
    Serialized Form

    • Field Detail

      • CHECK_INTERVAL_SEC_FIELD_NUMBER

        public static final int CHECK_INTERVAL_SEC_FIELD_NUMBER
        See Also:
        Constant Field Values

      • CREATION_TIMESTAMP_FIELD_NUMBER

        public static final int CREATION_TIMESTAMP_FIELD_NUMBER
        See Also:
        Constant Field Values

      • DESCRIPTION_FIELD_NUMBER

        public static final int DESCRIPTION_FIELD_NUMBER
        See Also:
        Constant Field Values

      • GRPC_HEALTH_CHECK_FIELD_NUMBER

        public static final int GRPC_HEALTH_CHECK_FIELD_NUMBER
        See Also:
        Constant Field Values

      • HEALTHY_THRESHOLD_FIELD_NUMBER

        public static final int HEALTHY_THRESHOLD_FIELD_NUMBER
        See Also:
        Constant Field Values

      • HTTP2_HEALTH_CHECK_FIELD_NUMBER

        public static final int HTTP2_HEALTH_CHECK_FIELD_NUMBER
        See Also:
        Constant Field Values

      • HTTP_HEALTH_CHECK_FIELD_NUMBER

        public static final int HTTP_HEALTH_CHECK_FIELD_NUMBER
        See Also:
        Constant Field Values

      • HTTPS_HEALTH_CHECK_FIELD_NUMBER

        public static final int HTTPS_HEALTH_CHECK_FIELD_NUMBER
        See Also:
        Constant Field Values

      • LOG_CONFIG_FIELD_NUMBER

        public static final int LOG_CONFIG_FIELD_NUMBER
        See Also:
        Constant Field Values

      • SSL_HEALTH_CHECK_FIELD_NUMBER

        public static final int SSL_HEALTH_CHECK_FIELD_NUMBER
        See Also:
        Constant Field Values

      • TCP_HEALTH_CHECK_FIELD_NUMBER

        public static final int TCP_HEALTH_CHECK_FIELD_NUMBER
        See Also:
        Constant Field Values

      • TIMEOUT_SEC_FIELD_NUMBER

        public static final int TIMEOUT_SEC_FIELD_NUMBER
        See Also:
        Constant Field Values

      • UNHEALTHY_THRESHOLD_FIELD_NUMBER

        public static final int UNHEALTHY_THRESHOLD_FIELD_NUMBER
        See Also:
        Constant Field Values

    • Method Detail

      • newInstance

        protected Object newInstance​(com.google.protobuf.GeneratedMessageV3.UnusedPrivateParameter unused)
        Overrides:
        newInstance in class com.google.protobuf.GeneratedMessageV3

      • getDescriptor

        public static final com.google.protobuf.Descriptors.Descriptor getDescriptor()

      • internalGetFieldAccessorTable

        protected com.google.protobuf.GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
        Specified by:
        internalGetFieldAccessorTable in class com.google.protobuf.GeneratedMessageV3

      • 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;
        Specified by:
        hasCheckIntervalSec in interface HealthCheckOrBuilder
        Returns:
        Whether the checkIntervalSec field is set.

      • 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;
        Specified by:
        getCheckIntervalSec in interface HealthCheckOrBuilder
        Returns:
        The checkIntervalSec.

      • hasCreationTimestamp

        public boolean hasCreationTimestamp()
         [Output Only] Creation timestamp in 3339 text format.
        optional string creation_timestamp = 30525366;
        Specified by:
        hasCreationTimestamp in interface HealthCheckOrBuilder
        Returns:
        Whether the creationTimestamp field is set.

      • getCreationTimestamp

        public String getCreationTimestamp()
         [Output Only] Creation timestamp in 3339 text format.
        optional string creation_timestamp = 30525366;
        Specified by:
        getCreationTimestamp in interface HealthCheckOrBuilder
        Returns:
        The creationTimestamp.

      • getCreationTimestampBytes

        public com.google.protobuf.ByteString getCreationTimestampBytes()
         [Output Only] Creation timestamp in 3339 text format.
        optional string creation_timestamp = 30525366;
        Specified by:
        getCreationTimestampBytes in interface HealthCheckOrBuilder
        Returns:
        The bytes for creationTimestamp.

      • hasDescription

        public boolean hasDescription()
         An optional description of this resource. Provide this property when you create the resource.
        optional string description = 422937596;
        Specified by:
        hasDescription in interface HealthCheckOrBuilder
        Returns:
        Whether the description field is set.

      • getDescription

        public String getDescription()
         An optional description of this resource. Provide this property when you create the resource.
        optional string description = 422937596;
        Specified by:
        getDescription in interface HealthCheckOrBuilder
        Returns:
        The description.

      • getDescriptionBytes

        public com.google.protobuf.ByteString getDescriptionBytes()
         An optional description of this resource. Provide this property when you create the resource.
        optional string description = 422937596;
        Specified by:
        getDescriptionBytes in interface HealthCheckOrBuilder
        Returns:
        The bytes for description.

      • hasGrpcHealthCheck

        public boolean hasGrpcHealthCheck()
        optional .google.cloud.compute.v1.GRPCHealthCheck grpc_health_check = 85529574;
        Specified by:
        hasGrpcHealthCheck in interface HealthCheckOrBuilder
        Returns:
        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;
        Specified by:
        hasHealthyThreshold in interface HealthCheckOrBuilder
        Returns:
        Whether the healthyThreshold field is set.

      • 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;
        Specified by:
        getHealthyThreshold in interface HealthCheckOrBuilder
        Returns:
        The healthyThreshold.

      • hasHttp2HealthCheck

        public boolean hasHttp2HealthCheck()
        optional .google.cloud.compute.v1.HTTP2HealthCheck http2_health_check = 11360986;
        Specified by:
        hasHttp2HealthCheck in interface HealthCheckOrBuilder
        Returns:
        Whether the http2HealthCheck field is set.

      • hasHttpHealthCheck

        public boolean hasHttpHealthCheck()
        optional .google.cloud.compute.v1.HTTPHealthCheck http_health_check = 412586940;
        Specified by:
        hasHttpHealthCheck in interface HealthCheckOrBuilder
        Returns:
        Whether the httpHealthCheck field is set.

      • hasHttpsHealthCheck

        public boolean hasHttpsHealthCheck()
        optional .google.cloud.compute.v1.HTTPSHealthCheck https_health_check = 436046905;
        Specified by:
        hasHttpsHealthCheck in interface HealthCheckOrBuilder
        Returns:
        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;
        Specified by:
        hasId in interface HealthCheckOrBuilder
        Returns:
        Whether the id field is set.

      • getId

        public long getId()
         [Output Only] The unique identifier for the resource. This identifier is defined by the server.
        optional uint64 id = 3355;
        Specified by:
        getId in interface HealthCheckOrBuilder
        Returns:
        The id.

      • hasKind

        public boolean hasKind()
         Type of the resource.
        optional string kind = 3292052;
        Specified by:
        hasKind in interface HealthCheckOrBuilder
        Returns:
        Whether the kind field is set.

      • getKind

        public String getKind()
         Type of the resource.
        optional string kind = 3292052;
        Specified by:
        getKind in interface HealthCheckOrBuilder
        Returns:
        The kind.

      • getKindBytes

        public com.google.protobuf.ByteString getKindBytes()
         Type of the resource.
        optional string kind = 3292052;
        Specified by:
        getKindBytes in interface HealthCheckOrBuilder
        Returns:
        The bytes for kind.

      • hasLogConfig

        public boolean hasLogConfig()
         Configure logging on this health check.
        optional .google.cloud.compute.v1.HealthCheckLogConfig log_config = 351299741;
        Specified by:
        hasLogConfig in interface HealthCheckOrBuilder
        Returns:
        Whether the logConfig field is set.

      • getLogConfig

        public HealthCheckLogConfig getLogConfig()
         Configure logging on this health check.
        optional .google.cloud.compute.v1.HealthCheckLogConfig log_config = 351299741;
        Specified by:
        getLogConfig in interface HealthCheckOrBuilder
        Returns:
        The logConfig.

      • 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]([-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;
        Specified by:
        hasName in interface HealthCheckOrBuilder
        Returns:
        Whether the name field is set.

      • 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]([-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;
        Specified by:
        getName in interface HealthCheckOrBuilder
        Returns:
        The name.

      • getNameBytes

        public 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 with RFC1035. 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;
        Specified by:
        getNameBytes in interface HealthCheckOrBuilder
        Returns:
        The bytes for name.

      • hasRegion

        public boolean hasRegion()
         [Output Only] Region where the health check resides. Not applicable to global health checks.
        optional string region = 138946292;
        Specified by:
        hasRegion in interface HealthCheckOrBuilder
        Returns:
        Whether the region field is set.

      • getRegion

        public String getRegion()
         [Output Only] Region where the health check resides. Not applicable to global health checks.
        optional string region = 138946292;
        Specified by:
        getRegion in interface HealthCheckOrBuilder
        Returns:
        The region.

      • getRegionBytes

        public com.google.protobuf.ByteString getRegionBytes()
         [Output Only] Region where the health check resides. Not applicable to global health checks.
        optional string region = 138946292;
        Specified by:
        getRegionBytes in interface HealthCheckOrBuilder
        Returns:
        The bytes for region.

      • hasSelfLink

        public boolean hasSelfLink()
         [Output Only] Server-defined URL for the resource.
        optional string self_link = 456214797;
        Specified by:
        hasSelfLink in interface HealthCheckOrBuilder
        Returns:
        Whether the selfLink field is set.

      • getSelfLink

        public String getSelfLink()
         [Output Only] Server-defined URL for the resource.
        optional string self_link = 456214797;
        Specified by:
        getSelfLink in interface HealthCheckOrBuilder
        Returns:
        The selfLink.

      • getSelfLinkBytes

        public com.google.protobuf.ByteString getSelfLinkBytes()
         [Output Only] Server-defined URL for the resource.
        optional string self_link = 456214797;
        Specified by:
        getSelfLinkBytes in interface HealthCheckOrBuilder
        Returns:
        The bytes for selfLink.

      • hasSslHealthCheck

        public boolean hasSslHealthCheck()
        optional .google.cloud.compute.v1.SSLHealthCheck ssl_health_check = 280032440;
        Specified by:
        hasSslHealthCheck in interface HealthCheckOrBuilder
        Returns:
        Whether the sslHealthCheck field is set.

      • hasTcpHealthCheck

        public boolean hasTcpHealthCheck()
        optional .google.cloud.compute.v1.TCPHealthCheck tcp_health_check = 469980419;
        Specified by:
        hasTcpHealthCheck in interface HealthCheckOrBuilder
        Returns:
        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;
        Specified by:
        hasTimeoutSec in interface HealthCheckOrBuilder
        Returns:
        Whether the timeoutSec field is set.

      • 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;
        Specified by:
        getTimeoutSec in interface HealthCheckOrBuilder
        Returns:
        The timeoutSec.

      • 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;
        Specified by:
        hasType in interface HealthCheckOrBuilder
        Returns:
        Whether the type field is set.

      • 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;
        Specified by:
        getType in interface HealthCheckOrBuilder
        Returns:
        The type.

      • getTypeBytes

        public 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 match type field.
 Check the Type enum for the list of possible values.
        optional string type = 3575610;
        Specified by:
        getTypeBytes in interface HealthCheckOrBuilder
        Returns:
        The bytes for type.

      • 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;
        Specified by:
        hasUnhealthyThreshold in interface HealthCheckOrBuilder
        Returns:
        Whether the unhealthyThreshold field is set.

      • 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;
        Specified by:
        getUnhealthyThreshold in interface HealthCheckOrBuilder
        Returns:
        The unhealthyThreshold.

      • isInitialized

        public final boolean isInitialized()
        Specified by:
        isInitialized in interface com.google.protobuf.MessageLiteOrBuilder
        Overrides:
        isInitialized in class com.google.protobuf.GeneratedMessageV3

      • writeTo

        public void writeTo​(com.google.protobuf.CodedOutputStream output)
             throws IOException
        Specified by:
        writeTo in interface com.google.protobuf.MessageLite
        Overrides:
        writeTo in class com.google.protobuf.GeneratedMessageV3
        Throws:
        IOException

      • getSerializedSize

        public int getSerializedSize()
        Specified by:
        getSerializedSize in interface com.google.protobuf.MessageLite
        Overrides:
        getSerializedSize in class com.google.protobuf.GeneratedMessageV3

      • equals

        public boolean equals​(Object obj)
        Specified by:
        equals in interface com.google.protobuf.Message
        Overrides:
        equals in class com.google.protobuf.AbstractMessage

      • hashCode

        public int hashCode()
        Specified by:
        hashCode in interface com.google.protobuf.Message
        Overrides:
        hashCode in class com.google.protobuf.AbstractMessage

      • parseFrom

        public static HealthCheck parseFrom​(ByteBuffer data)
                             throws com.google.protobuf.InvalidProtocolBufferException
        Throws:
        com.google.protobuf.InvalidProtocolBufferException

      • parseFrom

        public static HealthCheck parseFrom​(ByteBuffer data,
                                    com.google.protobuf.ExtensionRegistryLite extensionRegistry)
                             throws com.google.protobuf.InvalidProtocolBufferException
        Throws:
        com.google.protobuf.InvalidProtocolBufferException

      • parseFrom

        public static HealthCheck parseFrom​(com.google.protobuf.ByteString data)
                             throws com.google.protobuf.InvalidProtocolBufferException
        Throws:
        com.google.protobuf.InvalidProtocolBufferException

      • parseFrom

        public static HealthCheck parseFrom​(com.google.protobuf.ByteString data,
                                    com.google.protobuf.ExtensionRegistryLite extensionRegistry)
                             throws com.google.protobuf.InvalidProtocolBufferException
        Throws:
        com.google.protobuf.InvalidProtocolBufferException

      • parseFrom

        public static HealthCheck parseFrom​(byte[] data)
                             throws com.google.protobuf.InvalidProtocolBufferException
        Throws:
        com.google.protobuf.InvalidProtocolBufferException

      • parseFrom

        public static HealthCheck parseFrom​(byte[] data,
                                    com.google.protobuf.ExtensionRegistryLite extensionRegistry)
                             throws com.google.protobuf.InvalidProtocolBufferException
        Throws:
        com.google.protobuf.InvalidProtocolBufferException

      • parseFrom

        public static HealthCheck parseFrom​(com.google.protobuf.CodedInputStream input,
                                    com.google.protobuf.ExtensionRegistryLite extensionRegistry)
                             throws IOException
        Throws:
        IOException

      • newBuilderForType

        public HealthCheck.Builder newBuilderForType()
        Specified by:
        newBuilderForType in interface com.google.protobuf.Message
        Specified by:
        newBuilderForType in interface com.google.protobuf.MessageLite

      • toBuilder

        public HealthCheck.Builder toBuilder()
        Specified by:
        toBuilder in interface com.google.protobuf.Message
        Specified by:
        toBuilder in interface com.google.protobuf.MessageLite

      • newBuilderForType

        protected HealthCheck.Builder newBuilderForType​(com.google.protobuf.GeneratedMessageV3.BuilderParent parent)
        Specified by:
        newBuilderForType in class com.google.protobuf.GeneratedMessageV3

      • getDefaultInstance

        public static HealthCheck getDefaultInstance()

      • parser

        public static com.google.protobuf.Parser<HealthCheck> parser()

      • getParserForType

        public com.google.protobuf.Parser<HealthCheck> getParserForType()
        Specified by:
        getParserForType in interface com.google.protobuf.Message
        Specified by:
        getParserForType in interface com.google.protobuf.MessageLite
        Overrides:
        getParserForType in class com.google.protobuf.GeneratedMessageV3

      • getDefaultInstanceForType

        public HealthCheck getDefaultInstanceForType()
        Specified by:
        getDefaultInstanceForType in interface com.google.protobuf.MessageLiteOrBuilder
        Specified by:
        getDefaultInstanceForType in interface com.google.protobuf.MessageOrBuilder