Skip to main content

tensorboards

Overview

Nametensorboards
TypeResource
Idgoogle.aiplatform.tensorboards

Fields

NameDatatypeDescription
namestringOutput only. Name of the Tensorboard. Format: projects/{project}/locations/{location}/tensorboards/{tensorboard}
descriptionstringDescription of this Tensorboard.
blobStoragePathPrefixstringOutput 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 '/'.
createTimestringOutput only. Timestamp when this Tensorboard was created.
displayNamestringRequired. User provided name of this Tensorboard.
encryptionSpecobjectRepresents a customer-managed encryption key spec that can be applied to a top-level resource.
etagstringUsed to perform a consistent read-modify-write updates. If not set, a blind "overwrite" update happens.
isDefaultbooleanUsed 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.
labelsobjectThe 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.
runCountintegerOutput only. The number of Runs stored in this Tensorboard.
updateTimestringOutput only. Timestamp when this Tensorboard was last updated.

Methods

NameAccessible byRequired ParamsDescription
getSELECTlocationsId, projectsId, tensorboardsIdGets a Tensorboard.
listSELECTlocationsId, projectsIdLists Tensorboards in a Location.
createINSERTlocationsId, projectsIdCreates a Tensorboard.
deleteDELETElocationsId, projectsId, tensorboardsIdDeletes a Tensorboard.
_listEXEClocationsId, projectsIdLists Tensorboards in a Location.
patchEXEClocationsId, projectsId, tensorboardsIdUpdates a Tensorboard.
read_sizeEXEClocationsId, projectsId, tensorboardsIdReturns the storage size for a given TensorBoard instance.
read_usageEXEClocationsId, projectsId, tensorboardsIdReturns a list of monthly active users for a given TensorBoard instance.