Struct EngineConfig 

#[non_exhaustive]
pub struct EngineConfig {
    pub name: String,
    pub create_time: Option<Timestamp>,
    pub update_time: Option<Timestamp>,
    pub labels: HashMap<String, String>,
    pub state: State,
    pub engine_version: String,
    pub tuning: Option<Tuning>,
    pub performance_target: Option<PerformanceTarget>,
    pub line_of_business: LineOfBusiness,
    pub hyperparameter_source_type: HyperparameterSourceType,
    pub hyperparameter_source: Option<HyperparameterSource>,
    /* private fields */
}

The EngineConfig resource creates the configuration for training a model.

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 resource name of the EngineConfig. format: /projects/{project_num}/locations/{location}/instances/{instance}/engineConfigs/{engine_config}

create_time: Option<Timestamp>

Output only. The timestamp of creation of this resource.

update_time: Option<Timestamp>

Output only. The timestamp of the most recent update of this resource.

labels: HashMap<String, String>

Labels

state: State

Output only. State of the EngineConfig (creating, active, deleting, etc.)

engine_version: String

Required. The resource name of the EngineVersion used in this model tuning. format: /projects/{project_num}/locations/{location}/instances/{instance}/engineVersions/{engine_version}

tuning: Option<Tuning>

Optional. Configuration for tuning in creation of the EngineConfig. This field is required if hyperparameter_source.type is not INHERITED, and output-only otherwise.

performance_target: Option<PerformanceTarget>

Optional. PerformanceTarget gives information on how the tuning and training will be evaluated. This field is required if hyperparameter_source.type is not INHERITED, and output-only otherwise.

line_of_business: LineOfBusiness

Output only. The line of business (Retail/Commercial) this engine config is used for. Determined by EngineVersion, cannot be set by user.

hyperparameter_source_type: HyperparameterSourceType

Optional. The origin of hyperparameters for the created EngineConfig. The default is TUNING. In this case, the hyperparameters are selected as a result of a tuning run.

hyperparameter_source: Option<HyperparameterSource>

Optional. Configuration of hyperparameters source EngineConfig.

Implementations

impl EngineConfig

pub fn new() -> Self

Creates a new default instance.

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

Sets the value of name.

Example

let x = EngineConfig::new().set_name(format!("projects/{project_num_id}/locations/{location_id}/instances/{instance_id}/engineConfigs/{engine_config_id}"));

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

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 = EngineConfig::new().set_labels([
    ("key0", "abc"),
    ("key1", "xyz"),
]);

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

Sets the value of state.

Example

use google_cloud_financialservices_v1::model::engine_config::State;
let x0 = EngineConfig::new().set_state(State::Creating);
let x1 = EngineConfig::new().set_state(State::Active);
let x2 = EngineConfig::new().set_state(State::Updating);

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

Sets the value of engine_version.

Example

let x = EngineConfig::new().set_engine_version(format!("projects/{project_num_id}/locations/{location_id}/instances/{instance_id}/engineVersions/{engine_version_id}"));

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

where T: Into<Tuning>,

Sets the value of tuning.

Example

use google_cloud_financialservices_v1::model::engine_config::Tuning;
let x = EngineConfig::new().set_tuning(Tuning::default()/* use setters */);

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

where T: Into<Tuning>,

Sets or clears the value of tuning.

Example

use google_cloud_financialservices_v1::model::engine_config::Tuning;
let x = EngineConfig::new().set_or_clear_tuning(Some(Tuning::default()/* use setters */));
let x = EngineConfig::new().set_or_clear_tuning(None::<Tuning>);

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

where T: Into<PerformanceTarget>,

Sets the value of performance_target.

Example

use google_cloud_financialservices_v1::model::engine_config::PerformanceTarget;
let x = EngineConfig::new().set_performance_target(PerformanceTarget::default()/* use setters */);

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

where T: Into<PerformanceTarget>,

Sets or clears the value of performance_target.

Example

use google_cloud_financialservices_v1::model::engine_config::PerformanceTarget;
let x = EngineConfig::new().set_or_clear_performance_target(Some(PerformanceTarget::default()/* use setters */));
let x = EngineConfig::new().set_or_clear_performance_target(None::<PerformanceTarget>);

pub fn set_line_of_business<T: Into<LineOfBusiness>>(self, v: T) -> Self

Sets the value of line_of_business.

Example

use google_cloud_financialservices_v1::model::LineOfBusiness;
let x0 = EngineConfig::new().set_line_of_business(LineOfBusiness::Commercial);
let x1 = EngineConfig::new().set_line_of_business(LineOfBusiness::Retail);

pub fn set_hyperparameter_source_type<T: Into<HyperparameterSourceType>>( self, v: T, ) -> Self

Sets the value of hyperparameter_source_type.

Example

use google_cloud_financialservices_v1::model::engine_config::HyperparameterSourceType;
let x0 = EngineConfig::new().set_hyperparameter_source_type(HyperparameterSourceType::Tuning);
let x1 = EngineConfig::new().set_hyperparameter_source_type(HyperparameterSourceType::Inherited);

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

where T: Into<HyperparameterSource>,

Sets the value of hyperparameter_source.

Example

use google_cloud_financialservices_v1::model::engine_config::HyperparameterSource;
let x = EngineConfig::new().set_hyperparameter_source(HyperparameterSource::default()/* use setters */);

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

where T: Into<HyperparameterSource>,

Sets or clears the value of hyperparameter_source.

Example

use google_cloud_financialservices_v1::model::engine_config::HyperparameterSource;
let x = EngineConfig::new().set_or_clear_hyperparameter_source(Some(HyperparameterSource::default()/* use setters */));
let x = EngineConfig::new().set_or_clear_hyperparameter_source(None::<HyperparameterSource>);

Trait Implementations

impl Clone for EngineConfig

fn clone(&self) -> EngineConfig

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for EngineConfig

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

Formats the value using the given formatter.

impl Default for EngineConfig

fn default() -> EngineConfig

Returns the “default value” for a type.

impl Message for EngineConfig

fn typename() -> &'static str

The typename of this message.

impl PartialEq for EngineConfig

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