Class Probe (3.60.0)
Note: Some or all of the information on this page might not apply
to Trusted Cloud. For a list of services that are available in
Trusted Cloud, see Services available for
Trusted Cloud .
Version 3.60.0keyboard_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.aiplatform.v1.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
public static final int EXEC_FIELD_NUMBER
Field Value
Type Description
int
public static final int FAILURE_THRESHOLD_FIELD_NUMBER
Field Value
Type Description
int
public static final int GRPC_FIELD_NUMBER
Field Value
Type Description
int
public static final int HTTP_GET_FIELD_NUMBER
Field Value
Type Description
int
public static final int INITIAL_DELAY_SECONDS_FIELD_NUMBER
Field Value
Type Description
int
public static final int PERIOD_SECONDS_FIELD_NUMBER
Field Value
Type Description
int
public static final int SUCCESS_THRESHOLD_FIELD_NUMBER
Field Value
Type Description
int
public static final int TCP_SOCKET_FIELD_NUMBER
Field Value
Type Description
int
public static final int TIMEOUT_SECONDS_FIELD_NUMBER
Field Value
Type Description
int
Static Methods
public static Probe getDefaultInstance ()
Returns
Type Description
Probe
public static final Descriptors . Descriptor getDescriptor ()
public static Probe . Builder newBuilder ()
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
public static Probe parseFrom ( byte [] data )
Parameter
Name Description
databyte []
Returns
Type Description
Probe
public static Probe parseFrom ( byte [] data , ExtensionRegistryLite extensionRegistry )
Returns
Type Description
Probe
public static Probe parseFrom ( ByteString data )
Returns
Type Description
Probe
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
public static Probe parseFrom ( ByteBuffer data )
Returns
Type Description
Probe
public static Probe parseFrom ( ByteBuffer data , ExtensionRegistryLite extensionRegistry )
Returns
Type Description
Probe
public static Parser<Probe> parser ()
Methods
public boolean equals ( Object obj )
Parameter
Name Description
objObject
Overrides
public Probe getDefaultInstanceForType ()
Returns
Type Description
Probe
public Probe . ExecAction getExec ()
ExecAction probes the health of a container by executing a command.
.google.cloud.aiplatform.v1.Probe.ExecAction exec = 1;
public Probe . ExecActionOrBuilder getExecOrBuilder ()
ExecAction probes the health of a container by executing a command.
.google.cloud.aiplatform.v1.Probe.ExecAction exec = 1;
public int getFailureThreshold ()
Number of consecutive failures before the probe is considered failed.
Defaults to 3. Minimum value is 1.
Maps to Kubernetes probe argument 'failureThreshold'.
int32 failure_threshold = 7;
Returns
Type Description
int The failureThreshold.
public Probe . GrpcAction getGrpc ()
GrpcAction probes the health of a container by sending a gRPC request.
.google.cloud.aiplatform.v1.Probe.GrpcAction grpc = 5;
public Probe . GrpcActionOrBuilder getGrpcOrBuilder ()
GrpcAction probes the health of a container by sending a gRPC request.
.google.cloud.aiplatform.v1.Probe.GrpcAction grpc = 5;
public Probe . HttpGetAction getHttpGet ()
HttpGetAction probes the health of a container by sending an HTTP GET
request.
.google.cloud.aiplatform.v1.Probe.HttpGetAction http_get = 4;
public Probe . HttpGetActionOrBuilder getHttpGetOrBuilder ()
HttpGetAction probes the health of a container by sending an HTTP GET
request.
.google.cloud.aiplatform.v1.Probe.HttpGetAction http_get = 4;
public int getInitialDelaySeconds ()
Number of seconds to wait before starting the probe. Defaults to 0.
Minimum value is 0.
Maps to Kubernetes probe argument 'initialDelaySeconds'.
int32 initial_delay_seconds = 9;
Returns
Type Description
int The initialDelaySeconds.
public Parser<Probe> getParserForType ()
Overrides
public int getPeriodSeconds ()
How often (in seconds) to perform the probe. Default to 10 seconds.
Minimum value is 1. Must be less than timeout_seconds.
Maps to Kubernetes probe argument 'periodSeconds'.
int32 period_seconds = 2;
Returns
Type Description
int The periodSeconds.
public Probe . ProbeTypeCase getProbeTypeCase ()
public int getSerializedSize ()
Returns
Type Description
int
Overrides
public int getSuccessThreshold ()
Number of consecutive successes before the probe is considered successful.
Defaults to 1. Minimum value is 1.
Maps to Kubernetes probe argument 'successThreshold'.
int32 success_threshold = 8;
Returns
Type Description
int The successThreshold.
public Probe . TcpSocketAction getTcpSocket ()
TcpSocketAction probes the health of a container by opening a TCP socket
connection.
.google.cloud.aiplatform.v1.Probe.TcpSocketAction tcp_socket = 6;
public Probe . TcpSocketActionOrBuilder getTcpSocketOrBuilder ()
TcpSocketAction probes the health of a container by opening a TCP socket
connection.
.google.cloud.aiplatform.v1.Probe.TcpSocketAction tcp_socket = 6;
public int getTimeoutSeconds ()
Number of seconds after which the probe times out. Defaults to 1 second.
Minimum value is 1. Must be greater or equal to period_seconds.
Maps to Kubernetes probe argument 'timeoutSeconds'.
int32 timeout_seconds = 3;
Returns
Type Description
int The timeoutSeconds.
ExecAction probes the health of a container by executing a command.
.google.cloud.aiplatform.v1.Probe.ExecAction exec = 1;
Returns
Type Description
boolean Whether the exec field is set.
GrpcAction probes the health of a container by sending a gRPC request.
.google.cloud.aiplatform.v1.Probe.GrpcAction grpc = 5;
Returns
Type Description
boolean Whether the grpc field is set.
public boolean hasHttpGet ()
HttpGetAction probes the health of a container by sending an HTTP GET
request.
.google.cloud.aiplatform.v1.Probe.HttpGetAction http_get = 4;
Returns
Type Description
boolean Whether the httpGet field is set.
public boolean hasTcpSocket ()
TcpSocketAction probes the health of a container by opening a TCP socket
connection.
.google.cloud.aiplatform.v1.Probe.TcpSocketAction tcp_socket = 6;
Returns
Type Description
boolean Whether the tcpSocket field is set.
Returns
Type Description
int
Overrides
protected GeneratedMessageV3 . FieldAccessorTable internalGetFieldAccessorTable ()
Overrides
public final boolean isInitialized ()
Overrides
public Probe . Builder newBuilderForType ()
protected Probe . Builder newBuilderForType ( GeneratedMessageV3 . BuilderParent parent )
Overrides
protected Object newInstance ( GeneratedMessageV3 . UnusedPrivateParameter unused )
Returns
Type Description
Object
Overrides
public Probe . Builder toBuilder ()
public void writeTo ( CodedOutputStream output )
Overrides
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.
[[["Easy to understand","easyToUnderstand","thumb-up"],["Solved my problem","solvedMyProblem","thumb-up"],["Other","otherUp","thumb-up"]],[["Missing the information I need","missingTheInformationINeed","thumb-down"],["Too complicated / too many steps","tooComplicatedTooManySteps","thumb-down"],["Out of date","outOfDate","thumb-down"],["Samples / code issue","samplesCodeIssue","thumb-down"],["Other","otherDown","thumb-down"]],["Last updated 2025-09-04 UTC."],[],[],null,[]]
