Cloud AI Platform v1 API - Class Tensorboard (2.26.0)

public sealed class Tensorboard : IMessage<Tensorboard>, IEquatable<Tensorboard>, IDeepCloneable<Tensorboard>, IBufferMessage, IMessage

Reference documentation and code samples for the Cloud AI Platform v1 API class Tensorboard.

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.

Inheritance

object > Tensorboard

Implements

IMessage Tensorboard, IEquatable Tensorboard, IDeepCloneable Tensorboard, IBufferMessage, IMessage

Inherited Members

object.GetHashCode()

object.GetType()

object.ToString()

Namespace

Google.Cloud.AIPlatform.V1

Assembly

Google.Cloud.AIPlatform.V1.dll

Constructors

Tensorboard()

public Tensorboard()

Tensorboard(Tensorboard)

public Tensorboard(Tensorboard other)

Parameter
Name	Description
`other`	`Tensorboard`

Properties

BlobStoragePathPrefix

public string BlobStoragePathPrefix { get; set; }

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 '/'.

Property Value
Type	Description
`string`

CreateTime

public Timestamp CreateTime { get; set; }

Output only. Timestamp when this Tensorboard was created.

Property Value
Type	Description
`Timestamp`

Description

public string Description { get; set; }

Description of this Tensorboard.

Property Value
Type	Description
`string`

DisplayName

public string DisplayName { get; set; }

Required. User provided name of this Tensorboard.

Property Value
Type	Description
`string`

EncryptionSpec

public EncryptionSpec EncryptionSpec { get; set; }

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.

Property Value
Type	Description
`EncryptionSpec`

Etag

public string Etag { get; set; }

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

Property Value
Type	Description
`string`

IsDefault

public bool IsDefault { get; set; }

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.

Property Value
Type	Description
`bool`

Labels

public MapField<string, string> Labels { get; }

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.

Property Value
Type	Description
`MapFieldstringstring`

Name

public string Name { get; set; }

Output only. Name of the Tensorboard. Format: projects/{project}/locations/{location}/tensorboards/{tensorboard}

Property Value
Type	Description
`string`

RunCount

public int RunCount { get; set; }

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

Property Value
Type	Description
`int`

TensorboardName

public TensorboardName TensorboardName { get; set; }

TensorboardName-typed view over the Name resource name property.

Property Value
Type	Description
`TensorboardName`

UpdateTime

public Timestamp UpdateTime { get; set; }

Output only. Timestamp when this Tensorboard was last updated.

Property Value
Type	Description
`Timestamp`