Class: Google::Cloud::AIPlatform::V1::Probe

Inherits:
Object
  • Object
show all
Extended by:
Protobuf::MessageExts::ClassMethods
Includes:
Protobuf::MessageExts
Defined in:
proto_docs/google/cloud/aiplatform/v1/model.rb

Overview

Probe describes a health check to be performed against a container to determine whether it is alive or ready to receive traffic.

Defined Under Namespace

Classes: ExecAction, GrpcAction, HttpGetAction, HttpHeader, TcpSocketAction

Instance Attribute Summary collapse

Instance Attribute Details

#exec ⇒ ::Google::Cloud::AIPlatform::V1::Probe::ExecAction

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

Note: The following fields are mutually exclusive: exec, http_get, grpc, tcp_socket. If a field in that set is populated, all other fields in the set will automatically be cleared.

Returns:

  • (::Google::Cloud::AIPlatform::V1::Probe::ExecAction) —

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

    Note: The following fields are mutually exclusive: exec, http_get, grpc, tcp_socket. If a field in that set is populated, all other fields in the set will automatically be cleared.



918
919
920
921
922
923
924
925
926
927
928
929
930
931
932
933
934
935
936
937
938
939
940
941
942
943
944
945
946
947
948
949
950
951
952
953
954
955
956
957
958
959
960
961
962
963
964
965
966
967
968
969
970
971
972
973
974
975
976
977
978
979
980
981
982
983
984
985
986
987
988
989
990
991
992
993
994
995
996
997
998
999
1000
1001
1002
1003
1004
 
# File 'proto_docs/google/cloud/aiplatform/v1/model.rb', line 918

class Probe
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods

  # ExecAction specifies a command to execute.
  # @!attribute [rw] command
  #   @return [::Array<::String>]
  #     Command is the command line to execute inside the container, the working
  #     directory for the command is root ('/') in the container's filesystem.
  #     The command is simply exec'd, it is not run inside a shell, so
  #     traditional shell instructions ('|', etc) won't work. To use a shell, you
  #     need to explicitly call out to that shell. Exit status of 0 is treated as
  #     live/healthy and non-zero is unhealthy.
  class ExecAction
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # HttpGetAction describes an action based on HTTP Get requests.
  # @!attribute [rw] path
  #   @return [::String]
  #     Path to access on the HTTP server.
  # @!attribute [rw] port
  #   @return [::Integer]
  #     Number of the port to access on the container.
  #     Number must be in the range 1 to 65535.
  # @!attribute [rw] host
  #   @return [::String]
  #     Host name to connect to, defaults to the model serving container's IP.
  #     You probably want to set "Host" in httpHeaders instead.
  # @!attribute [rw] scheme
  #   @return [::String]
  #     Scheme to use for connecting to the host.
  #     Defaults to HTTP. Acceptable values are "HTTP" or "HTTPS".
  # @!attribute [rw] http_headers
  #   @return [::Array<::Google::Cloud::AIPlatform::V1::Probe::HttpHeader>]
  #     Custom headers to set in the request. HTTP allows repeated headers.
  class HttpGetAction
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # GrpcAction checks the health of a container using a gRPC service.
  # @!attribute [rw] port
  #   @return [::Integer]
  #     Port number of the gRPC service. Number must be in the range 1 to 65535.
  # @!attribute [rw] service
  #   @return [::String]
  #     Service is the name of the service to place in the gRPC
  #     HealthCheckRequest (see
  #     https://github.com/grpc/grpc/blob/master/doc/health-checking.md).
  #
  #     If this is not specified, the default behavior is defined by gRPC.
  class GrpcAction
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # TcpSocketAction probes the health of a container by opening a TCP socket
  # connection.
  # @!attribute [rw] port
  #   @return [::Integer]
  #     Number of the port to access on the container.
  #     Number must be in the range 1 to 65535.
  # @!attribute [rw] host
  #   @return [::String]
  #     Optional: Host name to connect to, defaults to the model serving
  #     container's IP.
  class TcpSocketAction
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # HttpHeader describes a custom header to be used in HTTP probes
  # @!attribute [rw] name
  #   @return [::String]
  #     The header field name.
  #     This will be canonicalized upon output, so case-variant names will be
  #     understood as the same header.
  # @!attribute [rw] value
  #   @return [::String]
  #     The header field value
  class HttpHeader
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end
end

#failure_threshold ⇒ ::Integer

Returns Number of consecutive failures before the probe is considered failed. Defaults to 3. Minimum value is 1.

Maps to Kubernetes probe argument 'failureThreshold'.

Returns:

  • (::Integer) —

    Number of consecutive failures before the probe is considered failed. Defaults to 3. Minimum value is 1.

    Maps to Kubernetes probe argument 'failureThreshold'.



918
919
920
921
922
923
924
925
926
927
928
929
930
931
932
933
934
935
936
937
938
939
940
941
942
943
944
945
946
947
948
949
950
951
952
953
954
955
956
957
958
959
960
961
962
963
964
965
966
967
968
969
970
971
972
973
974
975
976
977
978
979
980
981
982
983
984
985
986
987
988
989
990
991
992
993
994
995
996
997
998
999
1000
1001
1002
1003
1004
 
# File 'proto_docs/google/cloud/aiplatform/v1/model.rb', line 918

class Probe
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods

  # ExecAction specifies a command to execute.
  # @!attribute [rw] command
  #   @return [::Array<::String>]
  #     Command is the command line to execute inside the container, the working
  #     directory for the command is root ('/') in the container's filesystem.
  #     The command is simply exec'd, it is not run inside a shell, so
  #     traditional shell instructions ('|', etc) won't work. To use a shell, you
  #     need to explicitly call out to that shell. Exit status of 0 is treated as
  #     live/healthy and non-zero is unhealthy.
  class ExecAction
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # HttpGetAction describes an action based on HTTP Get requests.
  # @!attribute [rw] path
  #   @return [::String]
  #     Path to access on the HTTP server.
  # @!attribute [rw] port
  #   @return [::Integer]
  #     Number of the port to access on the container.
  #     Number must be in the range 1 to 65535.
  # @!attribute [rw] host
  #   @return [::String]
  #     Host name to connect to, defaults to the model serving container's IP.
  #     You probably want to set "Host" in httpHeaders instead.
  # @!attribute [rw] scheme
  #   @return [::String]
  #     Scheme to use for connecting to the host.
  #     Defaults to HTTP. Acceptable values are "HTTP" or "HTTPS".
  # @!attribute [rw] http_headers
  #   @return [::Array<::Google::Cloud::AIPlatform::V1::Probe::HttpHeader>]
  #     Custom headers to set in the request. HTTP allows repeated headers.
  class HttpGetAction
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # GrpcAction checks the health of a container using a gRPC service.
  # @!attribute [rw] port
  #   @return [::Integer]
  #     Port number of the gRPC service. Number must be in the range 1 to 65535.
  # @!attribute [rw] service
  #   @return [::String]
  #     Service is the name of the service to place in the gRPC
  #     HealthCheckRequest (see
  #     https://github.com/grpc/grpc/blob/master/doc/health-checking.md).
  #
  #     If this is not specified, the default behavior is defined by gRPC.
  class GrpcAction
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # TcpSocketAction probes the health of a container by opening a TCP socket
  # connection.
  # @!attribute [rw] port
  #   @return [::Integer]
  #     Number of the port to access on the container.
  #     Number must be in the range 1 to 65535.
  # @!attribute [rw] host
  #   @return [::String]
  #     Optional: Host name to connect to, defaults to the model serving
  #     container's IP.
  class TcpSocketAction
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # HttpHeader describes a custom header to be used in HTTP probes
  # @!attribute [rw] name
  #   @return [::String]
  #     The header field name.
  #     This will be canonicalized upon output, so case-variant names will be
  #     understood as the same header.
  # @!attribute [rw] value
  #   @return [::String]
  #     The header field value
  class HttpHeader
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end
end

#grpc ⇒ ::Google::Cloud::AIPlatform::V1::Probe::GrpcAction

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

Note: The following fields are mutually exclusive: grpc, exec, http_get, tcp_socket. If a field in that set is populated, all other fields in the set will automatically be cleared.

Returns:

  • (::Google::Cloud::AIPlatform::V1::Probe::GrpcAction) —

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

    Note: The following fields are mutually exclusive: grpc, exec, http_get, tcp_socket. If a field in that set is populated, all other fields in the set will automatically be cleared.



918
919
920
921
922
923
924
925
926
927
928
929
930
931
932
933
934
935
936
937
938
939
940
941
942
943
944
945
946
947
948
949
950
951
952
953
954
955
956
957
958
959
960
961
962
963
964
965
966
967
968
969
970
971
972
973
974
975
976
977
978
979
980
981
982
983
984
985
986
987
988
989
990
991
992
993
994
995
996
997
998
999
1000
1001
1002
1003
1004
 
# File 'proto_docs/google/cloud/aiplatform/v1/model.rb', line 918

class Probe
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods

  # ExecAction specifies a command to execute.
  # @!attribute [rw] command
  #   @return [::Array<::String>]
  #     Command is the command line to execute inside the container, the working
  #     directory for the command is root ('/') in the container's filesystem.
  #     The command is simply exec'd, it is not run inside a shell, so
  #     traditional shell instructions ('|', etc) won't work. To use a shell, you
  #     need to explicitly call out to that shell. Exit status of 0 is treated as
  #     live/healthy and non-zero is unhealthy.
  class ExecAction
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # HttpGetAction describes an action based on HTTP Get requests.
  # @!attribute [rw] path
  #   @return [::String]
  #     Path to access on the HTTP server.
  # @!attribute [rw] port
  #   @return [::Integer]
  #     Number of the port to access on the container.
  #     Number must be in the range 1 to 65535.
  # @!attribute [rw] host
  #   @return [::String]
  #     Host name to connect to, defaults to the model serving container's IP.
  #     You probably want to set "Host" in httpHeaders instead.
  # @!attribute [rw] scheme
  #   @return [::String]
  #     Scheme to use for connecting to the host.
  #     Defaults to HTTP. Acceptable values are "HTTP" or "HTTPS".
  # @!attribute [rw] http_headers
  #   @return [::Array<::Google::Cloud::AIPlatform::V1::Probe::HttpHeader>]
  #     Custom headers to set in the request. HTTP allows repeated headers.
  class HttpGetAction
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # GrpcAction checks the health of a container using a gRPC service.
  # @!attribute [rw] port
  #   @return [::Integer]
  #     Port number of the gRPC service. Number must be in the range 1 to 65535.
  # @!attribute [rw] service
  #   @return [::String]
  #     Service is the name of the service to place in the gRPC
  #     HealthCheckRequest (see
  #     https://github.com/grpc/grpc/blob/master/doc/health-checking.md).
  #
  #     If this is not specified, the default behavior is defined by gRPC.
  class GrpcAction
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # TcpSocketAction probes the health of a container by opening a TCP socket
  # connection.
  # @!attribute [rw] port
  #   @return [::Integer]
  #     Number of the port to access on the container.
  #     Number must be in the range 1 to 65535.
  # @!attribute [rw] host
  #   @return [::String]
  #     Optional: Host name to connect to, defaults to the model serving
  #     container's IP.
  class TcpSocketAction
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # HttpHeader describes a custom header to be used in HTTP probes
  # @!attribute [rw] name
  #   @return [::String]
  #     The header field name.
  #     This will be canonicalized upon output, so case-variant names will be
  #     understood as the same header.
  # @!attribute [rw] value
  #   @return [::String]
  #     The header field value
  class HttpHeader
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end
end

#http_get ⇒ ::Google::Cloud::AIPlatform::V1::Probe::HttpGetAction

Returns HttpGetAction probes the health of a container by sending an HTTP GET request.

Note: The following fields are mutually exclusive: http_get, exec, grpc, tcp_socket. If a field in that set is populated, all other fields in the set will automatically be cleared.

Returns:

  • (::Google::Cloud::AIPlatform::V1::Probe::HttpGetAction) —

    HttpGetAction probes the health of a container by sending an HTTP GET request.

    Note: The following fields are mutually exclusive: http_get, exec, grpc, tcp_socket. If a field in that set is populated, all other fields in the set will automatically be cleared.



918
919
920
921
922
923
924
925
926
927
928
929
930
931
932
933
934
935
936
937
938
939
940
941
942
943
944
945
946
947
948
949
950
951
952
953
954
955
956
957
958
959
960
961
962
963
964
965
966
967
968
969
970
971
972
973
974
975
976
977
978
979
980
981
982
983
984
985
986
987
988
989
990
991
992
993
994
995
996
997
998
999
1000
1001
1002
1003
1004
 
# File 'proto_docs/google/cloud/aiplatform/v1/model.rb', line 918

class Probe
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods

  # ExecAction specifies a command to execute.
  # @!attribute [rw] command
  #   @return [::Array<::String>]
  #     Command is the command line to execute inside the container, the working
  #     directory for the command is root ('/') in the container's filesystem.
  #     The command is simply exec'd, it is not run inside a shell, so
  #     traditional shell instructions ('|', etc) won't work. To use a shell, you
  #     need to explicitly call out to that shell. Exit status of 0 is treated as
  #     live/healthy and non-zero is unhealthy.
  class ExecAction
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # HttpGetAction describes an action based on HTTP Get requests.
  # @!attribute [rw] path
  #   @return [::String]
  #     Path to access on the HTTP server.
  # @!attribute [rw] port
  #   @return [::Integer]
  #     Number of the port to access on the container.
  #     Number must be in the range 1 to 65535.
  # @!attribute [rw] host
  #   @return [::String]
  #     Host name to connect to, defaults to the model serving container's IP.
  #     You probably want to set "Host" in httpHeaders instead.
  # @!attribute [rw] scheme
  #   @return [::String]
  #     Scheme to use for connecting to the host.
  #     Defaults to HTTP. Acceptable values are "HTTP" or "HTTPS".
  # @!attribute [rw] http_headers
  #   @return [::Array<::Google::Cloud::AIPlatform::V1::Probe::HttpHeader>]
  #     Custom headers to set in the request. HTTP allows repeated headers.
  class HttpGetAction
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # GrpcAction checks the health of a container using a gRPC service.
  # @!attribute [rw] port
  #   @return [::Integer]
  #     Port number of the gRPC service. Number must be in the range 1 to 65535.
  # @!attribute [rw] service
  #   @return [::String]
  #     Service is the name of the service to place in the gRPC
  #     HealthCheckRequest (see
  #     https://github.com/grpc/grpc/blob/master/doc/health-checking.md).
  #
  #     If this is not specified, the default behavior is defined by gRPC.
  class GrpcAction
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # TcpSocketAction probes the health of a container by opening a TCP socket
  # connection.
  # @!attribute [rw] port
  #   @return [::Integer]
  #     Number of the port to access on the container.
  #     Number must be in the range 1 to 65535.
  # @!attribute [rw] host
  #   @return [::String]
  #     Optional: Host name to connect to, defaults to the model serving
  #     container's IP.
  class TcpSocketAction
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # HttpHeader describes a custom header to be used in HTTP probes
  # @!attribute [rw] name
  #   @return [::String]
  #     The header field name.
  #     This will be canonicalized upon output, so case-variant names will be
  #     understood as the same header.
  # @!attribute [rw] value
  #   @return [::String]
  #     The header field value
  class HttpHeader
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end
end

#initial_delay_seconds ⇒ ::Integer

Returns Number of seconds to wait before starting the probe. Defaults to 0. Minimum value is 0.

Maps to Kubernetes probe argument 'initialDelaySeconds'.

Returns:

  • (::Integer) —

    Number of seconds to wait before starting the probe. Defaults to 0. Minimum value is 0.

    Maps to Kubernetes probe argument 'initialDelaySeconds'.



918
919
920
921
922
923
924
925
926
927
928
929
930
931
932
933
934
935
936
937
938
939
940
941
942
943
944
945
946
947
948
949
950
951
952
953
954
955
956
957
958
959
960
961
962
963
964
965
966
967
968
969
970
971
972
973
974
975
976
977
978
979
980
981
982
983
984
985
986
987
988
989
990
991
992
993
994
995
996
997
998
999
1000
1001
1002
1003
1004
 
# File 'proto_docs/google/cloud/aiplatform/v1/model.rb', line 918

class Probe
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods

  # ExecAction specifies a command to execute.
  # @!attribute [rw] command
  #   @return [::Array<::String>]
  #     Command is the command line to execute inside the container, the working
  #     directory for the command is root ('/') in the container's filesystem.
  #     The command is simply exec'd, it is not run inside a shell, so
  #     traditional shell instructions ('|', etc) won't work. To use a shell, you
  #     need to explicitly call out to that shell. Exit status of 0 is treated as
  #     live/healthy and non-zero is unhealthy.
  class ExecAction
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # HttpGetAction describes an action based on HTTP Get requests.
  # @!attribute [rw] path
  #   @return [::String]
  #     Path to access on the HTTP server.
  # @!attribute [rw] port
  #   @return [::Integer]
  #     Number of the port to access on the container.
  #     Number must be in the range 1 to 65535.
  # @!attribute [rw] host
  #   @return [::String]
  #     Host name to connect to, defaults to the model serving container's IP.
  #     You probably want to set "Host" in httpHeaders instead.
  # @!attribute [rw] scheme
  #   @return [::String]
  #     Scheme to use for connecting to the host.
  #     Defaults to HTTP. Acceptable values are "HTTP" or "HTTPS".
  # @!attribute [rw] http_headers
  #   @return [::Array<::Google::Cloud::AIPlatform::V1::Probe::HttpHeader>]
  #     Custom headers to set in the request. HTTP allows repeated headers.
  class HttpGetAction
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # GrpcAction checks the health of a container using a gRPC service.
  # @!attribute [rw] port
  #   @return [::Integer]
  #     Port number of the gRPC service. Number must be in the range 1 to 65535.
  # @!attribute [rw] service
  #   @return [::String]
  #     Service is the name of the service to place in the gRPC
  #     HealthCheckRequest (see
  #     https://github.com/grpc/grpc/blob/master/doc/health-checking.md).
  #
  #     If this is not specified, the default behavior is defined by gRPC.
  class GrpcAction
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # TcpSocketAction probes the health of a container by opening a TCP socket
  # connection.
  # @!attribute [rw] port
  #   @return [::Integer]
  #     Number of the port to access on the container.
  #     Number must be in the range 1 to 65535.
  # @!attribute [rw] host
  #   @return [::String]
  #     Optional: Host name to connect to, defaults to the model serving
  #     container's IP.
  class TcpSocketAction
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # HttpHeader describes a custom header to be used in HTTP probes
  # @!attribute [rw] name
  #   @return [::String]
  #     The header field name.
  #     This will be canonicalized upon output, so case-variant names will be
  #     understood as the same header.
  # @!attribute [rw] value
  #   @return [::String]
  #     The header field value
  class HttpHeader
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end
end

#period_seconds ⇒ ::Integer

Returns 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'.

Returns:

  • (::Integer) —

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



918
919
920
921
922
923
924
925
926
927
928
929
930
931
932
933
934
935
936
937
938
939
940
941
942
943
944
945
946
947
948
949
950
951
952
953
954
955
956
957
958
959
960
961
962
963
964
965
966
967
968
969
970
971
972
973
974
975
976
977
978
979
980
981
982
983
984
985
986
987
988
989
990
991
992
993
994
995
996
997
998
999
1000
1001
1002
1003
1004
 
# File 'proto_docs/google/cloud/aiplatform/v1/model.rb', line 918

class Probe
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods

  # ExecAction specifies a command to execute.
  # @!attribute [rw] command
  #   @return [::Array<::String>]
  #     Command is the command line to execute inside the container, the working
  #     directory for the command is root ('/') in the container's filesystem.
  #     The command is simply exec'd, it is not run inside a shell, so
  #     traditional shell instructions ('|', etc) won't work. To use a shell, you
  #     need to explicitly call out to that shell. Exit status of 0 is treated as
  #     live/healthy and non-zero is unhealthy.
  class ExecAction
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # HttpGetAction describes an action based on HTTP Get requests.
  # @!attribute [rw] path
  #   @return [::String]
  #     Path to access on the HTTP server.
  # @!attribute [rw] port
  #   @return [::Integer]
  #     Number of the port to access on the container.
  #     Number must be in the range 1 to 65535.
  # @!attribute [rw] host
  #   @return [::String]
  #     Host name to connect to, defaults to the model serving container's IP.
  #     You probably want to set "Host" in httpHeaders instead.
  # @!attribute [rw] scheme
  #   @return [::String]
  #     Scheme to use for connecting to the host.
  #     Defaults to HTTP. Acceptable values are "HTTP" or "HTTPS".
  # @!attribute [rw] http_headers
  #   @return [::Array<::Google::Cloud::AIPlatform::V1::Probe::HttpHeader>]
  #     Custom headers to set in the request. HTTP allows repeated headers.
  class HttpGetAction
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # GrpcAction checks the health of a container using a gRPC service.
  # @!attribute [rw] port
  #   @return [::Integer]
  #     Port number of the gRPC service. Number must be in the range 1 to 65535.
  # @!attribute [rw] service
  #   @return [::String]
  #     Service is the name of the service to place in the gRPC
  #     HealthCheckRequest (see
  #     https://github.com/grpc/grpc/blob/master/doc/health-checking.md).
  #
  #     If this is not specified, the default behavior is defined by gRPC.
  class GrpcAction
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # TcpSocketAction probes the health of a container by opening a TCP socket
  # connection.
  # @!attribute [rw] port
  #   @return [::Integer]
  #     Number of the port to access on the container.
  #     Number must be in the range 1 to 65535.
  # @!attribute [rw] host
  #   @return [::String]
  #     Optional: Host name to connect to, defaults to the model serving
  #     container's IP.
  class TcpSocketAction
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # HttpHeader describes a custom header to be used in HTTP probes
  # @!attribute [rw] name
  #   @return [::String]
  #     The header field name.
  #     This will be canonicalized upon output, so case-variant names will be
  #     understood as the same header.
  # @!attribute [rw] value
  #   @return [::String]
  #     The header field value
  class HttpHeader
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end
end

#success_threshold ⇒ ::Integer

Returns Number of consecutive successes before the probe is considered successful. Defaults to 1. Minimum value is 1.

Maps to Kubernetes probe argument 'successThreshold'.

Returns:

  • (::Integer) —

    Number of consecutive successes before the probe is considered successful. Defaults to 1. Minimum value is 1.

    Maps to Kubernetes probe argument 'successThreshold'.



918
919
920
921
922
923
924
925
926
927
928
929
930
931
932
933
934
935
936
937
938
939
940
941
942
943
944
945
946
947
948
949
950
951
952
953
954
955
956
957
958
959
960
961
962
963
964
965
966
967
968
969
970
971
972
973
974
975
976
977
978
979
980
981
982
983
984
985
986
987
988
989
990
991
992
993
994
995
996
997
998
999
1000
1001
1002
1003
1004
 
# File 'proto_docs/google/cloud/aiplatform/v1/model.rb', line 918

class Probe
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods

  # ExecAction specifies a command to execute.
  # @!attribute [rw] command
  #   @return [::Array<::String>]
  #     Command is the command line to execute inside the container, the working
  #     directory for the command is root ('/') in the container's filesystem.
  #     The command is simply exec'd, it is not run inside a shell, so
  #     traditional shell instructions ('|', etc) won't work. To use a shell, you
  #     need to explicitly call out to that shell. Exit status of 0 is treated as
  #     live/healthy and non-zero is unhealthy.
  class ExecAction
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # HttpGetAction describes an action based on HTTP Get requests.
  # @!attribute [rw] path
  #   @return [::String]
  #     Path to access on the HTTP server.
  # @!attribute [rw] port
  #   @return [::Integer]
  #     Number of the port to access on the container.
  #     Number must be in the range 1 to 65535.
  # @!attribute [rw] host
  #   @return [::String]
  #     Host name to connect to, defaults to the model serving container's IP.
  #     You probably want to set "Host" in httpHeaders instead.
  # @!attribute [rw] scheme
  #   @return [::String]
  #     Scheme to use for connecting to the host.
  #     Defaults to HTTP. Acceptable values are "HTTP" or "HTTPS".
  # @!attribute [rw] http_headers
  #   @return [::Array<::Google::Cloud::AIPlatform::V1::Probe::HttpHeader>]
  #     Custom headers to set in the request. HTTP allows repeated headers.
  class HttpGetAction
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # GrpcAction checks the health of a container using a gRPC service.
  # @!attribute [rw] port
  #   @return [::Integer]
  #     Port number of the gRPC service. Number must be in the range 1 to 65535.
  # @!attribute [rw] service
  #   @return [::String]
  #     Service is the name of the service to place in the gRPC
  #     HealthCheckRequest (see
  #     https://github.com/grpc/grpc/blob/master/doc/health-checking.md).
  #
  #     If this is not specified, the default behavior is defined by gRPC.
  class GrpcAction
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # TcpSocketAction probes the health of a container by opening a TCP socket
  # connection.
  # @!attribute [rw] port
  #   @return [::Integer]
  #     Number of the port to access on the container.
  #     Number must be in the range 1 to 65535.
  # @!attribute [rw] host
  #   @return [::String]
  #     Optional: Host name to connect to, defaults to the model serving
  #     container's IP.
  class TcpSocketAction
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # HttpHeader describes a custom header to be used in HTTP probes
  # @!attribute [rw] name
  #   @return [::String]
  #     The header field name.
  #     This will be canonicalized upon output, so case-variant names will be
  #     understood as the same header.
  # @!attribute [rw] value
  #   @return [::String]
  #     The header field value
  class HttpHeader
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end
end

#tcp_socket ⇒ ::Google::Cloud::AIPlatform::V1::Probe::TcpSocketAction

Returns TcpSocketAction probes the health of a container by opening a TCP socket connection.

Note: The following fields are mutually exclusive: tcp_socket, exec, http_get, grpc. If a field in that set is populated, all other fields in the set will automatically be cleared.

Returns:

  • (::Google::Cloud::AIPlatform::V1::Probe::TcpSocketAction) —

    TcpSocketAction probes the health of a container by opening a TCP socket connection.

    Note: The following fields are mutually exclusive: tcp_socket, exec, http_get, grpc. If a field in that set is populated, all other fields in the set will automatically be cleared.



918
919
920
921
922
923
924
925
926
927
928
929
930
931
932
933
934
935
936
937
938
939
940
941
942
943
944
945
946
947
948
949
950
951
952
953
954
955
956
957
958
959
960
961
962
963
964
965
966
967
968
969
970
971
972
973
974
975
976
977
978
979
980
981
982
983
984
985
986
987
988
989
990
991
992
993
994
995
996
997
998
999
1000
1001
1002
1003
1004
 
# File 'proto_docs/google/cloud/aiplatform/v1/model.rb', line 918

class Probe
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods

  # ExecAction specifies a command to execute.
  # @!attribute [rw] command
  #   @return [::Array<::String>]
  #     Command is the command line to execute inside the container, the working
  #     directory for the command is root ('/') in the container's filesystem.
  #     The command is simply exec'd, it is not run inside a shell, so
  #     traditional shell instructions ('|', etc) won't work. To use a shell, you
  #     need to explicitly call out to that shell. Exit status of 0 is treated as
  #     live/healthy and non-zero is unhealthy.
  class ExecAction
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # HttpGetAction describes an action based on HTTP Get requests.
  # @!attribute [rw] path
  #   @return [::String]
  #     Path to access on the HTTP server.
  # @!attribute [rw] port
  #   @return [::Integer]
  #     Number of the port to access on the container.
  #     Number must be in the range 1 to 65535.
  # @!attribute [rw] host
  #   @return [::String]
  #     Host name to connect to, defaults to the model serving container's IP.
  #     You probably want to set "Host" in httpHeaders instead.
  # @!attribute [rw] scheme
  #   @return [::String]
  #     Scheme to use for connecting to the host.
  #     Defaults to HTTP. Acceptable values are "HTTP" or "HTTPS".
  # @!attribute [rw] http_headers
  #   @return [::Array<::Google::Cloud::AIPlatform::V1::Probe::HttpHeader>]
  #     Custom headers to set in the request. HTTP allows repeated headers.
  class HttpGetAction
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # GrpcAction checks the health of a container using a gRPC service.
  # @!attribute [rw] port
  #   @return [::Integer]
  #     Port number of the gRPC service. Number must be in the range 1 to 65535.
  # @!attribute [rw] service
  #   @return [::String]
  #     Service is the name of the service to place in the gRPC
  #     HealthCheckRequest (see
  #     https://github.com/grpc/grpc/blob/master/doc/health-checking.md).
  #
  #     If this is not specified, the default behavior is defined by gRPC.
  class GrpcAction
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # TcpSocketAction probes the health of a container by opening a TCP socket
  # connection.
  # @!attribute [rw] port
  #   @return [::Integer]
  #     Number of the port to access on the container.
  #     Number must be in the range 1 to 65535.
  # @!attribute [rw] host
  #   @return [::String]
  #     Optional: Host name to connect to, defaults to the model serving
  #     container's IP.
  class TcpSocketAction
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # HttpHeader describes a custom header to be used in HTTP probes
  # @!attribute [rw] name
  #   @return [::String]
  #     The header field name.
  #     This will be canonicalized upon output, so case-variant names will be
  #     understood as the same header.
  # @!attribute [rw] value
  #   @return [::String]
  #     The header field value
  class HttpHeader
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end
end

#timeout_seconds ⇒ ::Integer

Returns 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'.

Returns:

  • (::Integer) —

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



918
919
920
921
922
923
924
925
926
927
928
929
930
931
932
933
934
935
936
937
938
939
940
941
942
943
944
945
946
947
948
949
950
951
952
953
954
955
956
957
958
959
960
961
962
963
964
965
966
967
968
969
970
971
972
973
974
975
976
977
978
979
980
981
982
983
984
985
986
987
988
989
990
991
992
993
994
995
996
997
998
999
1000
1001
1002
1003
1004
 
# File 'proto_docs/google/cloud/aiplatform/v1/model.rb', line 918

class Probe
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods

  # ExecAction specifies a command to execute.
  # @!attribute [rw] command
  #   @return [::Array<::String>]
  #     Command is the command line to execute inside the container, the working
  #     directory for the command is root ('/') in the container's filesystem.
  #     The command is simply exec'd, it is not run inside a shell, so
  #     traditional shell instructions ('|', etc) won't work. To use a shell, you
  #     need to explicitly call out to that shell. Exit status of 0 is treated as
  #     live/healthy and non-zero is unhealthy.
  class ExecAction
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # HttpGetAction describes an action based on HTTP Get requests.
  # @!attribute [rw] path
  #   @return [::String]
  #     Path to access on the HTTP server.
  # @!attribute [rw] port
  #   @return [::Integer]
  #     Number of the port to access on the container.
  #     Number must be in the range 1 to 65535.
  # @!attribute [rw] host
  #   @return [::String]
  #     Host name to connect to, defaults to the model serving container's IP.
  #     You probably want to set "Host" in httpHeaders instead.
  # @!attribute [rw] scheme
  #   @return [::String]
  #     Scheme to use for connecting to the host.
  #     Defaults to HTTP. Acceptable values are "HTTP" or "HTTPS".
  # @!attribute [rw] http_headers
  #   @return [::Array<::Google::Cloud::AIPlatform::V1::Probe::HttpHeader>]
  #     Custom headers to set in the request. HTTP allows repeated headers.
  class HttpGetAction
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # GrpcAction checks the health of a container using a gRPC service.
  # @!attribute [rw] port
  #   @return [::Integer]
  #     Port number of the gRPC service. Number must be in the range 1 to 65535.
  # @!attribute [rw] service
  #   @return [::String]
  #     Service is the name of the service to place in the gRPC
  #     HealthCheckRequest (see
  #     https://github.com/grpc/grpc/blob/master/doc/health-checking.md).
  #
  #     If this is not specified, the default behavior is defined by gRPC.
  class GrpcAction
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # TcpSocketAction probes the health of a container by opening a TCP socket
  # connection.
  # @!attribute [rw] port
  #   @return [::Integer]
  #     Number of the port to access on the container.
  #     Number must be in the range 1 to 65535.
  # @!attribute [rw] host
  #   @return [::String]
  #     Optional: Host name to connect to, defaults to the model serving
  #     container's IP.
  class TcpSocketAction
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # HttpHeader describes a custom header to be used in HTTP probes
  # @!attribute [rw] name
  #   @return [::String]
  #     The header field name.
  #     This will be canonicalized upon output, so case-variant names will be
  #     understood as the same header.
  # @!attribute [rw] value
  #   @return [::String]
  #     The header field value
  class HttpHeader
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end
end