Class Probe (0.14.0)

publicfinalclass ProbeextendsGeneratedMessageV3implementsProbeOrBuilder

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

Implements

ProbeOrBuilder

Inherited Members

Static Fields

FAILURE_THRESHOLD_FIELD_NUMBER

publicstaticfinalintFAILURE_THRESHOLD_FIELD_NUMBER
Field Value
Type Description
int

GRPC_FIELD_NUMBER

publicstaticfinalintGRPC_FIELD_NUMBER
Field Value
Type Description
int

HTTP_GET_FIELD_NUMBER

publicstaticfinalintHTTP_GET_FIELD_NUMBER
Field Value
Type Description
int

INITIAL_DELAY_SECONDS_FIELD_NUMBER

publicstaticfinalintINITIAL_DELAY_SECONDS_FIELD_NUMBER
Field Value
Type Description
int

PERIOD_SECONDS_FIELD_NUMBER

publicstaticfinalintPERIOD_SECONDS_FIELD_NUMBER
Field Value
Type Description
int

TCP_SOCKET_FIELD_NUMBER

publicstaticfinalintTCP_SOCKET_FIELD_NUMBER
Field Value
Type Description
int

TIMEOUT_SECONDS_FIELD_NUMBER

publicstaticfinalintTIMEOUT_SECONDS_FIELD_NUMBER
Field Value
Type Description
int

Static Methods

getDefaultInstance()

publicstaticProbegetDefaultInstance()
Returns
Type Description
Probe

getDescriptor()

publicstaticfinalDescriptors.DescriptorgetDescriptor()
Returns
Type Description
Descriptor

newBuilder()

publicstaticProbe.BuildernewBuilder()
Returns
Type Description
Probe.Builder

newBuilder(Probe prototype)

publicstaticProbe.BuildernewBuilder(Probeprototype)
Parameter
Name Description
prototype Probe
Returns
Type Description
Probe.Builder

parseDelimitedFrom(InputStream input)

publicstaticProbeparseDelimitedFrom(InputStreaminput)
Parameter
Name Description
input InputStream
Returns
Type Description
Probe
Exceptions
Type Description
IOException

parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

publicstaticProbeparseDelimitedFrom(InputStreaminput,ExtensionRegistryLiteextensionRegistry)
Parameters
Name Description
input InputStream
extensionRegistry ExtensionRegistryLite
Returns
Type Description
Probe
Exceptions
Type Description
IOException

parseFrom(byte[] data)

publicstaticProbeparseFrom(byte[]data)
Parameter
Name Description
data byte[]
Returns
Type Description
Probe
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)

publicstaticProbeparseFrom(byte[]data,ExtensionRegistryLiteextensionRegistry)
Parameters
Name Description
data byte[]
extensionRegistry ExtensionRegistryLite
Returns
Type Description
Probe
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(ByteString data)

publicstaticProbeparseFrom(ByteStringdata)
Parameter
Name Description
data ByteString
Returns
Type Description
Probe
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)

publicstaticProbeparseFrom(ByteStringdata,ExtensionRegistryLiteextensionRegistry)
Parameters
Name Description
data ByteString
extensionRegistry ExtensionRegistryLite
Returns
Type Description
Probe
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(CodedInputStream input)

publicstaticProbeparseFrom(CodedInputStreaminput)
Parameter
Name Description
input CodedInputStream
Returns
Type Description
Probe
Exceptions
Type Description
IOException

parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

publicstaticProbeparseFrom(CodedInputStreaminput,ExtensionRegistryLiteextensionRegistry)
Parameters
Name Description
input CodedInputStream
extensionRegistry ExtensionRegistryLite
Returns
Type Description
Probe
Exceptions
Type Description
IOException

parseFrom(InputStream input)

publicstaticProbeparseFrom(InputStreaminput)
Parameter
Name Description
input InputStream
Returns
Type Description
Probe
Exceptions
Type Description
IOException

parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

publicstaticProbeparseFrom(InputStreaminput,ExtensionRegistryLiteextensionRegistry)
Parameters
Name Description
input InputStream
extensionRegistry ExtensionRegistryLite
Returns
Type Description
Probe
Exceptions
Type Description
IOException

parseFrom(ByteBuffer data)

publicstaticProbeparseFrom(ByteBufferdata)
Parameter
Name Description
data ByteBuffer
Returns
Type Description
Probe
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)

publicstaticProbeparseFrom(ByteBufferdata,ExtensionRegistryLiteextensionRegistry)
Parameters
Name Description
data ByteBuffer
extensionRegistry ExtensionRegistryLite
Returns
Type Description
Probe
Exceptions
Type Description
InvalidProtocolBufferException

parser()

publicstaticParser<Probe>parser()
Returns
Type Description
Parser<Probe>

Methods

equals(Object obj)

publicbooleanequals(Objectobj)
Parameter
Name Description
obj Object
Returns
Type Description
boolean
Overrides

getDefaultInstanceForType()

publicProbegetDefaultInstanceForType()
Returns
Type Description
Probe

getFailureThreshold()

publicintgetFailureThreshold()

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.

getGrpc()

publicGRPCActiongetGrpc()

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
GRPCAction

The grpc.

getGrpcOrBuilder()

publicGRPCActionOrBuildergetGrpcOrBuilder()

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
GRPCActionOrBuilder

getHttpGet()

publicHTTPGetActiongetHttpGet()

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
HTTPGetAction

The httpGet.

getHttpGetOrBuilder()

publicHTTPGetActionOrBuildergetHttpGetOrBuilder()

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
HTTPGetActionOrBuilder

getInitialDelaySeconds()

publicintgetInitialDelaySeconds()

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()

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

getPeriodSeconds()

publicintgetPeriodSeconds()

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()

publicProbe.ProbeTypeCasegetProbeTypeCase()
Returns
Type Description
Probe.ProbeTypeCase

getSerializedSize()

publicintgetSerializedSize()
Returns
Type Description
int
Overrides

getTcpSocket()

publicTCPSocketActiongetTcpSocket()

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
TCPSocketAction

The tcpSocket.

getTcpSocketOrBuilder()

publicTCPSocketActionOrBuildergetTcpSocketOrBuilder()

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
TCPSocketActionOrBuilder

getTimeoutSeconds()

publicintgetTimeoutSeconds()

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()

publicfinalUnknownFieldSetgetUnknownFields()
Returns
Type Description
UnknownFieldSet
Overrides

hasGrpc()

publicbooleanhasGrpc()

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()

publicbooleanhasHttpGet()

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()

publicbooleanhasTcpSocket()

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()

publicinthashCode()
Returns
Type Description
int
Overrides

internalGetFieldAccessorTable()

protectedGeneratedMessageV3.FieldAccessorTableinternalGetFieldAccessorTable()
Returns
Type Description
FieldAccessorTable
Overrides

isInitialized()

publicfinalbooleanisInitialized()
Returns
Type Description
boolean
Overrides

newBuilderForType()

publicProbe.BuildernewBuilderForType()
Returns
Type Description
Probe.Builder

newBuilderForType(GeneratedMessageV3.BuilderParent parent)

protectedProbe.BuildernewBuilderForType(GeneratedMessageV3.BuilderParentparent)
Parameter
Name Description
parent BuilderParent
Returns
Type Description
Probe.Builder
Overrides

newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)

protectedObjectnewInstance(GeneratedMessageV3.UnusedPrivateParameterunused)
Parameter
Name Description
unused UnusedPrivateParameter
Returns
Type Description
Object
Overrides

toBuilder()

publicProbe.BuildertoBuilder()
Returns
Type Description
Probe.Builder

writeTo(CodedOutputStream output)

publicvoidwriteTo(CodedOutputStreamoutput)
Parameter
Name Description
output CodedOutputStream
Overrides
Exceptions
Type Description
IOException

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年10月30日 UTC.