Class Probe (3.59.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.aiplatform.v1.Probe

Implements

ProbeOrBuilder
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

EXEC_FIELD_NUMBER

public static final int EXEC_FIELD_NUMBER
Field Value
Type Description
int

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

SUCCESS_THRESHOLD_FIELD_NUMBER

public static final int SUCCESS_THRESHOLD_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

getExec()

public Probe.ExecAction getExec()

ExecAction probes the health of a container by executing a command.

.google.cloud.aiplatform.v1.Probe.ExecAction exec = 1;

Returns
Type Description
Probe.ExecAction

The exec.

getExecOrBuilder()

public Probe.ExecActionOrBuilder getExecOrBuilder()

ExecAction probes the health of a container by executing a command.

.google.cloud.aiplatform.v1.Probe.ExecAction exec = 1;

Returns
Type Description
Probe.ExecActionOrBuilder

getFailureThreshold()

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.

getGrpc()

public Probe.GrpcAction getGrpc()

GrpcAction probes the health of a container by sending a gRPC request.

.google.cloud.aiplatform.v1.Probe.GrpcAction grpc = 5;

Returns
Type Description
Probe.GrpcAction

The grpc.

getGrpcOrBuilder()

public Probe.GrpcActionOrBuilder getGrpcOrBuilder()

GrpcAction probes the health of a container by sending a gRPC request.

.google.cloud.aiplatform.v1.Probe.GrpcAction grpc = 5;

Returns
Type Description
Probe.GrpcActionOrBuilder

getHttpGet()

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;

Returns
Type Description
Probe.HttpGetAction

The httpGet.

getHttpGetOrBuilder()

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;

Returns
Type Description
Probe.HttpGetActionOrBuilder

getInitialDelaySeconds()

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.

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. Must be less than timeout_seconds.

Maps to Kubernetes probe argument 'periodSeconds'.

int32 period_seconds = 2;

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

getSuccessThreshold()

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.

getTcpSocket()

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;

Returns
Type Description
Probe.TcpSocketAction

The tcpSocket.

getTcpSocketOrBuilder()

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;

Returns
Type Description
Probe.TcpSocketActionOrBuilder

getTimeoutSeconds()

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.

hasExec()

public boolean hasExec()

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.

hasGrpc()

public boolean hasGrpc()

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.

hasHttpGet()

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.

hasTcpSocket()

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.

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