Struct Tensorboard

#[non_exhaustive]
pub struct Tensorboard {

    pub name: String,
    pub display_name: String,
    pub description: String,
    pub encryption_spec: Option<EncryptionSpec>,
    pub blob_storage_path_prefix: String,
    pub run_count: i32,
    pub create_time: Option<Timestamp>,
    pub update_time: Option<Timestamp>,
    pub labels: HashMap<String, String>,
    pub etag: String,
    pub is_default: bool,
    pub satisfies_pzs: bool,
    pub satisfies_pzi: bool,
    /* private fields */
}

Tensorboard is a physical database that stores users’ training metrics. A default Tensorboard is provided in each region of a Google Cloud project. If needed users can also create extra Tensorboards in their projects.

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. Name of the Tensorboard. Format: projects/{project}/locations/{location}/tensorboards/{tensorboard}

display_name: String

Required. User provided name of this Tensorboard.

description: String

Description of this Tensorboard.

encryption_spec: Option<EncryptionSpec>

Customer-managed encryption key spec for a Tensorboard. If set, this Tensorboard and all sub-resources of this Tensorboard will be secured by this key.

blob_storage_path_prefix: String

Output only. Consumer project Cloud Storage path prefix used to store blob data, which can either be a bucket or directory. Does not end with a ‘/’.

run_count: i32

Output only. The number of Runs stored in this Tensorboard.

create_time: Option<Timestamp>

Output only. Timestamp when this Tensorboard was created.

update_time: Option<Timestamp>

Output only. Timestamp when this Tensorboard was last updated.

labels: HashMap<String, String>

The labels with user-defined metadata to organize your Tensorboards.

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. No more than 64 user labels can be associated with one Tensorboard (System labels are excluded).

See https://goo.gl/xmQnxf for more information and examples of labels. System reserved label keys are prefixed with “aiplatform.googleapis.com/” and are immutable.

etag: String

Used to perform a consistent read-modify-write updates. If not set, a blind “overwrite” update happens.

is_default: bool

Used to indicate if the TensorBoard instance is the default one. Each project & region can have at most one default TensorBoard instance. Creation of a default TensorBoard instance and updating an existing TensorBoard instance to be default will mark all other TensorBoard instances (if any) as non default.

satisfies_pzs: bool

Output only. Reserved for future use.

satisfies_pzi: bool

Output only. Reserved for future use.

Implementations

impl Tensorboard

pub fn new() -> Self

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

Sets the value of name.

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

Sets the value of display_name.

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

Sets the value of description.

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

Sets the value of encryption_spec.

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

Sets the value of blob_storage_path_prefix.

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

Sets the value of run_count.

pub fn set_create_time<T: Into<Option<Timestamp>>>(self, v: T) -> Self

Sets the value of create_time.

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

Sets the value of update_time.

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.

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

Sets the value of etag.

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

Sets the value of is_default.

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

Sets the value of satisfies_pzs.

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

Sets the value of satisfies_pzi.

Trait Implementations

impl Clone for Tensorboard

fn clone(&self) -> Tensorboard

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for Tensorboard

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

Formats the value using the given formatter.

impl Default for Tensorboard

fn default() -> Tensorboard

Returns the “default value” for a type.

impl<'de> Deserialize<'de> for Tensorboard

where Tensorboard: Default,

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl Message for Tensorboard

fn typename() -> &'static str

The typename of this message.

impl PartialEq for Tensorboard

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

fn serialize<__S>(&self, __serializer: __S) -> Result<__S::Ok, __S::Error>

where __S: Serializer,

Serialize this value into the given Serde serializer.

impl StructuralPartialEq for Tensorboard