com.google.cloud.aiplatform.v1

Class Probe

java.lang.Object

com.google.protobuf.AbstractMessageLite

com.google.protobuf.AbstractMessage

com.google.protobuf.GeneratedMessageV3

com.google.cloud.aiplatform.v1.Probe

All Implemented Interfaces:

ProbeOrBuilder, com.google.protobuf.Message, com.google.protobuf.MessageLite, com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder, Serializable

public final class Probe
extends com.google.protobuf.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

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	Probe.Builder Probe describes a health check to be performed against a container to determine whether it is alive or ready to receive traffic.
static class	Probe.ExecAction ExecAction specifies a command to execute.
static interface	Probe.ExecActionOrBuilder
static class	Probe.GrpcAction GrpcAction checks the health of a container using a gRPC service.
static interface	Probe.GrpcActionOrBuilder
static class	Probe.HttpGetAction HttpGetAction describes an action based on HTTP Get requests.
static interface	Probe.HttpGetActionOrBuilder
static class	Probe.HttpHeader HttpHeader describes a custom header to be used in HTTP probes Protobuf type google.cloud.aiplatform.v1.Probe.HttpHeader
static interface	Probe.HttpHeaderOrBuilder
static class	Probe.ProbeTypeCase
static class	Probe.TcpSocketAction TcpSocketAction probes the health of a container by opening a TCP socket connection.
static interface	Probe.TcpSocketActionOrBuilder

Nested classes/interfaces inherited from class com.google.protobuf.GeneratedMessageV3

com.google.protobuf.GeneratedMessageV3.BuilderParent, com.google.protobuf.GeneratedMessageV3.ExtendableBuilder<MessageT extends com.google.protobuf.GeneratedMessageV3.ExtendableMessage<MessageT>,BuilderT extends com.google.protobuf.GeneratedMessageV3.ExtendableBuilder<MessageT,BuilderT>>, com.google.protobuf.GeneratedMessageV3.ExtendableMessage<MessageT extends com.google.protobuf.GeneratedMessageV3.ExtendableMessage<MessageT>>, com.google.protobuf.GeneratedMessageV3.ExtendableMessageOrBuilder<MessageT extends com.google.protobuf.GeneratedMessageV3.ExtendableMessage<MessageT>>, com.google.protobuf.GeneratedMessageV3.FieldAccessorTable, com.google.protobuf.GeneratedMessageV3.UnusedPrivateParameter

Nested classes/interfaces inherited from class com.google.protobuf.AbstractMessageLite

com.google.protobuf.AbstractMessageLite.InternalOneOfEnum

Field Summary

Fields

Modifier and Type	Field and Description
static int	EXEC_FIELD_NUMBER
static int	FAILURE_THRESHOLD_FIELD_NUMBER
static int	GRPC_FIELD_NUMBER
static int	HTTP_GET_FIELD_NUMBER
static int	INITIAL_DELAY_SECONDS_FIELD_NUMBER
static int	PERIOD_SECONDS_FIELD_NUMBER
static int	SUCCESS_THRESHOLD_FIELD_NUMBER
static int	TCP_SOCKET_FIELD_NUMBER
static int	TIMEOUT_SECONDS_FIELD_NUMBER

Fields inherited from class com.google.protobuf.GeneratedMessageV3

alwaysUseFieldBuilders, unknownFields

Fields inherited from class com.google.protobuf.AbstractMessage

memoizedSize

Fields inherited from class com.google.protobuf.AbstractMessageLite

memoizedHashCode

Method Summary

Modifier and Type	Method and Description
boolean	equals(Object obj)
static Probe	getDefaultInstance()
Probe	getDefaultInstanceForType()
static com.google.protobuf.Descriptors.Descriptor	getDescriptor()
Probe.ExecAction	getExec() ExecAction probes the health of a container by executing a command.
Probe.ExecActionOrBuilder	getExecOrBuilder() ExecAction probes the health of a container by executing a command.
int	getFailureThreshold() Number of consecutive failures before the probe is considered failed.
Probe.GrpcAction	getGrpc() GrpcAction probes the health of a container by sending a gRPC request.
Probe.GrpcActionOrBuilder	getGrpcOrBuilder() GrpcAction probes the health of a container by sending a gRPC request.
Probe.HttpGetAction	getHttpGet() HttpGetAction probes the health of a container by sending an HTTP GET request.
Probe.HttpGetActionOrBuilder	getHttpGetOrBuilder() HttpGetAction probes the health of a container by sending an HTTP GET request.
int	getInitialDelaySeconds() Number of seconds to wait before starting the probe.
com.google.protobuf.Parser<Probe>	getParserForType()
int	getPeriodSeconds() How often (in seconds) to perform the probe.
Probe.ProbeTypeCase	getProbeTypeCase()
int	getSerializedSize()
int	getSuccessThreshold() Number of consecutive successes before the probe is considered successful.
Probe.TcpSocketAction	getTcpSocket() TcpSocketAction probes the health of a container by opening a TCP socket connection.
Probe.TcpSocketActionOrBuilder	getTcpSocketOrBuilder() TcpSocketAction probes the health of a container by opening a TCP socket connection.
int	getTimeoutSeconds() Number of seconds after which the probe times out.
boolean	hasExec() ExecAction probes the health of a container by executing a command.
boolean	hasGrpc() GrpcAction probes the health of a container by sending a gRPC request.
int	hashCode()
boolean	hasHttpGet() HttpGetAction probes the health of a container by sending an HTTP GET request.
boolean	hasTcpSocket() TcpSocketAction probes the health of a container by opening a TCP socket connection.
protected com.google.protobuf.GeneratedMessageV3.FieldAccessorTable	internalGetFieldAccessorTable()
boolean	isInitialized()
static Probe.Builder	newBuilder()
static Probe.Builder	newBuilder(Probe prototype)
Probe.Builder	newBuilderForType()
protected Probe.Builder	newBuilderForType(com.google.protobuf.GeneratedMessageV3.BuilderParent parent)
protected Object	newInstance(com.google.protobuf.GeneratedMessageV3.UnusedPrivateParameter unused)
static Probe	parseDelimitedFrom(InputStream input)
static Probe	parseDelimitedFrom(InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
static Probe	parseFrom(byte[] data)
static Probe	parseFrom(byte[] data, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
static Probe	parseFrom(ByteBuffer data)
static Probe	parseFrom(ByteBuffer data, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
static Probe	parseFrom(com.google.protobuf.ByteString data)
static Probe	parseFrom(com.google.protobuf.ByteString data, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
static Probe	parseFrom(com.google.protobuf.CodedInputStream input)
static Probe	parseFrom(com.google.protobuf.CodedInputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
static Probe	parseFrom(InputStream input)
static Probe	parseFrom(InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
static com.google.protobuf.Parser<Probe>	parser()
Probe.Builder	toBuilder()
void	writeTo(com.google.protobuf.CodedOutputStream output)

Methods inherited from class com.google.protobuf.GeneratedMessageV3

canUseUnsafe, computeStringSize, computeStringSizeNoTag, emptyBooleanList, emptyDoubleList, emptyFloatList, emptyIntList, emptyList, emptyLongList, getAllFields, getDescriptorForType, getField, getOneofFieldDescriptor, getRepeatedField, getRepeatedFieldCount, getUnknownFields, hasField, hasOneof, internalGetMapField, internalGetMapFieldReflection, isStringEmpty, makeExtensionsImmutable, makeMutableCopy, makeMutableCopy, mergeFromAndMakeImmutableInternal, mutableCopy, mutableCopy, mutableCopy, mutableCopy, mutableCopy, newBooleanList, newBuilderForType, newDoubleList, newFloatList, newIntList, newLongList, parseDelimitedWithIOException, parseDelimitedWithIOException, parseUnknownField, parseUnknownFieldProto3, parseWithIOException, parseWithIOException, parseWithIOException, parseWithIOException, serializeBooleanMapTo, serializeIntegerMapTo, serializeLongMapTo, serializeStringMapTo, writeReplace, writeString, writeStringNoTag

Methods inherited from class com.google.protobuf.AbstractMessage

findInitializationErrors, getInitializationErrorString, hashBoolean, hashEnum, hashEnumList, hashFields, hashLong, toString

Methods inherited from class com.google.protobuf.AbstractMessageLite

addAll, addAll, checkByteStringIsUtf8, toByteArray, toByteString, writeDelimitedTo, writeTo

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface com.google.protobuf.MessageOrBuilder

findInitializationErrors, getAllFields, getDescriptorForType, getField, getInitializationErrorString, getOneofFieldDescriptor, getRepeatedField, getRepeatedFieldCount, getUnknownFields, hasField, hasOneof

Methods inherited from interface com.google.protobuf.MessageLite

toByteArray, toByteString, writeDelimitedTo, writeTo

Field Detail

EXEC_FIELD_NUMBER

public static final int EXEC_FIELD_NUMBER

See Also:

Constant Field Values

HTTP_GET_FIELD_NUMBER

public static final int HTTP_GET_FIELD_NUMBER

See Also:

Constant Field Values

GRPC_FIELD_NUMBER

public static final int GRPC_FIELD_NUMBER

See Also:

Constant Field Values

TCP_SOCKET_FIELD_NUMBER

public static final int TCP_SOCKET_FIELD_NUMBER

See Also:

Constant Field Values

PERIOD_SECONDS_FIELD_NUMBER

public static final int PERIOD_SECONDS_FIELD_NUMBER

See Also:

Constant Field Values

TIMEOUT_SECONDS_FIELD_NUMBER

public static final int TIMEOUT_SECONDS_FIELD_NUMBER

See Also:

Constant Field Values

FAILURE_THRESHOLD_FIELD_NUMBER

public static final int FAILURE_THRESHOLD_FIELD_NUMBER

See Also:

Constant Field Values

SUCCESS_THRESHOLD_FIELD_NUMBER

public static final int SUCCESS_THRESHOLD_FIELD_NUMBER

See Also:

Constant Field Values

INITIAL_DELAY_SECONDS_FIELD_NUMBER

public static final int INITIAL_DELAY_SECONDS_FIELD_NUMBER

See Also:

Constant Field Values

Method Detail

newInstance

protected Object newInstance(com.google.protobuf.GeneratedMessageV3.UnusedPrivateParameter unused)

Overrides:

newInstance in class com.google.protobuf.GeneratedMessageV3

getDescriptor

public static final com.google.protobuf.Descriptors.Descriptor getDescriptor()

internalGetFieldAccessorTable

protected com.google.protobuf.GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()

Specified by:

internalGetFieldAccessorTable in class com.google.protobuf.GeneratedMessageV3

getProbeTypeCase

public Probe.ProbeTypeCase getProbeTypeCase()

Specified by:

getProbeTypeCase in interface ProbeOrBuilder

hasExec

public boolean hasExec()

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

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

Specified by:

hasExec in interface ProbeOrBuilder

Returns:

Whether the exec field is set.

getExec

public Probe.ExecAction getExec()

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

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

Specified by:

getExec in interface ProbeOrBuilder

Returns:

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;

Specified by:

getExecOrBuilder in interface ProbeOrBuilder

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;

Specified by:

hasHttpGet in interface ProbeOrBuilder

Returns:

Whether the httpGet field is set.

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;

Specified by:

getHttpGet in interface ProbeOrBuilder

Returns:

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;

Specified by:

getHttpGetOrBuilder in interface ProbeOrBuilder

hasGrpc

public boolean hasGrpc()

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

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

Specified by:

hasGrpc in interface ProbeOrBuilder

Returns:

Whether the grpc field is set.

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;

Specified by:

getGrpc in interface ProbeOrBuilder

Returns:

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;

Specified by:

getGrpcOrBuilder in interface ProbeOrBuilder

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;

Specified by:

hasTcpSocket in interface ProbeOrBuilder

Returns:

Whether the tcpSocket field is set.

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;

Specified by:

getTcpSocket in interface ProbeOrBuilder

Returns:

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;

Specified by:

getTcpSocketOrBuilder in interface ProbeOrBuilder

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;

Specified by:

getPeriodSeconds in interface ProbeOrBuilder

Returns:

The periodSeconds.

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;

Specified by:

getTimeoutSeconds in interface ProbeOrBuilder

Returns:

The timeoutSeconds.

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;

Specified by:

getFailureThreshold in interface ProbeOrBuilder

Returns:

The failureThreshold.

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;

Specified by:

getSuccessThreshold in interface ProbeOrBuilder

Returns:

The successThreshold.

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;

Specified by:

getInitialDelaySeconds in interface ProbeOrBuilder

Returns:

The initialDelaySeconds.

isInitialized

public final boolean isInitialized()

Specified by:

isInitialized in interface com.google.protobuf.MessageLiteOrBuilder

Overrides:

isInitialized in class com.google.protobuf.GeneratedMessageV3

writeTo

public void writeTo(com.google.protobuf.CodedOutputStream output)
             throws IOException

Specified by:

writeTo in interface com.google.protobuf.MessageLite

Overrides:

writeTo in class com.google.protobuf.GeneratedMessageV3

Throws:

IOException

getSerializedSize

public int getSerializedSize()

Specified by:

getSerializedSize in interface com.google.protobuf.MessageLite

Overrides:

getSerializedSize in class com.google.protobuf.GeneratedMessageV3

equals

public boolean equals(Object obj)

Specified by:

equals in interface com.google.protobuf.Message

Overrides:

equals in class com.google.protobuf.AbstractMessage

hashCode

public int hashCode()

Specified by:

hashCode in interface com.google.protobuf.Message

Overrides:

hashCode in class com.google.protobuf.AbstractMessage

parseFrom

public static Probe parseFrom(ByteBuffer data)
                       throws com.google.protobuf.InvalidProtocolBufferException

Throws:

com.google.protobuf.InvalidProtocolBufferException

parseFrom

public static Probe parseFrom(ByteBuffer data,
                              com.google.protobuf.ExtensionRegistryLite extensionRegistry)
                       throws com.google.protobuf.InvalidProtocolBufferException

Throws:

com.google.protobuf.InvalidProtocolBufferException

parseFrom

public static Probe parseFrom(com.google.protobuf.ByteString data)
                       throws com.google.protobuf.InvalidProtocolBufferException

Throws:

com.google.protobuf.InvalidProtocolBufferException

parseFrom

public static Probe parseFrom(com.google.protobuf.ByteString data,
                              com.google.protobuf.ExtensionRegistryLite extensionRegistry)
                       throws com.google.protobuf.InvalidProtocolBufferException

Throws:

com.google.protobuf.InvalidProtocolBufferException

parseFrom

public static Probe parseFrom(byte[] data)
                       throws com.google.protobuf.InvalidProtocolBufferException

Throws:

com.google.protobuf.InvalidProtocolBufferException

parseFrom

public static Probe parseFrom(byte[] data,
                              com.google.protobuf.ExtensionRegistryLite extensionRegistry)
                       throws com.google.protobuf.InvalidProtocolBufferException

Throws:

com.google.protobuf.InvalidProtocolBufferException

parseFrom

public static Probe parseFrom(InputStream input)
                       throws IOException

Throws:

IOException

parseFrom

public static Probe parseFrom(InputStream input,
                              com.google.protobuf.ExtensionRegistryLite extensionRegistry)
                       throws IOException

Throws:

IOException

parseDelimitedFrom

public static Probe parseDelimitedFrom(InputStream input)
                                throws IOException

Throws:

IOException

parseDelimitedFrom

public static Probe parseDelimitedFrom(InputStream input,
                                       com.google.protobuf.ExtensionRegistryLite extensionRegistry)
                                throws IOException

Throws:

IOException

parseFrom

public static Probe parseFrom(com.google.protobuf.CodedInputStream input)
                       throws IOException

Throws:

IOException

parseFrom

public static Probe parseFrom(com.google.protobuf.CodedInputStream input,
                              com.google.protobuf.ExtensionRegistryLite extensionRegistry)
                       throws IOException

Throws:

IOException

newBuilderForType

public Probe.Builder newBuilderForType()

Specified by:

newBuilderForType in interface com.google.protobuf.Message

Specified by:

newBuilderForType in interface com.google.protobuf.MessageLite

newBuilder

public static Probe.Builder newBuilder()

newBuilder

public static Probe.Builder newBuilder(Probe prototype)

toBuilder

public Probe.Builder toBuilder()

Specified by:

toBuilder in interface com.google.protobuf.Message

Specified by:

toBuilder in interface com.google.protobuf.MessageLite

newBuilderForType

protected Probe.Builder newBuilderForType(com.google.protobuf.GeneratedMessageV3.BuilderParent parent)

Specified by:

newBuilderForType in class com.google.protobuf.GeneratedMessageV3

getDefaultInstance

public static Probe getDefaultInstance()

parser

public static com.google.protobuf.Parser<Probe> parser()

getParserForType

public com.google.protobuf.Parser<Probe> getParserForType()

Specified by:

getParserForType in interface com.google.protobuf.Message

Specified by:

getParserForType in interface com.google.protobuf.MessageLite

Overrides:

getParserForType in class com.google.protobuf.GeneratedMessageV3

getDefaultInstanceForType

public Probe getDefaultInstanceForType()

Specified by:

getDefaultInstanceForType in interface com.google.protobuf.MessageLiteOrBuilder

Specified by:

getDefaultInstanceForType in interface com.google.protobuf.MessageOrBuilder