Package com.google.cloud.aiplatform.v1

Class Probe

java.lang.Object
com.google.protobuf.AbstractMessageLite
com.google.protobuf.AbstractMessage
com.google.protobuf.GeneratedMessage
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
@Generated public final class Probe extends com.google.protobuf.GeneratedMessage 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:

  • Nested Class Summary

    Nested Classes
    Modifier and Type
    Class
    Description
    static final 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 final class 
    Probe.ExecAction
    ExecAction specifies a command to execute.
    static interface 
    Probe.ExecActionOrBuilder
     
    static final class 
    Probe.GrpcAction
    GrpcAction checks the health of a container using a gRPC service.
    static interface 
    Probe.GrpcActionOrBuilder
     
    static final class 
    Probe.HttpGetAction
    HttpGetAction describes an action based on HTTP Get requests.
    static interface 
    Probe.HttpGetActionOrBuilder
     
    static final class 
    Probe.HttpHeader
    HttpHeader describes a custom header to be used in HTTP probes
    static interface 
    Probe.HttpHeaderOrBuilder
     
    static enum 
    Probe.ProbeTypeCase
     
    static final 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.GeneratedMessage

    com.google.protobuf.GeneratedMessage.ExtendableBuilder<MessageT extends com.google.protobuf.GeneratedMessage.ExtendableMessage<MessageT>,BuilderT extends com.google.protobuf.GeneratedMessage.ExtendableBuilder<MessageT,BuilderT>>, com.google.protobuf.GeneratedMessage.ExtendableMessage<MessageT extends com.google.protobuf.GeneratedMessage.ExtendableMessage<MessageT>>, com.google.protobuf.GeneratedMessage.ExtendableMessageOrBuilder<MessageT extends com.google.protobuf.GeneratedMessage.ExtendableMessage<MessageT>>, com.google.protobuf.GeneratedMessage.FieldAccessorTable, com.google.protobuf.GeneratedMessage.GeneratedExtension<ContainingT extends com.google.protobuf.Message,T extends Object>, com.google.protobuf.GeneratedMessage.UnusedPrivateParameter

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

    com.google.protobuf.AbstractMessage.BuilderParent

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

    com.google.protobuf.AbstractMessageLite.InternalOneOfEnum

  • Field Summary

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

    Fields inherited from class com.google.protobuf.GeneratedMessage

    alwaysUseFieldBuilders, loggedPre22TypeNames, 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
    Description
    boolean
    equals(Object obj)
     
    static Probe
    getDefaultInstance()
     
    Probe
    getDefaultInstanceForType()
     
    static final 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.GeneratedMessage.FieldAccessorTable
    internalGetFieldAccessorTable()
     
    final boolean
    isInitialized()
     
    static Probe.Builder
    newBuilder()
     
    static Probe.Builder
    newBuilder(Probe prototype)
     
    Probe.Builder
    newBuilderForType()
     
    protected Probe.Builder
    newBuilderForType(com.google.protobuf.AbstractMessage.BuilderParent parent)
     
    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(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 Probe
    parseFrom(ByteBuffer data)
     
    static Probe
    parseFrom(ByteBuffer data, 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.GeneratedMessage

    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, newFileScopedGeneratedExtension, newInstance, newMessageScopedGeneratedExtension, 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, hashFields, toString

    Methods inherited from class com.google.protobuf.AbstractMessageLite

    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.MessageLite

    toByteArray, toByteString, writeDelimitedTo, writeTo

    Methods inherited from interface com.google.protobuf.MessageOrBuilder

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

  • Field Details

    • EXEC_FIELD_NUMBER

      public static final int EXEC_FIELD_NUMBER
      See Also:

    • HTTP_GET_FIELD_NUMBER

      public static final int HTTP_GET_FIELD_NUMBER
      See Also:

    • GRPC_FIELD_NUMBER

      public static final int GRPC_FIELD_NUMBER
      See Also:

    • TCP_SOCKET_FIELD_NUMBER

      public static final int TCP_SOCKET_FIELD_NUMBER
      See Also:

    • PERIOD_SECONDS_FIELD_NUMBER

      public static final int PERIOD_SECONDS_FIELD_NUMBER
      See Also:

    • TIMEOUT_SECONDS_FIELD_NUMBER

      public static final int TIMEOUT_SECONDS_FIELD_NUMBER
      See Also:

    • FAILURE_THRESHOLD_FIELD_NUMBER

      public static final int FAILURE_THRESHOLD_FIELD_NUMBER
      See Also:

    • SUCCESS_THRESHOLD_FIELD_NUMBER

      public static final int SUCCESS_THRESHOLD_FIELD_NUMBER
      See Also:

    • INITIAL_DELAY_SECONDS_FIELD_NUMBER

      public static final int INITIAL_DELAY_SECONDS_FIELD_NUMBER
      See Also:

  • Method Details

    • getDescriptor

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

    • internalGetFieldAccessorTable

      protected com.google.protobuf.GeneratedMessage.FieldAccessorTable internalGetFieldAccessorTable()
      Specified by:
      internalGetFieldAccessorTable in class com.google.protobuf.GeneratedMessage

    • 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.GeneratedMessage

    • 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.GeneratedMessage
      Throws:
      IOException

    • getSerializedSize

      public int getSerializedSize()
      Specified by:
      getSerializedSize in interface com.google.protobuf.MessageLite
      Overrides:
      getSerializedSize in class com.google.protobuf.GeneratedMessage

    • 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.AbstractMessage.BuilderParent parent)
      Overrides:
      newBuilderForType in class com.google.protobuf.AbstractMessage

    • 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.GeneratedMessage

    • getDefaultInstanceForType

      public Probe getDefaultInstanceForType()
      Specified by:
      getDefaultInstanceForType in interface com.google.protobuf.MessageLiteOrBuilder
      Specified by:
      getDefaultInstanceForType in interface com.google.protobuf.MessageOrBuilder