Struct UpdateTrialComponentInput

#[non_exhaustive]
pub struct UpdateTrialComponentInput {
    pub trial_component_name: Option<String>,
    pub display_name: Option<String>,
    pub status: Option<TrialComponentStatus>,
    pub start_time: Option<DateTime>,
    pub end_time: Option<DateTime>,
    pub parameters: Option<HashMap<String, TrialComponentParameterValue>>,
    pub parameters_to_remove: Option<Vec<String>>,
    pub input_artifacts: Option<HashMap<String, TrialComponentArtifact>>,
    pub input_artifacts_to_remove: Option<Vec<String>>,
    pub output_artifacts: Option<HashMap<String, TrialComponentArtifact>>,
    pub output_artifacts_to_remove: Option<Vec<String>>,
}

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.

trial_component_name: Option<String>

The name of the component to update.

display_name: Option<String>

The name of the component as displayed. The name doesn't need to be unique. If DisplayName isn't specified, TrialComponentName is displayed.

status: Option<TrialComponentStatus>

The new status of the component.

start_time: Option<DateTime>

When the component started.

end_time: Option<DateTime>

When the component ended.

parameters: Option<HashMap<String, TrialComponentParameterValue>>

Replaces all of the component's hyperparameters with the specified hyperparameters or add new hyperparameters. Existing hyperparameters are replaced if the trial component is updated with an identical hyperparameter key.

parameters_to_remove: Option<Vec<String>>

The hyperparameters to remove from the component.

input_artifacts: Option<HashMap<String, TrialComponentArtifact>>

Replaces all of the component's input artifacts with the specified artifacts or adds new input artifacts. Existing input artifacts are replaced if the trial component is updated with an identical input artifact key.

input_artifacts_to_remove: Option<Vec<String>>

The input artifacts to remove from the component.

output_artifacts: Option<HashMap<String, TrialComponentArtifact>>

Replaces all of the component's output artifacts with the specified artifacts or adds new output artifacts. Existing output artifacts are replaced if the trial component is updated with an identical output artifact key.

output_artifacts_to_remove: Option<Vec<String>>

The output artifacts to remove from the component.

Implementations

impl UpdateTrialComponentInput

pub fn trial_component_name(&self) -> Option<&str>

The name of the component to update.

pub fn display_name(&self) -> Option<&str>

The name of the component as displayed. The name doesn't need to be unique. If DisplayName isn't specified, TrialComponentName is displayed.

pub fn status(&self) -> Option<&TrialComponentStatus>

The new status of the component.

pub fn start_time(&self) -> Option<&DateTime>

When the component started.

pub fn end_time(&self) -> Option<&DateTime>

When the component ended.

pub fn parameters( &self, ) -> Option<&HashMap<String, TrialComponentParameterValue>>

Replaces all of the component's hyperparameters with the specified hyperparameters or add new hyperparameters. Existing hyperparameters are replaced if the trial component is updated with an identical hyperparameter key.

pub fn parameters_to_remove(&self) -> &[String]

The hyperparameters to remove from the component.

If no value was sent for this field, a default will be set. If you want to determine if no value was sent, use .parameters_to_remove.is_none().

pub fn input_artifacts( &self, ) -> Option<&HashMap<String, TrialComponentArtifact>>

Replaces all of the component's input artifacts with the specified artifacts or adds new input artifacts. Existing input artifacts are replaced if the trial component is updated with an identical input artifact key.

pub fn input_artifacts_to_remove(&self) -> &[String]

The input artifacts to remove from the component.

If no value was sent for this field, a default will be set. If you want to determine if no value was sent, use .input_artifacts_to_remove.is_none().

pub fn output_artifacts( &self, ) -> Option<&HashMap<String, TrialComponentArtifact>>

Replaces all of the component's output artifacts with the specified artifacts or adds new output artifacts. Existing output artifacts are replaced if the trial component is updated with an identical output artifact key.

pub fn output_artifacts_to_remove(&self) -> &[String]

The output artifacts to remove from the component.

If no value was sent for this field, a default will be set. If you want to determine if no value was sent, use .output_artifacts_to_remove.is_none().

impl UpdateTrialComponentInput

pub fn builder() -> UpdateTrialComponentInputBuilder

Creates a new builder-style object to manufacture UpdateTrialComponentInput.

Trait Implementations

impl Clone for UpdateTrialComponentInput

fn clone(&self) -> UpdateTrialComponentInput

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for UpdateTrialComponentInput

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

Formats the value using the given formatter.

impl PartialEq for UpdateTrialComponentInput

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

Tests for self and other values to be equal, and is used by ==.

const 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 UpdateTrialComponentInput