Struct Parameter 

#[non_exhaustive]
pub struct Parameter {
    pub parameter_id: String,
    pub value: Option<Value>,
    /* private fields */
}

Available on crate features job-service or vizier-service only.

A message representing a parameter to be tuned.

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.

parameter_id: String

Output only. The ID of the parameter. The parameter should be defined in StudySpec’s Parameters.

value: Option<Value>

Output only. The value of the parameter. number_value will be set if a parameter defined in StudySpec is in type ‘INTEGER’, ‘DOUBLE’ or ‘DISCRETE’. string_value will be set if a parameter defined in StudySpec is in type ‘CATEGORICAL’.

Implementations

impl Parameter

pub fn new() -> Self

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

Sets the value of parameter_id.

Example

let x = Parameter::new().set_parameter_id("example");

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

where T: Into<Value>,

Sets the value of value.

Example

use wkt::Value;
let x = Parameter::new().set_value(Value::default()/* use setters */);

pub fn set_or_clear_value<T>(self, v: Option<T>) -> Self

where T: Into<Value>,

Sets or clears the value of value.

Example

use wkt::Value;
let x = Parameter::new().set_or_clear_value(Some(Value::default()/* use setters */));
let x = Parameter::new().set_or_clear_value(None::<Value>);

Trait Implementations

impl Clone for Parameter

fn clone(&self) -> Parameter

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for Parameter

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

Formats the value using the given formatter.

impl Default for Parameter

fn default() -> Parameter

Returns the “default value” for a type.

impl Message for Parameter

fn typename() -> &'static str

The typename of this message.

impl PartialEq for Parameter

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