Send feedback
Class Probe (0.12.0) Stay organized with collections
Save and categorize content based on your preferences.
Version 0.12.0 keyboard_arrow_down
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
Static Fields
FAILURE_THRESHOLD_FIELD_NUMBER
public
static
final
int
FAILURE_THRESHOLD_FIELD_NUMBER
Field Value
GRPC_FIELD_NUMBER
public
static
final
int
GRPC_FIELD_NUMBER
Field Value
HTTP_GET_FIELD_NUMBER
public
static
final
int
HTTP_GET_FIELD_NUMBER
Field Value
INITIAL_DELAY_SECONDS_FIELD_NUMBER
public
static
final
int
INITIAL_DELAY_SECONDS_FIELD_NUMBER
Field Value
PERIOD_SECONDS_FIELD_NUMBER
public
static
final
int
PERIOD_SECONDS_FIELD_NUMBER
Field Value
TCP_SOCKET_FIELD_NUMBER
public
static
final
int
TCP_SOCKET_FIELD_NUMBER
Field Value
TIMEOUT_SECONDS_FIELD_NUMBER
public
static
final
int
TIMEOUT_SECONDS_FIELD_NUMBER
Field Value
Static Methods
getDefaultInstance()
public
static
Probe
getDefaultInstance
()
Returns
getDescriptor()
public
static
final
Descriptors
.
Descriptor
getDescriptor
()
Returns
newBuilder()
public
static
Probe
.
Builder
newBuilder
()
Returns
newBuilder(Probe prototype)
public
static
Probe
.
Builder
newBuilder
(
Probe
prototype
)
Parameter
Returns
public
static
Probe
parseDelimitedFrom
(
InputStream
input
)
Parameter
Returns
Exceptions
public
static
Probe
parseDelimitedFrom
(
InputStream
input
,
ExtensionRegistryLite
extensionRegistry
)
Parameters
Returns
Exceptions
parseFrom(byte[] data)
public
static
Probe
parseFrom
(
byte
[]
data
)
Parameter
Returns
Exceptions
parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)
public
static
Probe
parseFrom
(
byte
[]
data
,
ExtensionRegistryLite
extensionRegistry
)
Parameters
Returns
Exceptions
parseFrom(ByteString data)
public
static
Probe
parseFrom
(
ByteString
data
)
Parameter
Returns
Exceptions
parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)
public
static
Probe
parseFrom
(
ByteString
data
,
ExtensionRegistryLite
extensionRegistry
)
Parameters
Returns
Exceptions
public
static
Probe
parseFrom
(
CodedInputStream
input
)
Parameter
Returns
Exceptions
public
static
Probe
parseFrom
(
CodedInputStream
input
,
ExtensionRegistryLite
extensionRegistry
)
Parameters
Returns
Exceptions
public
static
Probe
parseFrom
(
InputStream
input
)
Parameter
Returns
Exceptions
public
static
Probe
parseFrom
(
InputStream
input
,
ExtensionRegistryLite
extensionRegistry
)
Parameters
Returns
Exceptions
parseFrom(ByteBuffer data)
public
static
Probe
parseFrom
(
ByteBuffer
data
)
Parameter
Returns
Exceptions
parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)
public
static
Probe
parseFrom
(
ByteBuffer
data
,
ExtensionRegistryLite
extensionRegistry
)
Parameters
Returns
Exceptions
parser()
public
static
Parser<Probe>
parser
()
Returns
Methods
equals(Object obj)
public
boolean
equals
(
Object
obj
)
Parameter
Returns
Overrides
getDefaultInstanceForType()
public
Probe
getDefaultInstanceForType
()
Returns
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
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;
Returns
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;
Returns
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;
Returns
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;
Returns
getInitialDelaySeconds()
public
int
getInitialDelaySeconds
()
Returns Type
Description
int
The initialDelaySeconds.
getParserForType()
public
Parser<Probe>
getParserForType
()
Returns
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
getProbeTypeCase()
public
Probe
.
ProbeTypeCase
getProbeTypeCase
()
Returns
getSerializedSize()
public
int
getSerializedSize
()
Returns
Overrides
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;
Returns
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;
Returns
getTimeoutSeconds()
public
int
getTimeoutSeconds
()
Returns
getUnknownFields()
public
final
UnknownFieldSet
getUnknownFields
()
Returns
Overrides
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;
Returns Type
Description
boolean
Whether the grpc field is set.
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;
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, tcpSocket, or grpc must be specified.
.google.cloud.run.v2.TCPSocketAction tcp_socket = 6;
Returns Type
Description
boolean
Whether the tcpSocket field is set.
hashCode()
Returns
Overrides
internalGetFieldAccessorTable()
protected
GeneratedMessageV3
.
FieldAccessorTable
internalGetFieldAccessorTable
()
Returns
Overrides
isInitialized()
public
final
boolean
isInitialized
()
Returns
Overrides
newBuilderForType()
public
Probe
.
Builder
newBuilderForType
()
Returns
newBuilderForType(GeneratedMessageV3.BuilderParent parent)
protected
Probe
.
Builder
newBuilderForType
(
GeneratedMessageV3
.
BuilderParent
parent
)
Parameter
Returns
Overrides
newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)
protected
Object
newInstance
(
GeneratedMessageV3
.
UnusedPrivateParameter
unused
)
Parameter
Returns
Overrides
toBuilder()
public
Probe
.
Builder
toBuilder
()
Returns
writeTo(CodedOutputStream output)
public
void
writeTo
(
CodedOutputStream
output
)
Parameter
Overrides
Exceptions
Send feedback
Except as otherwise noted, the content of this page is licensed under the Creative Commons Attribution 4.0 License
, and code samples are licensed under the Apache 2.0 License
. For details, see the Google Developers Site Policies
. Java is a registered trademark of Oracle and/or its affiliates.
Last updated 2025-09-04 UTC.
Need to tell us more?
[[["Easy to understand","easyToUnderstand","thumb-up"],["Solved my problem","solvedMyProblem","thumb-up"],["Other","otherUp","thumb-up"]],[["Hard to understand","hardToUnderstand","thumb-down"],["Incorrect information or sample code","incorrectInformationOrSampleCode","thumb-down"],["Missing the information/samples I need","missingTheInformationSamplesINeed","thumb-down"],["Other","otherDown","thumb-down"]],["Last updated 2025-09-04 UTC."],[],[],null,[]]
