Struct CompleteTrialRequest 

#[non_exhaustive]
pub struct CompleteTrialRequest {
    pub name: String,
    pub final_measurement: Option<Measurement>,
    pub trial_infeasible: bool,
    pub infeasible_reason: String,
    /* private fields */
}

Available on crate feature vizier-service only.

Request message for VizierService.CompleteTrial.

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.

name: String

Required. The Trial’s name. Format: projects/{project}/locations/{location}/studies/{study}/trials/{trial}

final_measurement: Option<Measurement>

Optional. If provided, it will be used as the completed Trial’s final_measurement; Otherwise, the service will auto-select a previously reported measurement as the final-measurement

trial_infeasible: bool

Optional. True if the Trial cannot be run with the given Parameter, and final_measurement will be ignored.

infeasible_reason: String

Optional. A human readable reason why the trial was infeasible. This should only be provided if trial_infeasible is true.

Implementations

impl CompleteTrialRequest

pub fn new() -> Self

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

Sets the value of name.

Example

let x = CompleteTrialRequest::new().set_name("example");

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

where T: Into<Measurement>,

Sets the value of final_measurement.

Example

use google_cloud_aiplatform_v1::model::Measurement;
let x = CompleteTrialRequest::new().set_final_measurement(Measurement::default()/* use setters */);

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

where T: Into<Measurement>,

Sets or clears the value of final_measurement.

Example

use google_cloud_aiplatform_v1::model::Measurement;
let x = CompleteTrialRequest::new().set_or_clear_final_measurement(Some(Measurement::default()/* use setters */));
let x = CompleteTrialRequest::new().set_or_clear_final_measurement(None::<Measurement>);

pub fn set_trial_infeasible<T: Into<bool>>(self, v: T) -> Self

Sets the value of trial_infeasible.

Example

let x = CompleteTrialRequest::new().set_trial_infeasible(true);

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

Sets the value of infeasible_reason.

Example

let x = CompleteTrialRequest::new().set_infeasible_reason("example");

Trait Implementations

impl Clone for CompleteTrialRequest

fn clone(&self) -> CompleteTrialRequest

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for CompleteTrialRequest

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

Formats the value using the given formatter.

impl Default for CompleteTrialRequest

fn default() -> CompleteTrialRequest

Returns the “default value” for a type.

impl Message for CompleteTrialRequest

fn typename() -> &'static str

The typename of this message.

impl PartialEq for CompleteTrialRequest

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