Class Probe (3.37.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.v1beta1.Probe

Implements

ProbeOrBuilder

Static Fields

EXEC_FIELD_NUMBER

public static final int EXEC_FIELD_NUMBER
Field Value
TypeDescription
int

PERIOD_SECONDS_FIELD_NUMBER

public static final int PERIOD_SECONDS_FIELD_NUMBER
Field Value
TypeDescription
int

TIMEOUT_SECONDS_FIELD_NUMBER

public static final int TIMEOUT_SECONDS_FIELD_NUMBER
Field Value
TypeDescription
int

Static Methods

getDefaultInstance()

public static Probe getDefaultInstance()
Returns
TypeDescription
Probe

getDescriptor()

public static final Descriptors.Descriptor getDescriptor()
Returns
TypeDescription
Descriptor

newBuilder()

public static Probe.Builder newBuilder()
Returns
TypeDescription
Probe.Builder

newBuilder(Probe prototype)

public static Probe.Builder newBuilder(Probe prototype)
Parameter
NameDescription
prototypeProbe
Returns
TypeDescription
Probe.Builder

parseDelimitedFrom(InputStream input)

public static Probe parseDelimitedFrom(InputStream input)
Parameter
NameDescription
inputInputStream
Returns
TypeDescription
Probe
Exceptions
TypeDescription
IOException

parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

public static Probe parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
NameDescription
inputInputStream
extensionRegistryExtensionRegistryLite
Returns
TypeDescription
Probe
Exceptions
TypeDescription
IOException

parseFrom(byte[] data)

public static Probe parseFrom(byte[] data)
Parameter
NameDescription
databyte[]
Returns
TypeDescription
Probe
Exceptions
TypeDescription
InvalidProtocolBufferException

parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)

public static Probe parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)
Parameters
NameDescription
databyte[]
extensionRegistryExtensionRegistryLite
Returns
TypeDescription
Probe
Exceptions
TypeDescription
InvalidProtocolBufferException

parseFrom(ByteString data)

public static Probe parseFrom(ByteString data)
Parameter
NameDescription
dataByteString
Returns
TypeDescription
Probe
Exceptions
TypeDescription
InvalidProtocolBufferException

parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)

public static Probe parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)
Parameters
NameDescription
dataByteString
extensionRegistryExtensionRegistryLite
Returns
TypeDescription
Probe
Exceptions
TypeDescription
InvalidProtocolBufferException

parseFrom(CodedInputStream input)

public static Probe parseFrom(CodedInputStream input)
Parameter
NameDescription
inputCodedInputStream
Returns
TypeDescription
Probe
Exceptions
TypeDescription
IOException

parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

public static Probe parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
NameDescription
inputCodedInputStream
extensionRegistryExtensionRegistryLite
Returns
TypeDescription
Probe
Exceptions
TypeDescription
IOException

parseFrom(InputStream input)

public static Probe parseFrom(InputStream input)
Parameter
NameDescription
inputInputStream
Returns
TypeDescription
Probe
Exceptions
TypeDescription
IOException

parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

public static Probe parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
NameDescription
inputInputStream
extensionRegistryExtensionRegistryLite
Returns
TypeDescription
Probe
Exceptions
TypeDescription
IOException

parseFrom(ByteBuffer data)

public static Probe parseFrom(ByteBuffer data)
Parameter
NameDescription
dataByteBuffer
Returns
TypeDescription
Probe
Exceptions
TypeDescription
InvalidProtocolBufferException

parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)

public static Probe parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)
Parameters
NameDescription
dataByteBuffer
extensionRegistryExtensionRegistryLite
Returns
TypeDescription
Probe
Exceptions
TypeDescription
InvalidProtocolBufferException

parser()

public static Parser<Probe> parser()
Returns
TypeDescription
Parser<Probe>

Methods

equals(Object obj)

public boolean equals(Object obj)
Parameter
NameDescription
objObject
Returns
TypeDescription
boolean
Overrides

getDefaultInstanceForType()

public Probe getDefaultInstanceForType()
Returns
TypeDescription
Probe

getExec()

public Probe.ExecAction getExec()

Exec specifies the action to take.

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

Returns
TypeDescription
Probe.ExecAction

The exec.

getExecOrBuilder()

public Probe.ExecActionOrBuilder getExecOrBuilder()

Exec specifies the action to take.

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

Returns
TypeDescription
Probe.ExecActionOrBuilder

getParserForType()

public Parser<Probe> getParserForType()
Returns
TypeDescription
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
TypeDescription
int

The periodSeconds.

getProbeTypeCase()

public Probe.ProbeTypeCase getProbeTypeCase()
Returns
TypeDescription
Probe.ProbeTypeCase

getSerializedSize()

public int getSerializedSize()
Returns
TypeDescription
int
Overrides

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
TypeDescription
int

The timeoutSeconds.

hasExec()

public boolean hasExec()

Exec specifies the action to take.

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

Returns
TypeDescription
boolean

Whether the exec field is set.

hashCode()

public int hashCode()
Returns
TypeDescription
int
Overrides

internalGetFieldAccessorTable()

protected GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
Returns
TypeDescription
FieldAccessorTable
Overrides

isInitialized()

public final boolean isInitialized()
Returns
TypeDescription
boolean
Overrides

newBuilderForType()

public Probe.Builder newBuilderForType()
Returns
TypeDescription
Probe.Builder

newBuilderForType(GeneratedMessageV3.BuilderParent parent)

protected Probe.Builder newBuilderForType(GeneratedMessageV3.BuilderParent parent)
Parameter
NameDescription
parentBuilderParent
Returns
TypeDescription
Probe.Builder
Overrides

newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)

protected Object newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)
Parameter
NameDescription
unusedUnusedPrivateParameter
Returns
TypeDescription
Object
Overrides

toBuilder()

public Probe.Builder toBuilder()
Returns
TypeDescription
Probe.Builder

writeTo(CodedOutputStream output)

public void writeTo(CodedOutputStream output)
Parameter
NameDescription
outputCodedOutputStream
Overrides
Exceptions
TypeDescription
IOException