Struct Probe 

#[non_exhaustive]
pub struct Probe {
    pub period_seconds: i32,
    pub timeout_seconds: i32,
    pub failure_threshold: i32,
    pub success_threshold: i32,
    pub initial_delay_seconds: i32,
    pub probe_type: Option<ProbeType>,
    /* private fields */
}

Available on crate features dataset-service or job-service or model-garden-service or model-service or pipeline-service only.

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

Fields (Non-exhaustive)

Non-exhaustive structs could have additional fields added in future. Therefore, non-exhaustive structs cannot be constructed in external crates using the traditional Struct { .. } syntax; cannot be matched against without a wildcard ..; and struct update syntax will not work.

period_seconds: i32

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

timeout_seconds: i32

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

failure_threshold: i32

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

Maps to Kubernetes probe argument ‘failureThreshold’.

success_threshold: i32

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

Maps to Kubernetes probe argument ‘successThreshold’.

initial_delay_seconds: i32

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

Maps to Kubernetes probe argument ‘initialDelaySeconds’.

probe_type: Option<ProbeType>

Implementations

impl Probe

pub fn new() -> Self

pub fn set_period_seconds<T: Into<i32>>(self, v: T) -> Self

Sets the value of period_seconds.

Example

let x = Probe::new().set_period_seconds(42);

pub fn set_timeout_seconds<T: Into<i32>>(self, v: T) -> Self

Sets the value of timeout_seconds.

Example

let x = Probe::new().set_timeout_seconds(42);

pub fn set_failure_threshold<T: Into<i32>>(self, v: T) -> Self

Sets the value of failure_threshold.

Example

let x = Probe::new().set_failure_threshold(42);

pub fn set_success_threshold<T: Into<i32>>(self, v: T) -> Self

Sets the value of success_threshold.

Example

let x = Probe::new().set_success_threshold(42);

pub fn set_initial_delay_seconds<T: Into<i32>>(self, v: T) -> Self

Sets the value of initial_delay_seconds.

Example

let x = Probe::new().set_initial_delay_seconds(42);

pub fn set_probe_type<T: Into<Option<ProbeType>>>(self, v: T) -> Self

Sets the value of probe_type.

Note that all the setters affecting probe_type are mutually exclusive.

Example

use google_cloud_aiplatform_v1::model::probe::ExecAction;
let x = Probe::new().set_probe_type(Some(
    google_cloud_aiplatform_v1::model::probe::ProbeType::Exec(ExecAction::default().into())));

pub fn exec(&self) -> Option<&Box<ExecAction>>

The value of probe_type if it holds a Exec, None if the field is not set or holds a different branch.

pub fn set_exec<T: Into<Box<ExecAction>>>(self, v: T) -> Self

Sets the value of probe_type to hold a Exec.

Note that all the setters affecting probe_type are mutually exclusive.

Example

use google_cloud_aiplatform_v1::model::probe::ExecAction;
let x = Probe::new().set_exec(ExecAction::default()/* use setters */);
assert!(x.exec().is_some());
assert!(x.http_get().is_none());
assert!(x.grpc().is_none());
assert!(x.tcp_socket().is_none());

pub fn http_get(&self) -> Option<&Box<HttpGetAction>>

The value of probe_type if it holds a HttpGet, None if the field is not set or holds a different branch.

pub fn set_http_get<T: Into<Box<HttpGetAction>>>(self, v: T) -> Self

Sets the value of probe_type to hold a HttpGet.

Note that all the setters affecting probe_type are mutually exclusive.

Example

use google_cloud_aiplatform_v1::model::probe::HttpGetAction;
let x = Probe::new().set_http_get(HttpGetAction::default()/* use setters */);
assert!(x.http_get().is_some());
assert!(x.exec().is_none());
assert!(x.grpc().is_none());
assert!(x.tcp_socket().is_none());

pub fn grpc(&self) -> Option<&Box<GrpcAction>>

The value of probe_type if it holds a Grpc, None if the field is not set or holds a different branch.

pub fn set_grpc<T: Into<Box<GrpcAction>>>(self, v: T) -> Self

Sets the value of probe_type to hold a Grpc.

Note that all the setters affecting probe_type are mutually exclusive.

Example

use google_cloud_aiplatform_v1::model::probe::GrpcAction;
let x = Probe::new().set_grpc(GrpcAction::default()/* use setters */);
assert!(x.grpc().is_some());
assert!(x.exec().is_none());
assert!(x.http_get().is_none());
assert!(x.tcp_socket().is_none());

pub fn tcp_socket(&self) -> Option<&Box<TcpSocketAction>>

The value of probe_type if it holds a TcpSocket, None if the field is not set or holds a different branch.

pub fn set_tcp_socket<T: Into<Box<TcpSocketAction>>>(self, v: T) -> Self

Sets the value of probe_type to hold a TcpSocket.

Note that all the setters affecting probe_type are mutually exclusive.

Example

use google_cloud_aiplatform_v1::model::probe::TcpSocketAction;
let x = Probe::new().set_tcp_socket(TcpSocketAction::default()/* use setters */);
assert!(x.tcp_socket().is_some());
assert!(x.exec().is_none());
assert!(x.http_get().is_none());
assert!(x.grpc().is_none());

Trait Implementations

impl Clone for Probe

fn clone(&self) -> Probe

Returns a duplicate of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Debug for Probe

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl Default for Probe

fn default() -> Probe

Returns the “default value” for a type.

impl Message for Probe

fn typename() -> &'static str

The typename of this message.

impl PartialEq for Probe

fn eq(&self, other: &Probe) -> bool

Tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &Rhs) -> bool

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl StructuralPartialEq for Probe