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
int
Output only. The number of Runs stored in this Tensorboard.
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). Seehttps://goo.gl/xmQnxffor 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.
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.
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.
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).
Seehttps://goo.gl/xmQnxffor more information and examples of labels.
System reserved label keys are prefixed with "aiplatform.googleapis.com/"
and are immutable.
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).
Seehttps://goo.gl/xmQnxffor more information and examples of labels.
System reserved label keys are prefixed with "aiplatform.googleapis.com/"
and are immutable.
Used to perform a consistent read-modify-write updates. If not set, a blind
"overwrite" update happens.
Returns
Type
Description
string
setEtag
Used to perform a consistent read-modify-write updates. If not set, a blind
"overwrite" update happens.
Parameter
Name
Description
var
string
Returns
Type
Description
$this
getIsDefault
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.
Returns
Type
Description
bool
setIsDefault
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.
[[["Easy to understand","easyToUnderstand","thumb-up"],["Solved my problem","solvedMyProblem","thumb-up"],["Other","otherUp","thumb-up"]],[["Hard to understand","hardToUnderstand","thumb-down"],["Incorrect information or sample code","incorrectInformationOrSampleCode","thumb-down"],["Missing the information/samples I need","missingTheInformationSamplesINeed","thumb-down"],["Other","otherDown","thumb-down"]],["Last updated 2025-09-09 UTC."],[],[],null,["# Google Cloud Ai Platform V1 Client - Class Tensorboard (1.35.0)\n\nVersion latestkeyboard_arrow_down\n\n- [1.35.0 (latest)](/php/docs/reference/cloud-ai-platform/latest/V1.Tensorboard)\n- [1.34.0](/php/docs/reference/cloud-ai-platform/1.34.0/V1.Tensorboard)\n- [1.33.0](/php/docs/reference/cloud-ai-platform/1.33.0/V1.Tensorboard)\n- [1.32.1](/php/docs/reference/cloud-ai-platform/1.32.1/V1.Tensorboard)\n- [1.31.0](/php/docs/reference/cloud-ai-platform/1.31.0/V1.Tensorboard)\n- [1.30.0](/php/docs/reference/cloud-ai-platform/1.30.0/V1.Tensorboard)\n- [1.26.0](/php/docs/reference/cloud-ai-platform/1.26.0/V1.Tensorboard)\n- [1.23.0](/php/docs/reference/cloud-ai-platform/1.23.0/V1.Tensorboard)\n- [1.22.0](/php/docs/reference/cloud-ai-platform/1.22.0/V1.Tensorboard)\n- [1.21.0](/php/docs/reference/cloud-ai-platform/1.21.0/V1.Tensorboard)\n- [1.20.0](/php/docs/reference/cloud-ai-platform/1.20.0/V1.Tensorboard)\n- [1.19.0](/php/docs/reference/cloud-ai-platform/1.19.0/V1.Tensorboard)\n- [1.18.0](/php/docs/reference/cloud-ai-platform/1.18.0/V1.Tensorboard)\n- [1.17.0](/php/docs/reference/cloud-ai-platform/1.17.0/V1.Tensorboard)\n- [1.16.0](/php/docs/reference/cloud-ai-platform/1.16.0/V1.Tensorboard)\n- [1.15.0](/php/docs/reference/cloud-ai-platform/1.15.0/V1.Tensorboard)\n- [1.14.0](/php/docs/reference/cloud-ai-platform/1.14.0/V1.Tensorboard)\n- [1.13.1](/php/docs/reference/cloud-ai-platform/1.13.1/V1.Tensorboard)\n- [1.12.0](/php/docs/reference/cloud-ai-platform/1.12.0/V1.Tensorboard)\n- [1.11.0](/php/docs/reference/cloud-ai-platform/1.11.0/V1.Tensorboard)\n- [1.10.0](/php/docs/reference/cloud-ai-platform/1.10.0/V1.Tensorboard)\n- [1.9.0](/php/docs/reference/cloud-ai-platform/1.9.0/V1.Tensorboard)\n- [1.8.0](/php/docs/reference/cloud-ai-platform/1.8.0/V1.Tensorboard)\n- [1.7.0](/php/docs/reference/cloud-ai-platform/1.7.0/V1.Tensorboard)\n- [1.6.0](/php/docs/reference/cloud-ai-platform/1.6.0/V1.Tensorboard)\n- [1.5.0](/php/docs/reference/cloud-ai-platform/1.5.0/V1.Tensorboard)\n- [1.4.0](/php/docs/reference/cloud-ai-platform/1.4.0/V1.Tensorboard)\n- [1.3.0](/php/docs/reference/cloud-ai-platform/1.3.0/V1.Tensorboard)\n- [1.2.0](/php/docs/reference/cloud-ai-platform/1.2.0/V1.Tensorboard)\n- [1.1.0](/php/docs/reference/cloud-ai-platform/1.1.0/V1.Tensorboard)\n- [1.0.0](/php/docs/reference/cloud-ai-platform/1.0.0/V1.Tensorboard)\n- [0.39.0](/php/docs/reference/cloud-ai-platform/0.39.0/V1.Tensorboard)\n- [0.38.0](/php/docs/reference/cloud-ai-platform/0.38.0/V1.Tensorboard)\n- [0.37.1](/php/docs/reference/cloud-ai-platform/0.37.1/V1.Tensorboard)\n- [0.32.0](/php/docs/reference/cloud-ai-platform/0.32.0/V1.Tensorboard)\n- [0.31.0](/php/docs/reference/cloud-ai-platform/0.31.0/V1.Tensorboard)\n- [0.30.0](/php/docs/reference/cloud-ai-platform/0.30.0/V1.Tensorboard)\n- [0.29.0](/php/docs/reference/cloud-ai-platform/0.29.0/V1.Tensorboard)\n- [0.28.0](/php/docs/reference/cloud-ai-platform/0.28.0/V1.Tensorboard)\n- [0.27.0](/php/docs/reference/cloud-ai-platform/0.27.0/V1.Tensorboard)\n- [0.26.2](/php/docs/reference/cloud-ai-platform/0.26.2/V1.Tensorboard)\n- [0.25.0](/php/docs/reference/cloud-ai-platform/0.25.0/V1.Tensorboard)\n- [0.24.0](/php/docs/reference/cloud-ai-platform/0.24.0/V1.Tensorboard)\n- [0.23.0](/php/docs/reference/cloud-ai-platform/0.23.0/V1.Tensorboard)\n- [0.22.0](/php/docs/reference/cloud-ai-platform/0.22.0/V1.Tensorboard)\n- [0.21.0](/php/docs/reference/cloud-ai-platform/0.21.0/V1.Tensorboard)\n- [0.20.0](/php/docs/reference/cloud-ai-platform/0.20.0/V1.Tensorboard)\n- [0.19.0](/php/docs/reference/cloud-ai-platform/0.19.0/V1.Tensorboard)\n- [0.18.0](/php/docs/reference/cloud-ai-platform/0.18.0/V1.Tensorboard)\n- [0.17.0](/php/docs/reference/cloud-ai-platform/0.17.0/V1.Tensorboard)\n- [0.16.0](/php/docs/reference/cloud-ai-platform/0.16.0/V1.Tensorboard)\n- [0.15.0](/php/docs/reference/cloud-ai-platform/0.15.0/V1.Tensorboard)\n- [0.13.0](/php/docs/reference/cloud-ai-platform/0.13.0/V1.Tensorboard)\n- [0.12.0](/php/docs/reference/cloud-ai-platform/0.12.0/V1.Tensorboard)\n- [0.11.1](/php/docs/reference/cloud-ai-platform/0.11.1/V1.Tensorboard)\n- [0.10.0](/php/docs/reference/cloud-ai-platform/0.10.0/V1.Tensorboard) \nReference documentation and code samples for the Google Cloud Ai Platform V1 Client class Tensorboard.\n\nTensorboard is a physical database that stores users' training metrics.\n\nA default Tensorboard is provided in each region of a Google Cloud project.\nIf needed users can also create extra Tensorboards in their projects.\n\nGenerated from protobuf message `google.cloud.aiplatform.v1.Tensorboard`\n\nNamespace\n---------\n\nGoogle \\\\ Cloud \\\\ AIPlatform \\\\ V1\n\nMethods\n-------\n\n### __construct\n\nConstructor.\n\n### getName\n\nOutput only. Name of the Tensorboard.\n\nFormat:\n`projects/{project}/locations/{location}/tensorboards/{tensorboard}`\n\n### setName\n\nOutput only. Name of the Tensorboard.\n\nFormat:\n`projects/{project}/locations/{location}/tensorboards/{tensorboard}`\n\n### getDisplayName\n\nRequired. User provided name of this Tensorboard.\n\n### setDisplayName\n\nRequired. User provided name of this Tensorboard.\n\n### getDescription\n\nDescription of this Tensorboard.\n\n### setDescription\n\nDescription of this Tensorboard.\n\n### getEncryptionSpec\n\nCustomer-managed encryption key spec for a Tensorboard. If set, this\nTensorboard and all sub-resources of this Tensorboard will be secured by\nthis key.\n\n### hasEncryptionSpec\n\n### clearEncryptionSpec\n\n### setEncryptionSpec\n\nCustomer-managed encryption key spec for a Tensorboard. If set, this\nTensorboard and all sub-resources of this Tensorboard will be secured by\nthis key.\n\n### getBlobStoragePathPrefix\n\nOutput only. Consumer project Cloud Storage path prefix used to store blob\ndata, which can either be a bucket or directory. Does not end with a '/'.\n\n### setBlobStoragePathPrefix\n\nOutput only. Consumer project Cloud Storage path prefix used to store blob\ndata, which can either be a bucket or directory. Does not end with a '/'.\n\n### getRunCount\n\nOutput only. The number of Runs stored in this Tensorboard.\n\n### setRunCount\n\nOutput only. The number of Runs stored in this Tensorboard.\n\n### getCreateTime\n\nOutput only. Timestamp when this Tensorboard was created.\n\n### hasCreateTime\n\n### clearCreateTime\n\n### setCreateTime\n\nOutput only. Timestamp when this Tensorboard was created.\n\n### getUpdateTime\n\nOutput only. Timestamp when this Tensorboard was last updated.\n\n### hasUpdateTime\n\n### clearUpdateTime\n\n### setUpdateTime\n\nOutput only. Timestamp when this Tensorboard was last updated.\n\n### getLabels\n\nThe labels with user-defined metadata to organize your Tensorboards.\n\nLabel keys and values can be no longer than 64 characters\n(Unicode codepoints), can only contain lowercase letters, numeric\ncharacters, underscores and dashes. International characters are allowed.\nNo more than 64 user labels can be associated with one Tensorboard\n(System labels are excluded).\nSee \u003chttps://goo.gl/xmQnxf\u003e for more information and examples of labels.\nSystem reserved label keys are prefixed with \"aiplatform.googleapis.com/\"\nand are immutable.\n\n### setLabels\n\nThe labels with user-defined metadata to organize your Tensorboards.\n\nLabel keys and values can be no longer than 64 characters\n(Unicode codepoints), can only contain lowercase letters, numeric\ncharacters, underscores and dashes. International characters are allowed.\nNo more than 64 user labels can be associated with one Tensorboard\n(System labels are excluded).\nSee \u003chttps://goo.gl/xmQnxf\u003e for more information and examples of labels.\nSystem reserved label keys are prefixed with \"aiplatform.googleapis.com/\"\nand are immutable.\n\n### getEtag\n\nUsed to perform a consistent read-modify-write updates. If not set, a blind\n\"overwrite\" update happens.\n\n### setEtag\n\nUsed to perform a consistent read-modify-write updates. If not set, a blind\n\"overwrite\" update happens.\n\n### getIsDefault\n\nUsed to indicate if the TensorBoard instance is the default one.\n\nEach project \\& region can have at most one default TensorBoard instance.\nCreation of a default TensorBoard instance and updating an existing\nTensorBoard instance to be default will mark all other TensorBoard\ninstances (if any) as non default.\n\n### setIsDefault\n\nUsed to indicate if the TensorBoard instance is the default one.\n\nEach project \\& region can have at most one default TensorBoard instance.\nCreation of a default TensorBoard instance and updating an existing\nTensorBoard instance to be default will mark all other TensorBoard\ninstances (if any) as non default.\n\n### getSatisfiesPzs\n\nOutput only. Reserved for future use.\n\n### setSatisfiesPzs\n\nOutput only. Reserved for future use.\n\n### getSatisfiesPzi\n\nOutput only. Reserved for future use.\n\n### setSatisfiesPzi\n\nOutput only. Reserved for future use."]]
