Struct TimeSeriesDataPoint 

#[non_exhaustive]
pub struct TimeSeriesDataPoint {
    pub wall_time: Option<Timestamp>,
    pub step: i64,
    pub value: Option<Value>,
    /* private fields */
}

Available on crate feature tensorboard-service only.

A TensorboardTimeSeries data point.

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.

wall_time: Option<Timestamp>

Wall clock timestamp when this data point is generated by the end user.

step: i64

Step index of this data point within the run.

value: Option<Value>

Value of this time series data point.

Implementations

impl TimeSeriesDataPoint

pub fn new() -> Self

Creates a new default instance.

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

where T: Into<Timestamp>,

Sets the value of wall_time.

Example

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

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

where T: Into<Timestamp>,

Sets or clears the value of wall_time.

Example

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

pub fn set_step<T: Into<i64>>(self, v: T) -> Self

Sets the value of step.

Example

let x = TimeSeriesDataPoint::new().set_step(42);

pub fn set_value<T: Into<Option<Value>>>(self, v: T) -> Self

Sets the value of value.

Note that all the setters affecting value are mutually exclusive.

Example

use google_cloud_aiplatform_v1::model::Scalar;
let x = TimeSeriesDataPoint::new().set_value(Some(
    google_cloud_aiplatform_v1::model::time_series_data_point::Value::Scalar(Scalar::default().into())));

pub fn scalar(&self) -> Option<&Box<Scalar>>

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

pub fn set_scalar<T: Into<Box<Scalar>>>(self, v: T) -> Self

Sets the value of value to hold a Scalar.

Note that all the setters affecting value are mutually exclusive.

Example

use google_cloud_aiplatform_v1::model::Scalar;
let x = TimeSeriesDataPoint::new().set_scalar(Scalar::default()/* use setters */);
assert!(x.scalar().is_some());
assert!(x.tensor().is_none());
assert!(x.blobs().is_none());

pub fn tensor(&self) -> Option<&Box<TensorboardTensor>>

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

pub fn set_tensor<T: Into<Box<TensorboardTensor>>>(self, v: T) -> Self

Sets the value of value to hold a Tensor.

Note that all the setters affecting value are mutually exclusive.

Example

use google_cloud_aiplatform_v1::model::TensorboardTensor;
let x = TimeSeriesDataPoint::new().set_tensor(TensorboardTensor::default()/* use setters */);
assert!(x.tensor().is_some());
assert!(x.scalar().is_none());
assert!(x.blobs().is_none());

pub fn blobs(&self) -> Option<&Box<TensorboardBlobSequence>>

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

pub fn set_blobs<T: Into<Box<TensorboardBlobSequence>>>(self, v: T) -> Self

Sets the value of value to hold a Blobs.

Note that all the setters affecting value are mutually exclusive.

Example

use google_cloud_aiplatform_v1::model::TensorboardBlobSequence;
let x = TimeSeriesDataPoint::new().set_blobs(TensorboardBlobSequence::default()/* use setters */);
assert!(x.blobs().is_some());
assert!(x.scalar().is_none());
assert!(x.tensor().is_none());

Trait Implementations

impl Clone for TimeSeriesDataPoint

fn clone(&self) -> TimeSeriesDataPoint

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for TimeSeriesDataPoint

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

Formats the value using the given formatter.

impl Default for TimeSeriesDataPoint

fn default() -> TimeSeriesDataPoint

Returns the “default value” for a type.

impl Message for TimeSeriesDataPoint

fn typename() -> &'static str

The typename of this message.

impl PartialEq for TimeSeriesDataPoint

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

Equality operator ==.

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

Inequality operator !=.

impl StructuralPartialEq for TimeSeriesDataPoint