Struct HyperparameterTuningJob 

#[non_exhaustive]
pub struct HyperparameterTuningJob {

    pub name: String,
    pub display_name: String,
    pub study_spec: Option<StudySpec>,
    pub max_trial_count: i32,
    pub parallel_trial_count: i32,
    pub max_failed_trial_count: i32,
    pub trial_job_spec: Option<CustomJobSpec>,
    pub trials: Vec<Trial>,
    pub state: JobState,
    pub create_time: Option<Timestamp>,
    pub start_time: Option<Timestamp>,
    pub end_time: Option<Timestamp>,
    pub update_time: Option<Timestamp>,
    pub error: Option<Status>,
    pub labels: HashMap<String, String>,
    pub encryption_spec: Option<EncryptionSpec>,
    pub satisfies_pzs: bool,
    pub satisfies_pzi: bool,
    /* private fields */
}

Available on crate feature job-service only.

Represents a HyperparameterTuningJob. A HyperparameterTuningJob has a Study specification and multiple CustomJobs with identical CustomJob specification.

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. Resource name of the HyperparameterTuningJob.

display_name: String

Required. The display name of the HyperparameterTuningJob. The name can be up to 128 characters long and can consist of any UTF-8 characters.

study_spec: Option<StudySpec>

Required. Study configuration of the HyperparameterTuningJob.

max_trial_count: i32

Required. The desired total number of Trials.

parallel_trial_count: i32

Required. The desired number of Trials to run in parallel.

max_failed_trial_count: i32

The number of failed Trials that need to be seen before failing the HyperparameterTuningJob.

If set to 0, Vertex AI decides how many Trials must fail before the whole job fails.

trial_job_spec: Option<CustomJobSpec>

Required. The spec of a trial job. The same spec applies to the CustomJobs created in all the trials.

trials: Vec<Trial>

Output only. Trials of the HyperparameterTuningJob.

state: JobState

Output only. The detailed state of the job.

create_time: Option<Timestamp>

Output only. Time when the HyperparameterTuningJob was created.

start_time: Option<Timestamp>

Output only. Time when the HyperparameterTuningJob for the first time entered the JOB_STATE_RUNNING state.

end_time: Option<Timestamp>

Output only. Time when the HyperparameterTuningJob entered any of the following states: JOB_STATE_SUCCEEDED, JOB_STATE_FAILED, JOB_STATE_CANCELLED.

update_time: Option<Timestamp>

Output only. Time when the HyperparameterTuningJob was most recently updated.

error: Option<Status>

Output only. Only populated when job’s state is JOB_STATE_FAILED or JOB_STATE_CANCELLED.

labels: HashMap<String, String>

The labels with user-defined metadata to organize HyperparameterTuningJobs.

Label keys and values can be no longer than 64 characters (Unicode codepoints), can only contain lowercase letters, numeric characters, underscores and dashes. International characters are allowed.

See https://goo.gl/xmQnxf for more information and examples of labels.

encryption_spec: Option<EncryptionSpec>

Customer-managed encryption key options for a HyperparameterTuningJob. If this is set, then all resources created by the HyperparameterTuningJob will be encrypted with the provided encryption key.

satisfies_pzs: bool

Output only. Reserved for future use.

satisfies_pzi: bool

Output only. Reserved for future use.

Implementations

impl HyperparameterTuningJob

pub fn new() -> Self

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

Sets the value of name.

Example

let x = HyperparameterTuningJob::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 = HyperparameterTuningJob::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 = HyperparameterTuningJob::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 = HyperparameterTuningJob::new().set_or_clear_study_spec(Some(StudySpec::default()/* use setters */));
let x = HyperparameterTuningJob::new().set_or_clear_study_spec(None::<StudySpec>);

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

Sets the value of max_trial_count.

Example

let x = HyperparameterTuningJob::new().set_max_trial_count(42);

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

Sets the value of parallel_trial_count.

Example

let x = HyperparameterTuningJob::new().set_parallel_trial_count(42);

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

Sets the value of max_failed_trial_count.

Example

let x = HyperparameterTuningJob::new().set_max_failed_trial_count(42);

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

where T: Into<CustomJobSpec>,

Sets the value of trial_job_spec.

Example

use google_cloud_aiplatform_v1::model::CustomJobSpec;
let x = HyperparameterTuningJob::new().set_trial_job_spec(CustomJobSpec::default()/* use setters */);

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

where T: Into<CustomJobSpec>,

Sets or clears the value of trial_job_spec.

Example

use google_cloud_aiplatform_v1::model::CustomJobSpec;
let x = HyperparameterTuningJob::new().set_or_clear_trial_job_spec(Some(CustomJobSpec::default()/* use setters */));
let x = HyperparameterTuningJob::new().set_or_clear_trial_job_spec(None::<CustomJobSpec>);

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

where T: IntoIterator<Item = V>, V: Into<Trial>,

Sets the value of trials.

Example

use google_cloud_aiplatform_v1::model::Trial;
let x = HyperparameterTuningJob::new()
    .set_trials([
        Trial::default()/* use setters */,
        Trial::default()/* use (different) setters */,
    ]);

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

Sets the value of state.

Example

use google_cloud_aiplatform_v1::model::JobState;
let x0 = HyperparameterTuningJob::new().set_state(JobState::Queued);
let x1 = HyperparameterTuningJob::new().set_state(JobState::Pending);
let x2 = HyperparameterTuningJob::new().set_state(JobState::Running);

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 = HyperparameterTuningJob::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 = HyperparameterTuningJob::new().set_or_clear_create_time(Some(Timestamp::default()/* use setters */));
let x = HyperparameterTuningJob::new().set_or_clear_create_time(None::<Timestamp>);

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

where T: Into<Timestamp>,

Sets the value of start_time.

Example

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

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

where T: Into<Timestamp>,

Sets or clears the value of start_time.

Example

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

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

where T: Into<Timestamp>,

Sets the value of end_time.

Example

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

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

where T: Into<Timestamp>,

Sets or clears the value of end_time.

Example

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

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

where T: Into<Timestamp>,

Sets the value of update_time.

Example

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

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

where T: Into<Timestamp>,

Sets or clears the value of update_time.

Example

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

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

where T: Into<Status>,

Sets the value of error.

Example

use rpc::model::Status;
let x = HyperparameterTuningJob::new().set_error(Status::default()/* use setters */);

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

where T: Into<Status>,

Sets or clears the value of error.

Example

use rpc::model::Status;
let x = HyperparameterTuningJob::new().set_or_clear_error(Some(Status::default()/* use setters */));
let x = HyperparameterTuningJob::new().set_or_clear_error(None::<Status>);

pub fn set_labels<T, K, V>(self, v: T) -> Self

where T: IntoIterator<Item = (K, V)>, K: Into<String>, V: Into<String>,

Sets the value of labels.

Example

let x = HyperparameterTuningJob::new().set_labels([
    ("key0", "abc"),
    ("key1", "xyz"),
]);

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

where T: Into<EncryptionSpec>,

Sets the value of encryption_spec.

Example

use google_cloud_aiplatform_v1::model::EncryptionSpec;
let x = HyperparameterTuningJob::new().set_encryption_spec(EncryptionSpec::default()/* use setters */);

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

where T: Into<EncryptionSpec>,

Sets or clears the value of encryption_spec.

Example

use google_cloud_aiplatform_v1::model::EncryptionSpec;
let x = HyperparameterTuningJob::new().set_or_clear_encryption_spec(Some(EncryptionSpec::default()/* use setters */));
let x = HyperparameterTuningJob::new().set_or_clear_encryption_spec(None::<EncryptionSpec>);

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

Sets the value of satisfies_pzs.

Example

let x = HyperparameterTuningJob::new().set_satisfies_pzs(true);

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

Sets the value of satisfies_pzi.

Example

let x = HyperparameterTuningJob::new().set_satisfies_pzi(true);

Trait Implementations

impl Clone for HyperparameterTuningJob

fn clone(&self) -> HyperparameterTuningJob

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for HyperparameterTuningJob

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

Formats the value using the given formatter.

impl Default for HyperparameterTuningJob

fn default() -> HyperparameterTuningJob

Returns the “default value” for a type.

impl Message for HyperparameterTuningJob

fn typename() -> &'static str

The typename of this message.

impl PartialEq for HyperparameterTuningJob

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