Package com.google.cloud.run.v2

Class Probe

  • All Implemented Interfaces:
    ProbeOrBuilder, com.google.protobuf.Message, com.google.protobuf.MessageLite, com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder, Serializable
    public final class Probe
extends com.google.protobuf.GeneratedMessageV3
implements ProbeOrBuilder
     Probe describes a health check to be performed against a container to
 determine whether it is alive or ready to receive traffic.
    Protobuf type google.cloud.run.v2.Probe
    See Also:
    Serialized Form

    • Nested Class Summary

      Nested Classes 
      Modifier and Type Class Description
      static class  Probe.Builder
      Probe describes a health check to be performed against a container to determine whether it is alive or ready to receive traffic.
      static class  Probe.ProbeTypeCase  

      • 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

      • INITIAL_DELAY_SECONDS_FIELD_NUMBER

        public static final int INITIAL_DELAY_SECONDS_FIELD_NUMBER
        See Also:
        Constant Field Values

      • TIMEOUT_SECONDS_FIELD_NUMBER

        public static final int TIMEOUT_SECONDS_FIELD_NUMBER
        See Also:
        Constant Field Values

      • PERIOD_SECONDS_FIELD_NUMBER

        public static final int PERIOD_SECONDS_FIELD_NUMBER
        See Also:
        Constant Field Values

      • FAILURE_THRESHOLD_FIELD_NUMBER

        public static final int FAILURE_THRESHOLD_FIELD_NUMBER
        See Also:
        Constant Field Values

      • TCP_SOCKET_FIELD_NUMBER

        public static final int TCP_SOCKET_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

      • getInitialDelaySeconds

        public int getInitialDelaySeconds()
         Number of seconds after the container has started before the probe is
 initiated.
 Defaults to 0 seconds. Minimum value is 0. Maximum value for liveness probe
 is 3600. Maximum value for startup probe is 240.
        int32 initial_delay_seconds = 1;
        Specified by:
        getInitialDelaySeconds in interface ProbeOrBuilder
        Returns:
        The initialDelaySeconds.

      • getTimeoutSeconds

        public int getTimeoutSeconds()
         Number of seconds after which the probe times out.
 Defaults to 1 second. Minimum value is 1. Maximum value is 3600.
 Must be smaller than period_seconds.
        int32 timeout_seconds = 2;
        Specified by:
        getTimeoutSeconds in interface ProbeOrBuilder
        Returns:
        The timeoutSeconds.

      • getPeriodSeconds

        public int getPeriodSeconds()
         How often (in seconds) to perform the probe.
 Default to 10 seconds. Minimum value is 1. Maximum value for liveness probe
 is 3600. Maximum value for startup probe is 240.
 Must be greater or equal than timeout_seconds.
        int32 period_seconds = 3;
        Specified by:
        getPeriodSeconds in interface ProbeOrBuilder
        Returns:
        The periodSeconds.

      • getFailureThreshold

        public int getFailureThreshold()
         Minimum consecutive failures for the probe to be considered failed after
 having succeeded. Defaults to 3. Minimum value is 1.
        int32 failure_threshold = 4;
        Specified by:
        getFailureThreshold in interface ProbeOrBuilder
        Returns:
        The failureThreshold.

      • hasHttpGet

        public boolean hasHttpGet()
         HTTPGet specifies the http request to perform.
 Exactly one of httpGet, tcpSocket, or grpc must be specified.
        .google.cloud.run.v2.HTTPGetAction http_get = 5;
        Specified by:
        hasHttpGet in interface ProbeOrBuilder
        Returns:
        Whether the httpGet field is set.

      • getHttpGet

        public HTTPGetAction getHttpGet()
         HTTPGet specifies the http request to perform.
 Exactly one of httpGet, tcpSocket, or grpc must be specified.
        .google.cloud.run.v2.HTTPGetAction http_get = 5;
        Specified by:
        getHttpGet in interface ProbeOrBuilder
        Returns:
        The httpGet.

      • getHttpGetOrBuilder

        public HTTPGetActionOrBuilder getHttpGetOrBuilder()
         HTTPGet specifies the http request to perform.
 Exactly one of httpGet, tcpSocket, or grpc must be specified.
        .google.cloud.run.v2.HTTPGetAction http_get = 5;
        Specified by:
        getHttpGetOrBuilder in interface ProbeOrBuilder

      • hasTcpSocket

        public boolean hasTcpSocket()
         TCPSocket specifies an action involving a TCP port.
 Exactly one of httpGet, tcpSocket, or grpc must be specified.
        .google.cloud.run.v2.TCPSocketAction tcp_socket = 6;
        Specified by:
        hasTcpSocket in interface ProbeOrBuilder
        Returns:
        Whether the tcpSocket field is set.

      • getTcpSocket

        public TCPSocketAction getTcpSocket()
         TCPSocket specifies an action involving a TCP port.
 Exactly one of httpGet, tcpSocket, or grpc must be specified.
        .google.cloud.run.v2.TCPSocketAction tcp_socket = 6;
        Specified by:
        getTcpSocket in interface ProbeOrBuilder
        Returns:
        The tcpSocket.

      • getTcpSocketOrBuilder

        public TCPSocketActionOrBuilder getTcpSocketOrBuilder()
         TCPSocket specifies an action involving a TCP port.
 Exactly one of httpGet, tcpSocket, or grpc must be specified.
        .google.cloud.run.v2.TCPSocketAction tcp_socket = 6;
        Specified by:
        getTcpSocketOrBuilder in interface ProbeOrBuilder

      • hasGrpc

        public boolean hasGrpc()
         GRPC specifies an action involving a gRPC port.
 Exactly one of httpGet, tcpSocket, or grpc must be specified.
        .google.cloud.run.v2.GRPCAction grpc = 7;
        Specified by:
        hasGrpc in interface ProbeOrBuilder
        Returns:
        Whether the grpc field is set.

      • getGrpc

        public GRPCAction getGrpc()
         GRPC specifies an action involving a gRPC port.
 Exactly one of httpGet, tcpSocket, or grpc must be specified.
        .google.cloud.run.v2.GRPCAction grpc = 7;
        Specified by:
        getGrpc in interface ProbeOrBuilder
        Returns:
        The grpc.

      • getGrpcOrBuilder

        public GRPCActionOrBuilder getGrpcOrBuilder()
         GRPC specifies an action involving a gRPC port.
 Exactly one of httpGet, tcpSocket, or grpc must be specified.
        .google.cloud.run.v2.GRPCAction grpc = 7;
        Specified by:
        getGrpcOrBuilder in interface ProbeOrBuilder

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

      • parseFrom

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

      • parseFrom

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

      • parseFrom

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

      • parseFrom

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

      • parseFrom

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

      • parseFrom

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

      • newBuilderForType

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

      • toBuilder

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

      • newBuilderForType

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

      • getDefaultInstance

        public static Probe getDefaultInstance()

      • parser

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

      • getParserForType

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