Struct Study 

#[non_exhaustive]
pub struct Study {
    pub name: String,
    pub display_name: String,
    pub study_spec: Option<StudySpec>,
    pub state: State,
    pub create_time: Option<Timestamp>,
    pub inactive_reason: String,
    /* private fields */
}

Available on crate feature vizier-service only.

A message representing a Study.

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

Output only. The name of a study. The study’s globally unique identifier. Format: projects/{project}/locations/{location}/studies/{study}

display_name: String

Required. Describes the Study, default value is empty string.

study_spec: Option<StudySpec>

Required. Configuration of the Study.

state: State

Output only. The detailed state of a Study.

create_time: Option<Timestamp>

Output only. Time at which the study was created.

inactive_reason: String

Output only. A human readable reason why the Study is inactive. This should be empty if a study is ACTIVE or COMPLETED.

Implementations

impl Study

pub fn new() -> Self

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

Sets the value of name.

Example

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

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

Sets the value of display_name.

Example

let x = Study::new().set_display_name("example");

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

where T: Into<StudySpec>,

Sets the value of study_spec.

Example

use google_cloud_aiplatform_v1::model::StudySpec;
let x = Study::new().set_study_spec(StudySpec::default()/* use setters */);

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

where T: Into<StudySpec>,

Sets or clears the value of study_spec.

Example

use google_cloud_aiplatform_v1::model::StudySpec;
let x = Study::new().set_or_clear_study_spec(Some(StudySpec::default()/* use setters */));
let x = Study::new().set_or_clear_study_spec(None::<StudySpec>);

pub fn set_state<T: Into<State>>(self, v: T) -> Self

Sets the value of state.

Example

use google_cloud_aiplatform_v1::model::study::State;
let x0 = Study::new().set_state(State::Active);
let x1 = Study::new().set_state(State::Inactive);
let x2 = Study::new().set_state(State::Completed);

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

where T: Into<Timestamp>,

Sets the value of create_time.

Example

use wkt::Timestamp;
let x = Study::new().set_create_time(Timestamp::default()/* use setters */);

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

where T: Into<Timestamp>,

Sets or clears the value of create_time.

Example

use wkt::Timestamp;
let x = Study::new().set_or_clear_create_time(Some(Timestamp::default()/* use setters */));
let x = Study::new().set_or_clear_create_time(None::<Timestamp>);

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

Sets the value of inactive_reason.

Example

let x = Study::new().set_inactive_reason("example");

Trait Implementations

impl Clone for Study

fn clone(&self) -> Study

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for Study

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

Formats the value using the given formatter.

impl Default for Study

fn default() -> Study

Returns the “default value” for a type.

impl Message for Study

fn typename() -> &'static str

The typename of this message.

impl PartialEq for Study

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