Send feedback
Class Probe (0.55.0)
Stay organized with collections
Save and categorize content based on your preferences.
Version 0.55.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
Inherited Members
com.google.protobuf.GeneratedMessageV3.<ListT>makeMutableCopy(ListT)
com.google.protobuf.GeneratedMessageV3.<ListT>makeMutableCopy(ListT,int)
com.google.protobuf.GeneratedMessageV3.<T>emptyList(java.lang.Class<T>)
com.google.protobuf.GeneratedMessageV3.internalGetMapFieldReflection(int)
Static Fields
FAILURE_THRESHOLD_FIELD_NUMBER
public static final int FAILURE_THRESHOLD_FIELD_NUMBER
Field Value
Type Description
int
GRPC_FIELD_NUMBER
public static final int GRPC_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 ()
newBuilder()
public static Probe . Builder newBuilder ()
newBuilder(Probe prototype)
public static Probe . Builder newBuilder ( Probe prototype )
Parameter
Name Description
prototypeProbe
public static Probe parseDelimitedFrom ( InputStream input )
Returns
Type Description
Probe
public static Probe parseDelimitedFrom ( InputStream input , ExtensionRegistryLite extensionRegistry )
Returns
Type Description
Probe
parseFrom(byte[] data)
public static Probe parseFrom ( byte [] data )
Parameter
Name Description
databyte []
Returns
Type Description
Probe
parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)
public static Probe parseFrom ( byte [] data , ExtensionRegistryLite extensionRegistry )
Returns
Type Description
Probe
parseFrom(ByteString data)
public static Probe parseFrom ( ByteString data )
Returns
Type Description
Probe
parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)
public static Probe parseFrom ( ByteString data , ExtensionRegistryLite extensionRegistry )
Returns
Type Description
Probe
public static Probe parseFrom ( CodedInputStream input )
Returns
Type Description
Probe
public static Probe parseFrom ( CodedInputStream input , ExtensionRegistryLite extensionRegistry )
Returns
Type Description
Probe
public static Probe parseFrom ( InputStream input )
Returns
Type Description
Probe
public static Probe parseFrom ( InputStream input , ExtensionRegistryLite extensionRegistry )
Returns
Type Description
Probe
parseFrom(ByteBuffer data)
public static Probe parseFrom ( ByteBuffer data )
Returns
Type Description
Probe
parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)
public static Probe parseFrom ( ByteBuffer data , ExtensionRegistryLite extensionRegistry )
Returns
Type Description
Probe
parser()
public static Parser<Probe> parser ()
Methods
equals(Object obj)
public boolean equals ( Object obj )
Parameter
Name Description
objObject
Overrides
getDefaultInstanceForType()
public Probe getDefaultInstanceForType ()
Returns
Type Description
Probe
getFailureThreshold()
public int getFailureThreshold ()
Optional. Minimum consecutive failures for the probe to be considered
failed after having succeeded. Defaults to 3. Minimum value is 1.
int32 failure_threshold = 4 [(.google.api.field_behavior) = OPTIONAL];
Returns
Type Description
int The failureThreshold.
getGrpc()
public GRPCAction getGrpc ()
Optional. 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 [(.google.api.field_behavior) = OPTIONAL];
getGrpcOrBuilder()
public GRPCActionOrBuilder getGrpcOrBuilder ()
Optional. 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 [(.google.api.field_behavior) = OPTIONAL];
getHttpGet()
public HTTPGetAction getHttpGet ()
Optional. 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 [(.google.api.field_behavior) = OPTIONAL];
getHttpGetOrBuilder()
public HTTPGetActionOrBuilder getHttpGetOrBuilder ()
Optional. 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 [(.google.api.field_behavior) = OPTIONAL];
getInitialDelaySeconds()
public int getInitialDelaySeconds ()
Optional. 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 [(.google.api.field_behavior) = OPTIONAL];
Returns
Type Description
int The initialDelaySeconds.
getParserForType()
public Parser<Probe> getParserForType ()
Overrides
getPeriodSeconds()
public int getPeriodSeconds ()
Optional. 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 [(.google.api.field_behavior) = OPTIONAL];
Returns
Type Description
int The periodSeconds.
getProbeTypeCase()
public Probe . ProbeTypeCase getProbeTypeCase ()
getSerializedSize()
public int getSerializedSize ()
Returns
Type Description
int
Overrides
getTcpSocket()
public TCPSocketAction getTcpSocket ()
Optional. 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 [(.google.api.field_behavior) = OPTIONAL];
getTcpSocketOrBuilder()
public TCPSocketActionOrBuilder getTcpSocketOrBuilder ()
Optional. 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 [(.google.api.field_behavior) = OPTIONAL];
getTimeoutSeconds()
public int getTimeoutSeconds ()
Optional. 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 [(.google.api.field_behavior) = OPTIONAL];
Returns
Type Description
int The timeoutSeconds.
hasGrpc()
Optional. 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 [(.google.api.field_behavior) = OPTIONAL];
Returns
Type Description
boolean Whether the grpc field is set.
hasHttpGet()
public boolean hasHttpGet ()
Optional. 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 [(.google.api.field_behavior) = OPTIONAL];
Returns
Type Description
boolean Whether the httpGet field is set.
hasTcpSocket()
public boolean hasTcpSocket ()
Optional. 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 [(.google.api.field_behavior) = OPTIONAL];
Returns
Type Description
boolean Whether the tcpSocket field is set.
hashCode()
Returns
Type Description
int
Overrides
internalGetFieldAccessorTable()
protected GeneratedMessageV3 . FieldAccessorTable internalGetFieldAccessorTable ()
Overrides
isInitialized()
public final boolean isInitialized ()
Overrides
newBuilderForType()
public Probe . Builder newBuilderForType ()
newBuilderForType(GeneratedMessageV3.BuilderParent parent)
protected Probe . Builder newBuilderForType ( GeneratedMessageV3 . BuilderParent parent )
Overrides
newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)
protected Object newInstance ( GeneratedMessageV3 . UnusedPrivateParameter unused )
Returns
Type Description
Object
Overrides
toBuilder()
public Probe . Builder toBuilder ()
writeTo(CodedOutputStream output)
public void writeTo ( CodedOutputStream output )
Overrides
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-01-28 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-01-28 UTC."],[],[]]
