Console
    Contact Us Start free

    Class Probe (0.5.0) 

      public 
  
 final 
  
 class 
 Probe 
  
 extends 
  
 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

    Inheritance

    Object > AbstractMessageLite<MessageType,BuilderType> > AbstractMessage > GeneratedMessageV3 > Probe

    Implements

    ProbeOrBuilder

    Static Fields

    FAILURE_THRESHOLD_FIELD_NUMBER

      public 
  
 static 
  
 final 
  
 int 
  
 FAILURE_THRESHOLD_FIELD_NUMBER
    Field Value
    Type Description
    int

    HTTP_GET_FIELD_NUMBER

      public 
  
 static 
  
 final 
  
 int 
  
 HTTP_GET_FIELD_NUMBER
    Field Value
    Type Description
    int

    INITIAL_DELAY_SECONDS_FIELD_NUMBER

      public 
  
 static 
  
 final 
  
 int 
  
 INITIAL_DELAY_SECONDS_FIELD_NUMBER
    Field Value
    Type Description
    int

    PERIOD_SECONDS_FIELD_NUMBER

      public 
  
 static 
  
 final 
  
 int 
  
 PERIOD_SECONDS_FIELD_NUMBER
    Field Value
    Type Description
    int

    TCP_SOCKET_FIELD_NUMBER

      public 
  
 static 
  
 final 
  
 int 
  
 TCP_SOCKET_FIELD_NUMBER
    Field Value
    Type Description
    int

    TIMEOUT_SECONDS_FIELD_NUMBER

      public 
  
 static 
  
 final 
  
 int 
  
 TIMEOUT_SECONDS_FIELD_NUMBER
    Field Value
    Type Description
    int

    Static Methods

    getDefaultInstance()

      public 
  
 static 
  
 Probe 
  
 getDefaultInstance 
 ()
    Returns
    Type Description
    Probe

    getDescriptor()

      public 
  
 static 
  
 final 
  
 Descriptors 
 . 
 Descriptor 
  
 getDescriptor 
 ()
    Returns
    Type Description
    Descriptor

    newBuilder()

      public 
  
 static 
  
 Probe 
 . 
 Builder 
  
 newBuilder 
 ()
    Returns
    Type Description
    Probe.Builder

    newBuilder(Probe prototype)

      public 
  
 static 
  
 Probe 
 . 
 Builder 
  
 newBuilder 
 ( 
 Probe 
  
 prototype 
 )
    Parameter
    Name Description
    prototype Probe
    Returns
    Type Description
    Probe.Builder

    parseDelimitedFrom(InputStream input)

      public 
  
 static 
  
 Probe 
  
 parseDelimitedFrom 
 ( 
 InputStream 
  
 input 
 )
    Parameter
    Name Description
    input InputStream
    Returns
    Type Description
    Probe
    Exceptions
    Type Description
    IOException

    parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

      public 
  
 static 
  
 Probe 
  
 parseDelimitedFrom 
 ( 
 InputStream 
  
 input 
 , 
  
 ExtensionRegistryLite 
  
 extensionRegistry 
 )
    Parameters
    Name Description
    input InputStream
    extensionRegistry ExtensionRegistryLite
    Returns
    Type Description
    Probe
    Exceptions
    Type Description
    IOException

    parseFrom(byte[] data)

      public 
  
 static 
  
 Probe 
  
 parseFrom 
 ( 
 byte 
 [] 
  
 data 
 )
    Parameter
    Name Description
    data byte []
    Returns
    Type Description
    Probe
    Exceptions
    Type Description
    InvalidProtocolBufferException

    parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)

      public 
  
 static 
  
 Probe 
  
 parseFrom 
 ( 
 byte 
 [] 
  
 data 
 , 
  
 ExtensionRegistryLite 
  
 extensionRegistry 
 )
    Parameters
    Name Description
    data byte []
    extensionRegistry ExtensionRegistryLite
    Returns
    Type Description
    Probe
    Exceptions
    Type Description
    InvalidProtocolBufferException

    parseFrom(ByteString data)

      public 
  
 static 
  
 Probe 
  
 parseFrom 
 ( 
 ByteString 
  
 data 
 )
    Parameter
    Name Description
    data ByteString
    Returns
    Type Description
    Probe
    Exceptions
    Type Description
    InvalidProtocolBufferException

    parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)

      public 
  
 static 
  
 Probe 
  
 parseFrom 
 ( 
 ByteString 
  
 data 
 , 
  
 ExtensionRegistryLite 
  
 extensionRegistry 
 )
    Parameters
    Name Description
    data ByteString
    extensionRegistry ExtensionRegistryLite
    Returns
    Type Description
    Probe
    Exceptions
    Type Description
    InvalidProtocolBufferException

    parseFrom(CodedInputStream input)

      public 
  
 static 
  
 Probe 
  
 parseFrom 
 ( 
 CodedInputStream 
  
 input 
 )
    Parameter
    Name Description
    input CodedInputStream
    Returns
    Type Description
    Probe
    Exceptions
    Type Description
    IOException

    parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

      public 
  
 static 
  
 Probe 
  
 parseFrom 
 ( 
 CodedInputStream 
  
 input 
 , 
  
 ExtensionRegistryLite 
  
 extensionRegistry 
 )
    Parameters
    Name Description
    input CodedInputStream
    extensionRegistry ExtensionRegistryLite
    Returns
    Type Description
    Probe
    Exceptions
    Type Description
    IOException

    parseFrom(InputStream input)

      public 
  
 static 
  
 Probe 
  
 parseFrom 
 ( 
 InputStream 
  
 input 
 )
    Parameter
    Name Description
    input InputStream
    Returns
    Type Description
    Probe
    Exceptions
    Type Description
    IOException

    parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

      public 
  
 static 
  
 Probe 
  
 parseFrom 
 ( 
 InputStream 
  
 input 
 , 
  
 ExtensionRegistryLite 
  
 extensionRegistry 
 )
    Parameters
    Name Description
    input InputStream
    extensionRegistry ExtensionRegistryLite
    Returns
    Type Description
    Probe
    Exceptions
    Type Description
    IOException

    parseFrom(ByteBuffer data)

      public 
  
 static 
  
 Probe 
  
 parseFrom 
 ( 
 ByteBuffer 
  
 data 
 )
    Parameter
    Name Description
    data ByteBuffer
    Returns
    Type Description
    Probe
    Exceptions
    Type Description
    InvalidProtocolBufferException

    parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)

      public 
  
 static 
  
 Probe 
  
 parseFrom 
 ( 
 ByteBuffer 
  
 data 
 , 
  
 ExtensionRegistryLite 
  
 extensionRegistry 
 )
    Parameters
    Name Description
    data ByteBuffer
    extensionRegistry ExtensionRegistryLite
    Returns
    Type Description
    Probe
    Exceptions
    Type Description
    InvalidProtocolBufferException

    parser()

      public 
  
 static 
  
 Parser<Probe> 
  
 parser 
 ()
    Returns
    Type Description
    Parser < Probe >

    Methods

    equals(Object obj)

      public 
  
 boolean 
  
 equals 
 ( 
 Object 
  
 obj 
 )
    Parameter
    Name Description
    obj Object
    Returns
    Type Description
    boolean
    Overrides

    getDefaultInstanceForType()

      public 
  
 Probe 
  
 getDefaultInstanceForType 
 ()
    Returns
    Type Description
    Probe

    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;

    Returns
    Type Description
    int

    The failureThreshold.

    getHttpGet()

      public 
  
 HTTPGetAction 
  
 getHttpGet 
 ()

    HTTPGet specifies the http request to perform. Exactly one of HTTPGet or TCPSocket must be specified.

    .google.cloud.run.v2.HTTPGetAction http_get = 5;

    Returns
    Type Description
    HTTPGetAction

    The httpGet.

    getHttpGetOrBuilder()

      public 
  
 HTTPGetActionOrBuilder 
  
 getHttpGetOrBuilder 
 ()

    HTTPGet specifies the http request to perform. Exactly one of HTTPGet or TCPSocket must be specified.

    .google.cloud.run.v2.HTTPGetAction http_get = 5;

    Returns
    Type Description
    HTTPGetActionOrBuilder

    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. More info: https://kubernetes.io/docs/concepts/workloads/pods/pod-lifecycle#container-probes

    int32 initial_delay_seconds = 1;

    Returns
    Type Description
    int

    The initialDelaySeconds.

    getParserForType()

      public 
  
 Parser<Probe> 
  
 getParserForType 
 ()
    Returns
    Type Description
    Parser < Probe >
    Overrides

    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;

    Returns
    Type Description
    int

    The periodSeconds.

    getProbeTypeCase()

      public 
  
 Probe 
 . 
 ProbeTypeCase 
  
 getProbeTypeCase 
 ()
    Returns
    Type Description
    Probe.ProbeTypeCase

    getSerializedSize()

      public 
  
 int 
  
 getSerializedSize 
 ()
    Returns
    Type Description
    int
    Overrides

    getTcpSocket()

      public 
  
 TCPSocketAction 
  
 getTcpSocket 
 ()

    TCPSocket specifies an action involving a TCP port. Exactly one of HTTPGet or TCPSocket must be specified.

    .google.cloud.run.v2.TCPSocketAction tcp_socket = 6;

    Returns
    Type Description
    TCPSocketAction

    The tcpSocket.

    getTcpSocketOrBuilder()

      public 
  
 TCPSocketActionOrBuilder 
  
 getTcpSocketOrBuilder 
 ()

    TCPSocket specifies an action involving a TCP port. Exactly one of HTTPGet or TCPSocket must be specified.

    .google.cloud.run.v2.TCPSocketAction tcp_socket = 6;

    Returns
    Type Description
    TCPSocketActionOrBuilder

    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. More info: https://kubernetes.io/docs/concepts/workloads/pods/pod-lifecycle#container-probes

    int32 timeout_seconds = 2;

    Returns
    Type Description
    int

    The timeoutSeconds.

    getUnknownFields()

      public 
  
 final 
  
 UnknownFieldSet 
  
 getUnknownFields 
 ()
    Returns
    Type Description
    UnknownFieldSet
    Overrides

    hasHttpGet()

      public 
  
 boolean 
  
 hasHttpGet 
 ()

    HTTPGet specifies the http request to perform. Exactly one of HTTPGet or TCPSocket must be specified.

    .google.cloud.run.v2.HTTPGetAction http_get = 5;

    Returns
    Type Description
    boolean

    Whether the httpGet field is set.

    hasTcpSocket()

      public 
  
 boolean 
  
 hasTcpSocket 
 ()

    TCPSocket specifies an action involving a TCP port. Exactly one of HTTPGet or TCPSocket must be specified.

    .google.cloud.run.v2.TCPSocketAction tcp_socket = 6;

    Returns
    Type Description
    boolean

    Whether the tcpSocket field is set.

    hashCode()

      public 
  
 int 
  
 hashCode 
 ()
    Returns
    Type Description
    int
    Overrides

    internalGetFieldAccessorTable()

      protected 
  
 GeneratedMessageV3 
 . 
 FieldAccessorTable 
  
 internalGetFieldAccessorTable 
 ()
    Returns
    Type Description
    FieldAccessorTable
    Overrides

    isInitialized()

      public 
  
 final 
  
 boolean 
  
 isInitialized 
 ()
    Returns
    Type Description
    boolean
    Overrides

    newBuilderForType()

      public 
  
 Probe 
 . 
 Builder 
  
 newBuilderForType 
 ()
    Returns
    Type Description
    Probe.Builder

    newBuilderForType(GeneratedMessageV3.BuilderParent parent)

      protected 
  
 Probe 
 . 
 Builder 
  
 newBuilderForType 
 ( 
 GeneratedMessageV3 
 . 
 BuilderParent 
  
 parent 
 )
    Parameter
    Name Description
    parent BuilderParent
    Returns
    Type Description
    Probe.Builder
    Overrides

    newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)

      protected 
  
 Object 
  
 newInstance 
 ( 
 GeneratedMessageV3 
 . 
 UnusedPrivateParameter 
  
 unused 
 )
    Parameter
    Name Description
    unused UnusedPrivateParameter
    Returns
    Type Description
    Object
    Overrides

    toBuilder()

      public 
  
 Probe 
 . 
 Builder 
  
 toBuilder 
 ()
    Returns
    Type Description
    Probe.Builder

    writeTo(CodedOutputStream output)

      public 
  
 void 
  
 writeTo 
 ( 
 CodedOutputStream 
  
 output 
 )
    Parameter
    Name Description
    output CodedOutputStream
    Overrides Exceptions
    Type Description
    IOException
    Design a Mobile Site
    View Site in Mobile | Classic
    Share by: