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
     Health checking configuration for VM instances. Unhealthy instances
     are killed and replaced with new instances. Only applicable for
     instances in App Engine flexible environment.
     
    Protobuf type google.appengine.v1.HealthCheck
    See Also:
    Serialized Form
    • Nested Class Summary

      Nested Classes 
      Modifier and Type Class Description
      static class  HealthCheck.Builder
      Health checking configuration for VM instances.
      • Nested classes/interfaces inherited from class com.google.protobuf.GeneratedMessageV3

        com.google.protobuf.GeneratedMessageV3.BuilderParent, com.google.protobuf.GeneratedMessageV3.ExtendableBuilder<MessageT extends com.google.protobuf.GeneratedMessageV3.ExtendableMessage<MessageT>,​BuilderT extends com.google.protobuf.GeneratedMessageV3.ExtendableBuilder<MessageT,​BuilderT>>, com.google.protobuf.GeneratedMessageV3.ExtendableMessage<MessageT extends com.google.protobuf.GeneratedMessageV3.ExtendableMessage<MessageT>>, com.google.protobuf.GeneratedMessageV3.ExtendableMessageOrBuilder<MessageT extends com.google.protobuf.GeneratedMessageV3.ExtendableMessage<MessageT>>, com.google.protobuf.GeneratedMessageV3.FieldAccessorTable, com.google.protobuf.GeneratedMessageV3.UnusedPrivateParameter
      • Nested classes/interfaces inherited from class com.google.protobuf.AbstractMessageLite

        com.google.protobuf.AbstractMessageLite.InternalOneOfEnum
    • Field Detail

      • DISABLE_HEALTH_CHECK_FIELD_NUMBER

        public static final int DISABLE_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
      • UNHEALTHY_THRESHOLD_FIELD_NUMBER

        public static final int UNHEALTHY_THRESHOLD_FIELD_NUMBER
        See Also:
        Constant Field Values
      • RESTART_THRESHOLD_FIELD_NUMBER

        public static final int RESTART_THRESHOLD_FIELD_NUMBER
        See Also:
        Constant Field Values
      • CHECK_INTERVAL_FIELD_NUMBER

        public static final int CHECK_INTERVAL_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
      • getDisableHealthCheck

        public boolean getDisableHealthCheck()
         Whether to explicitly disable health checks for this instance.
         
        bool disable_health_check = 1;
        Specified by:
        getDisableHealthCheck in interface HealthCheckOrBuilder
        Returns:
        The disableHealthCheck.
      • getHost

        public String getHost()
         Host header to send when performing an HTTP health check.
         Example: "myapp.appspot.com"
         
        string host = 2;
        Specified by:
        getHost in interface HealthCheckOrBuilder
        Returns:
        The host.
      • getHostBytes

        public com.google.protobuf.ByteString getHostBytes()
         Host header to send when performing an HTTP health check.
         Example: "myapp.appspot.com"
         
        string host = 2;
        Specified by:
        getHostBytes in interface HealthCheckOrBuilder
        Returns:
        The bytes for host.
      • getHealthyThreshold

        public int getHealthyThreshold()
         Number of consecutive successful health checks required before receiving
         traffic.
         
        uint32 healthy_threshold = 3;
        Specified by:
        getHealthyThreshold in interface HealthCheckOrBuilder
        Returns:
        The healthyThreshold.
      • getUnhealthyThreshold

        public int getUnhealthyThreshold()
         Number of consecutive failed health checks required before removing
         traffic.
         
        uint32 unhealthy_threshold = 4;
        Specified by:
        getUnhealthyThreshold in interface HealthCheckOrBuilder
        Returns:
        The unhealthyThreshold.
      • getRestartThreshold

        public int getRestartThreshold()
         Number of consecutive failed health checks required before an instance is
         restarted.
         
        uint32 restart_threshold = 5;
        Specified by:
        getRestartThreshold in interface HealthCheckOrBuilder
        Returns:
        The restartThreshold.
      • hasCheckInterval

        public boolean hasCheckInterval()
         Interval between health checks.
         
        .google.protobuf.Duration check_interval = 6;
        Specified by:
        hasCheckInterval in interface HealthCheckOrBuilder
        Returns:
        Whether the checkInterval field is set.
      • getCheckInterval

        public com.google.protobuf.Duration getCheckInterval()
         Interval between health checks.
         
        .google.protobuf.Duration check_interval = 6;
        Specified by:
        getCheckInterval in interface HealthCheckOrBuilder
        Returns:
        The checkInterval.
      • getCheckIntervalOrBuilder

        public com.google.protobuf.DurationOrBuilder getCheckIntervalOrBuilder()
         Interval between health checks.
         
        .google.protobuf.Duration check_interval = 6;
        Specified by:
        getCheckIntervalOrBuilder in interface HealthCheckOrBuilder
      • hasTimeout

        public boolean hasTimeout()
         Time before the health check is considered failed.
         
        .google.protobuf.Duration timeout = 7;
        Specified by:
        hasTimeout in interface HealthCheckOrBuilder
        Returns:
        Whether the timeout field is set.
      • getTimeout

        public com.google.protobuf.Duration getTimeout()
         Time before the health check is considered failed.
         
        .google.protobuf.Duration timeout = 7;
        Specified by:
        getTimeout in interface HealthCheckOrBuilder
        Returns:
        The timeout.
      • getTimeoutOrBuilder

        public com.google.protobuf.DurationOrBuilder getTimeoutOrBuilder()
         Time before the health check is considered failed.
         
        .google.protobuf.Duration timeout = 7;
        Specified by:
        getTimeoutOrBuilder in interface HealthCheckOrBuilder
      • 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