Struct ParameterSpec 

#[non_exhaustive]
pub struct ParameterSpec {
    pub parameter_id: String,
    pub scale_type: ScaleType,
    pub conditional_parameter_specs: Vec<ConditionalParameterSpec>,
    pub parameter_value_spec: Option<ParameterValueSpec>,
    /* private fields */
}

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

Represents a single parameter to optimize.

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

Required. The ID of the parameter. Must not contain whitespaces and must be unique amongst all ParameterSpecs.

scale_type: ScaleType

How the parameter should be scaled. Leave unset for CATEGORICAL parameters.

conditional_parameter_specs: Vec<ConditionalParameterSpec>

A conditional parameter node is active if the parameter’s value matches the conditional node’s parent_value_condition.

If two items in conditional_parameter_specs have the same name, they must have disjoint parent_value_condition.

parameter_value_spec: Option<ParameterValueSpec>

Implementations

impl ParameterSpec

pub fn new() -> Self

Creates a new default instance.

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

Sets the value of parameter_id.

Example

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

pub fn set_scale_type<T: Into<ScaleType>>(self, v: T) -> Self

Sets the value of scale_type.

Example

use google_cloud_aiplatform_v1::model::study_spec::parameter_spec::ScaleType;
let x0 = ParameterSpec::new().set_scale_type(ScaleType::UnitLinearScale);
let x1 = ParameterSpec::new().set_scale_type(ScaleType::UnitLogScale);
let x2 = ParameterSpec::new().set_scale_type(ScaleType::UnitReverseLogScale);

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

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

Sets the value of conditional_parameter_specs.

Example

use google_cloud_aiplatform_v1::model::study_spec::parameter_spec::ConditionalParameterSpec;
let x = ParameterSpec::new()
    .set_conditional_parameter_specs([
        ConditionalParameterSpec::default()/* use setters */,
        ConditionalParameterSpec::default()/* use (different) setters */,
    ]);

pub fn set_parameter_value_spec<T: Into<Option<ParameterValueSpec>>>( self, v: T, ) -> Self

Sets the value of parameter_value_spec.

Note that all the setters affecting parameter_value_spec are mutually exclusive.

Example

use google_cloud_aiplatform_v1::model::study_spec::parameter_spec::DoubleValueSpec;
let x = ParameterSpec::new().set_parameter_value_spec(Some(
    google_cloud_aiplatform_v1::model::study_spec::parameter_spec::ParameterValueSpec::DoubleValueSpec(DoubleValueSpec::default().into())));

pub fn double_value_spec(&self) -> Option<&Box<DoubleValueSpec>>

The value of parameter_value_spec if it holds a DoubleValueSpec, None if the field is not set or holds a different branch.

pub fn set_double_value_spec<T: Into<Box<DoubleValueSpec>>>(self, v: T) -> Self

Sets the value of parameter_value_spec to hold a DoubleValueSpec.

Note that all the setters affecting parameter_value_spec are mutually exclusive.

Example

use google_cloud_aiplatform_v1::model::study_spec::parameter_spec::DoubleValueSpec;
let x = ParameterSpec::new().set_double_value_spec(DoubleValueSpec::default()/* use setters */);
assert!(x.double_value_spec().is_some());
assert!(x.integer_value_spec().is_none());
assert!(x.categorical_value_spec().is_none());
assert!(x.discrete_value_spec().is_none());

pub fn integer_value_spec(&self) -> Option<&Box<IntegerValueSpec>>

The value of parameter_value_spec if it holds a IntegerValueSpec, None if the field is not set or holds a different branch.

pub fn set_integer_value_spec<T: Into<Box<IntegerValueSpec>>>( self, v: T, ) -> Self

Sets the value of parameter_value_spec to hold a IntegerValueSpec.

Note that all the setters affecting parameter_value_spec are mutually exclusive.

Example

use google_cloud_aiplatform_v1::model::study_spec::parameter_spec::IntegerValueSpec;
let x = ParameterSpec::new().set_integer_value_spec(IntegerValueSpec::default()/* use setters */);
assert!(x.integer_value_spec().is_some());
assert!(x.double_value_spec().is_none());
assert!(x.categorical_value_spec().is_none());
assert!(x.discrete_value_spec().is_none());

pub fn categorical_value_spec(&self) -> Option<&Box<CategoricalValueSpec>>

The value of parameter_value_spec if it holds a CategoricalValueSpec, None if the field is not set or holds a different branch.

pub fn set_categorical_value_spec<T: Into<Box<CategoricalValueSpec>>>( self, v: T, ) -> Self

Sets the value of parameter_value_spec to hold a CategoricalValueSpec.

Note that all the setters affecting parameter_value_spec are mutually exclusive.

Example

use google_cloud_aiplatform_v1::model::study_spec::parameter_spec::CategoricalValueSpec;
let x = ParameterSpec::new().set_categorical_value_spec(CategoricalValueSpec::default()/* use setters */);
assert!(x.categorical_value_spec().is_some());
assert!(x.double_value_spec().is_none());
assert!(x.integer_value_spec().is_none());
assert!(x.discrete_value_spec().is_none());

pub fn discrete_value_spec(&self) -> Option<&Box<DiscreteValueSpec>>

The value of parameter_value_spec if it holds a DiscreteValueSpec, None if the field is not set or holds a different branch.

pub fn set_discrete_value_spec<T: Into<Box<DiscreteValueSpec>>>( self, v: T, ) -> Self

Sets the value of parameter_value_spec to hold a DiscreteValueSpec.

Note that all the setters affecting parameter_value_spec are mutually exclusive.

Example

use google_cloud_aiplatform_v1::model::study_spec::parameter_spec::DiscreteValueSpec;
let x = ParameterSpec::new().set_discrete_value_spec(DiscreteValueSpec::default()/* use setters */);
assert!(x.discrete_value_spec().is_some());
assert!(x.double_value_spec().is_none());
assert!(x.integer_value_spec().is_none());
assert!(x.categorical_value_spec().is_none());

Trait Implementations

impl Clone for ParameterSpec

fn clone(&self) -> ParameterSpec

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for ParameterSpec

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

Formats the value using the given formatter.

impl Default for ParameterSpec

fn default() -> ParameterSpec

Returns the “default value” for a type.

impl Message for ParameterSpec

fn typename() -> &'static str

The typename of this message.

impl PartialEq for ParameterSpec

fn eq(&self, other: &ParameterSpec) -> bool

Equality operator ==.

fn ne(&self, other: &Rhs) -> bool

Inequality operator !=.

impl StructuralPartialEq for ParameterSpec