Struct NumericRestriction 

#[non_exhaustive]
pub struct NumericRestriction {
    pub namespace: String,
    pub op: Operator,
    pub value: Option<Value>,
    /* private fields */
}

Available on crate features index-service or match-service only.

This field allows restricts to be based on numeric comparisons rather than categorical tokens.

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.

namespace: String

The namespace of this restriction. e.g.: cost.

op: Operator

This MUST be specified for queries and must NOT be specified for datapoints.

value: Option<Value>

The type of Value must be consistent for all datapoints with a given namespace name. This is verified at runtime.

Implementations

impl NumericRestriction

pub fn new() -> Self

pub fn set_namespace<T: Into<String>>(self, v: T) -> Self

Sets the value of namespace.

Example

let x = NumericRestriction::new().set_namespace("example");

pub fn set_op<T: Into<Operator>>(self, v: T) -> Self

Sets the value of op.

Example

use google_cloud_aiplatform_v1::model::index_datapoint::numeric_restriction::Operator;
let x0 = NumericRestriction::new().set_op(Operator::Less);
let x1 = NumericRestriction::new().set_op(Operator::LessEqual);
let x2 = NumericRestriction::new().set_op(Operator::Equal);

pub fn set_value<T: Into<Option<Value>>>(self, v: T) -> Self

Sets the value of value.

Note that all the setters affecting value are mutually exclusive.

Example

use google_cloud_aiplatform_v1::model::index_datapoint::numeric_restriction::Value;
let x = NumericRestriction::new().set_value(Some(Value::ValueInt(42)));

pub fn value_int(&self) -> Option<&i64>

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

pub fn set_value_int<T: Into<i64>>(self, v: T) -> Self

Sets the value of value to hold a ValueInt.

Note that all the setters affecting value are mutually exclusive.

Example

let x = NumericRestriction::new().set_value_int(42);
assert!(x.value_int().is_some());
assert!(x.value_float().is_none());
assert!(x.value_double().is_none());

pub fn value_float(&self) -> Option<&f32>

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

pub fn set_value_float<T: Into<f32>>(self, v: T) -> Self

Sets the value of value to hold a ValueFloat.

Note that all the setters affecting value are mutually exclusive.

Example

let x = NumericRestriction::new().set_value_float(42.0);
assert!(x.value_float().is_some());
assert!(x.value_int().is_none());
assert!(x.value_double().is_none());

pub fn value_double(&self) -> Option<&f64>

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

pub fn set_value_double<T: Into<f64>>(self, v: T) -> Self

Sets the value of value to hold a ValueDouble.

Note that all the setters affecting value are mutually exclusive.

Example

let x = NumericRestriction::new().set_value_double(42.0);
assert!(x.value_double().is_some());
assert!(x.value_int().is_none());
assert!(x.value_float().is_none());

Trait Implementations

impl Clone for NumericRestriction

fn clone(&self) -> NumericRestriction

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for NumericRestriction

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

Formats the value using the given formatter.

impl Default for NumericRestriction

fn default() -> NumericRestriction

Returns the “default value” for a type.

impl Message for NumericRestriction

fn typename() -> &'static str

The typename of this message.

impl PartialEq for NumericRestriction

fn eq(&self, other: &NumericRestriction) -> 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 NumericRestriction