Package com.google.appengine.v1

Class ReadinessCheck

  • All Implemented Interfaces:
    ReadinessCheckOrBuilder, com.google.protobuf.Message, com.google.protobuf.MessageLite, com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder, Serializable
    public final class ReadinessCheck
extends com.google.protobuf.GeneratedMessageV3
implements ReadinessCheckOrBuilder
     Readiness checking configuration for VM instances. Unhealthy instances
 are removed from traffic rotation.
    Protobuf type google.appengine.v1.ReadinessCheck
    See Also:
    Serialized Form

    • Nested Class Summary

      Nested Classes 
      Modifier and Type Class Description
      static class  ReadinessCheck.Builder
      Readiness 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

    • Method Summary

      All Methods Static Methods Instance Methods Concrete Methods 
      Modifier and Type Method Description
      boolean equals​(Object obj)  
      com.google.protobuf.Duration getAppStartTimeout()
      A maximum time limit on application initialization, measured from moment the application successfully replies to a healthcheck until it is ready to serve traffic.
      com.google.protobuf.DurationOrBuilder getAppStartTimeoutOrBuilder()
      A maximum time limit on application initialization, measured from moment the application successfully replies to a healthcheck until it is ready to serve traffic.
      com.google.protobuf.Duration getCheckInterval()
      Interval between health checks.
      com.google.protobuf.DurationOrBuilder getCheckIntervalOrBuilder()
      Interval between health checks.
      static ReadinessCheck getDefaultInstance()  
      ReadinessCheck getDefaultInstanceForType()  
      static com.google.protobuf.Descriptors.Descriptor getDescriptor()  
      int getFailureThreshold()
      Number of consecutive failed checks required before removing traffic.
      String getHost()
      Host header to send when performing a HTTP Readiness check.
      com.google.protobuf.ByteString getHostBytes()
      Host header to send when performing a HTTP Readiness check.
      com.google.protobuf.Parser<ReadinessCheck> getParserForType()  
      String getPath()
      The request path.
      com.google.protobuf.ByteString getPathBytes()
      The request path.
      int getSerializedSize()  
      int getSuccessThreshold()
      Number of consecutive successful checks required before receiving traffic.
      com.google.protobuf.Duration getTimeout()
      Time before the check is considered failed.
      com.google.protobuf.DurationOrBuilder getTimeoutOrBuilder()
      Time before the check is considered failed.
      boolean hasAppStartTimeout()
      A maximum time limit on application initialization, measured from moment the application successfully replies to a healthcheck until it is ready to serve traffic.
      boolean hasCheckInterval()
      Interval between health checks.
      int hashCode()  
      boolean hasTimeout()
      Time before the check is considered failed.
      protected com.google.protobuf.GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()  
      boolean isInitialized()  
      static ReadinessCheck.Builder newBuilder()  
      static ReadinessCheck.Builder newBuilder​(ReadinessCheck prototype)  
      ReadinessCheck.Builder newBuilderForType()  
      protected ReadinessCheck.Builder newBuilderForType​(com.google.protobuf.GeneratedMessageV3.BuilderParent parent)  
      protected Object newInstance​(com.google.protobuf.GeneratedMessageV3.UnusedPrivateParameter unused)  
      static ReadinessCheck parseDelimitedFrom​(InputStream input)  
      static ReadinessCheck parseDelimitedFrom​(InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry)  
      static ReadinessCheck parseFrom​(byte[] data)  
      static ReadinessCheck parseFrom​(byte[] data, com.google.protobuf.ExtensionRegistryLite extensionRegistry)  
      static ReadinessCheck parseFrom​(com.google.protobuf.ByteString data)  
      static ReadinessCheck parseFrom​(com.google.protobuf.ByteString data, com.google.protobuf.ExtensionRegistryLite extensionRegistry)  
      static ReadinessCheck parseFrom​(com.google.protobuf.CodedInputStream input)  
      static ReadinessCheck parseFrom​(com.google.protobuf.CodedInputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry)  
      static ReadinessCheck parseFrom​(InputStream input)  
      static ReadinessCheck parseFrom​(InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry)  
      static ReadinessCheck parseFrom​(ByteBuffer data)  
      static ReadinessCheck parseFrom​(ByteBuffer data, com.google.protobuf.ExtensionRegistryLite extensionRegistry)  
      static com.google.protobuf.Parser<ReadinessCheck> parser()  
      ReadinessCheck.Builder toBuilder()  
      void writeTo​(com.google.protobuf.CodedOutputStream output)  

      • Methods inherited from class com.google.protobuf.GeneratedMessageV3

        canUseUnsafe, computeStringSize, computeStringSizeNoTag, emptyBooleanList, emptyDoubleList, emptyFloatList, emptyIntList, emptyLongList, getAllFields, getDescriptorForType, getField, getOneofFieldDescriptor, getRepeatedField, getRepeatedFieldCount, getUnknownFields, hasField, hasOneof, internalGetMapField, isStringEmpty, makeExtensionsImmutable, makeMutableCopy, mergeFromAndMakeImmutableInternal, mutableCopy, mutableCopy, mutableCopy, mutableCopy, mutableCopy, newBooleanList, newBuilderForType, newDoubleList, newFloatList, newIntList, newLongList, parseDelimitedWithIOException, parseDelimitedWithIOException, parseUnknownField, parseUnknownFieldProto3, parseWithIOException, parseWithIOException, parseWithIOException, parseWithIOException, serializeBooleanMapTo, serializeIntegerMapTo, serializeLongMapTo, serializeStringMapTo, writeReplace, writeString, writeStringNoTag

      • Methods inherited from class com.google.protobuf.AbstractMessage

        findInitializationErrors, getInitializationErrorString, hashBoolean, hashEnum, hashEnumList, hashFields, hashLong, toString

      • Methods inherited from class com.google.protobuf.AbstractMessageLite

        addAll, addAll, checkByteStringIsUtf8, toByteArray, toByteString, writeDelimitedTo, writeTo

      • Methods inherited from interface com.google.protobuf.MessageLite

        toByteArray, toByteString, writeDelimitedTo, writeTo

      • Methods inherited from interface com.google.protobuf.MessageOrBuilder

        findInitializationErrors, getAllFields, getDescriptorForType, getField, getInitializationErrorString, getOneofFieldDescriptor, getRepeatedField, getRepeatedFieldCount, getUnknownFields, hasField, hasOneof

    • 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

      • getPathBytes

        public com.google.protobuf.ByteString getPathBytes()
         The request path.
        string path = 1;
        Specified by:
        getPathBytes in interface ReadinessCheckOrBuilder
        Returns:
        The bytes for path.

      • getHost

        public String getHost()
         Host header to send when performing a HTTP Readiness check.
 Example: "myapp.appspot.com"
        string host = 2;
        Specified by:
        getHost in interface ReadinessCheckOrBuilder
        Returns:
        The host.

      • getHostBytes

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

      • getFailureThreshold

        public int getFailureThreshold()
         Number of consecutive failed checks required before removing
 traffic.
        uint32 failure_threshold = 3;
        Specified by:
        getFailureThreshold in interface ReadinessCheckOrBuilder
        Returns:
        The failureThreshold.

      • getSuccessThreshold

        public int getSuccessThreshold()
         Number of consecutive successful checks required before receiving
 traffic.
        uint32 success_threshold = 4;
        Specified by:
        getSuccessThreshold in interface ReadinessCheckOrBuilder
        Returns:
        The successThreshold.

      • hasCheckInterval

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

      • getCheckInterval

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

      • getCheckIntervalOrBuilder

        public com.google.protobuf.DurationOrBuilder getCheckIntervalOrBuilder()
         Interval between health checks.
        .google.protobuf.Duration check_interval = 5;
        Specified by:
        getCheckIntervalOrBuilder in interface ReadinessCheckOrBuilder

      • hasTimeout

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

      • getTimeout

        public com.google.protobuf.Duration getTimeout()
         Time before the check is considered failed.
        .google.protobuf.Duration timeout = 6;
        Specified by:
        getTimeout in interface ReadinessCheckOrBuilder
        Returns:
        The timeout.

      • getTimeoutOrBuilder

        public com.google.protobuf.DurationOrBuilder getTimeoutOrBuilder()
         Time before the check is considered failed.
        .google.protobuf.Duration timeout = 6;
        Specified by:
        getTimeoutOrBuilder in interface ReadinessCheckOrBuilder

      • hasAppStartTimeout

        public boolean hasAppStartTimeout()
         A maximum time limit on application initialization, measured from moment
 the application successfully replies to a healthcheck until it is ready to
 serve traffic.
        .google.protobuf.Duration app_start_timeout = 7;
        Specified by:
        hasAppStartTimeout in interface ReadinessCheckOrBuilder
        Returns:
        Whether the appStartTimeout field is set.

      • getAppStartTimeout

        public com.google.protobuf.Duration getAppStartTimeout()
         A maximum time limit on application initialization, measured from moment
 the application successfully replies to a healthcheck until it is ready to
 serve traffic.
        .google.protobuf.Duration app_start_timeout = 7;
        Specified by:
        getAppStartTimeout in interface ReadinessCheckOrBuilder
        Returns:
        The appStartTimeout.

      • getAppStartTimeoutOrBuilder

        public com.google.protobuf.DurationOrBuilder getAppStartTimeoutOrBuilder()
         A maximum time limit on application initialization, measured from moment
 the application successfully replies to a healthcheck until it is ready to
 serve traffic.
        .google.protobuf.Duration app_start_timeout = 7;
        Specified by:
        getAppStartTimeoutOrBuilder in interface ReadinessCheckOrBuilder

      • 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 ReadinessCheck parseFrom​(ByteBuffer data)
                                throws com.google.protobuf.InvalidProtocolBufferException
        Throws:
        com.google.protobuf.InvalidProtocolBufferException

      • parseFrom

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

      • parseFrom

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

      • parseFrom

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

      • parseFrom

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

      • parseFrom

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

      • parseFrom

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

      • newBuilderForType

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

      • toBuilder

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

      • newBuilderForType

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

      • getDefaultInstance

        public static ReadinessCheck getDefaultInstance()

      • parser

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

      • getParserForType

        public com.google.protobuf.Parser<ReadinessCheck> 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 ReadinessCheck getDefaultInstanceForType()
        Specified by:
        getDefaultInstanceForType in interface com.google.protobuf.MessageLiteOrBuilder
        Specified by:
        getDefaultInstanceForType in interface com.google.protobuf.MessageOrBuilder