Reference documentation and code samples for the Google Cloud Ai Platform V1 Client class TensorboardRun.
TensorboardRun maps to a specific execution of a training job with a given
set of hyperparameter values, model definition, dataset, etc
Generated from protobuf message google.cloud.aiplatform.v1.TensorboardRun
Namespace
Google \ Cloud \ AIPlatform \ V1
Methods
__construct
Constructor.
Parameters
Name
Description
data
array
Optional. Data for populating the Message object.
↳ name
string
Output only. Name of the TensorboardRun. Format: projects/{project}/locations/{location}/tensorboards/{tensorboard}/experiments/{experiment}/runs/{run}
↳ display_name
string
Required. User provided name of this TensorboardRun. This value must be unique among all TensorboardRuns belonging to the same parent TensorboardExperiment.
The labels with user-defined metadata to organize your TensorboardRuns. This field will be used to filter and visualize Runs in the Tensorboard UI. For example, a Vertex AI training job can set a label aiplatform.googleapis.com/training_job_id=xxxxx to all the runs created within that job. An end user can set a label experiment_id=xxxxx for all the runs produced in a Jupyter notebook. These runs can be grouped by a label value and visualized together in the Tensorboard UI. 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 TensorboardRun (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.
The labels with user-defined metadata to organize your TensorboardRuns.
This field will be used to filter and visualize Runs in the Tensorboard UI.
For example, a Vertex AI training job can set a label
aiplatform.googleapis.com/training_job_id=xxxxx to all the runs created
within that job. An end user can set a label experiment_id=xxxxx for all
the runs produced in a Jupyter notebook. These runs can be grouped by a
label value and visualized together in the Tensorboard UI.
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 TensorboardRun
(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.
The labels with user-defined metadata to organize your TensorboardRuns.
This field will be used to filter and visualize Runs in the Tensorboard UI.
For example, a Vertex AI training job can set a label
aiplatform.googleapis.com/training_job_id=xxxxx to all the runs created
within that job. An end user can set a label experiment_id=xxxxx for all
the runs produced in a Jupyter notebook. These runs can be grouped by a
label value and visualized together in the Tensorboard UI.
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 TensorboardRun
(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.
[[["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-04 UTC."],[],[],null,["# Google Cloud Ai Platform V1 Client - Class TensorboardRun (1.35.0)\n\nVersion latestkeyboard_arrow_down\n\n- [1.35.0 (latest)](/php/docs/reference/cloud-ai-platform/latest/V1.TensorboardRun)\n- [1.34.0](/php/docs/reference/cloud-ai-platform/1.34.0/V1.TensorboardRun)\n- [1.33.0](/php/docs/reference/cloud-ai-platform/1.33.0/V1.TensorboardRun)\n- [1.32.1](/php/docs/reference/cloud-ai-platform/1.32.1/V1.TensorboardRun)\n- [1.31.0](/php/docs/reference/cloud-ai-platform/1.31.0/V1.TensorboardRun)\n- [1.30.0](/php/docs/reference/cloud-ai-platform/1.30.0/V1.TensorboardRun)\n- [1.26.0](/php/docs/reference/cloud-ai-platform/1.26.0/V1.TensorboardRun)\n- [1.23.0](/php/docs/reference/cloud-ai-platform/1.23.0/V1.TensorboardRun)\n- [1.22.0](/php/docs/reference/cloud-ai-platform/1.22.0/V1.TensorboardRun)\n- [1.21.0](/php/docs/reference/cloud-ai-platform/1.21.0/V1.TensorboardRun)\n- [1.20.0](/php/docs/reference/cloud-ai-platform/1.20.0/V1.TensorboardRun)\n- [1.19.0](/php/docs/reference/cloud-ai-platform/1.19.0/V1.TensorboardRun)\n- [1.18.0](/php/docs/reference/cloud-ai-platform/1.18.0/V1.TensorboardRun)\n- [1.17.0](/php/docs/reference/cloud-ai-platform/1.17.0/V1.TensorboardRun)\n- [1.16.0](/php/docs/reference/cloud-ai-platform/1.16.0/V1.TensorboardRun)\n- [1.15.0](/php/docs/reference/cloud-ai-platform/1.15.0/V1.TensorboardRun)\n- [1.14.0](/php/docs/reference/cloud-ai-platform/1.14.0/V1.TensorboardRun)\n- [1.13.1](/php/docs/reference/cloud-ai-platform/1.13.1/V1.TensorboardRun)\n- [1.12.0](/php/docs/reference/cloud-ai-platform/1.12.0/V1.TensorboardRun)\n- [1.11.0](/php/docs/reference/cloud-ai-platform/1.11.0/V1.TensorboardRun)\n- [1.10.0](/php/docs/reference/cloud-ai-platform/1.10.0/V1.TensorboardRun)\n- [1.9.0](/php/docs/reference/cloud-ai-platform/1.9.0/V1.TensorboardRun)\n- [1.8.0](/php/docs/reference/cloud-ai-platform/1.8.0/V1.TensorboardRun)\n- [1.7.0](/php/docs/reference/cloud-ai-platform/1.7.0/V1.TensorboardRun)\n- [1.6.0](/php/docs/reference/cloud-ai-platform/1.6.0/V1.TensorboardRun)\n- [1.5.0](/php/docs/reference/cloud-ai-platform/1.5.0/V1.TensorboardRun)\n- [1.4.0](/php/docs/reference/cloud-ai-platform/1.4.0/V1.TensorboardRun)\n- [1.3.0](/php/docs/reference/cloud-ai-platform/1.3.0/V1.TensorboardRun)\n- [1.2.0](/php/docs/reference/cloud-ai-platform/1.2.0/V1.TensorboardRun)\n- [1.1.0](/php/docs/reference/cloud-ai-platform/1.1.0/V1.TensorboardRun)\n- [1.0.0](/php/docs/reference/cloud-ai-platform/1.0.0/V1.TensorboardRun)\n- [0.39.0](/php/docs/reference/cloud-ai-platform/0.39.0/V1.TensorboardRun)\n- [0.38.0](/php/docs/reference/cloud-ai-platform/0.38.0/V1.TensorboardRun)\n- [0.37.1](/php/docs/reference/cloud-ai-platform/0.37.1/V1.TensorboardRun)\n- [0.32.0](/php/docs/reference/cloud-ai-platform/0.32.0/V1.TensorboardRun)\n- [0.31.0](/php/docs/reference/cloud-ai-platform/0.31.0/V1.TensorboardRun)\n- [0.30.0](/php/docs/reference/cloud-ai-platform/0.30.0/V1.TensorboardRun)\n- [0.29.0](/php/docs/reference/cloud-ai-platform/0.29.0/V1.TensorboardRun)\n- [0.28.0](/php/docs/reference/cloud-ai-platform/0.28.0/V1.TensorboardRun)\n- [0.27.0](/php/docs/reference/cloud-ai-platform/0.27.0/V1.TensorboardRun)\n- [0.26.2](/php/docs/reference/cloud-ai-platform/0.26.2/V1.TensorboardRun)\n- [0.25.0](/php/docs/reference/cloud-ai-platform/0.25.0/V1.TensorboardRun)\n- [0.24.0](/php/docs/reference/cloud-ai-platform/0.24.0/V1.TensorboardRun)\n- [0.23.0](/php/docs/reference/cloud-ai-platform/0.23.0/V1.TensorboardRun)\n- [0.22.0](/php/docs/reference/cloud-ai-platform/0.22.0/V1.TensorboardRun)\n- [0.21.0](/php/docs/reference/cloud-ai-platform/0.21.0/V1.TensorboardRun)\n- [0.20.0](/php/docs/reference/cloud-ai-platform/0.20.0/V1.TensorboardRun)\n- [0.19.0](/php/docs/reference/cloud-ai-platform/0.19.0/V1.TensorboardRun)\n- [0.18.0](/php/docs/reference/cloud-ai-platform/0.18.0/V1.TensorboardRun)\n- [0.17.0](/php/docs/reference/cloud-ai-platform/0.17.0/V1.TensorboardRun)\n- [0.16.0](/php/docs/reference/cloud-ai-platform/0.16.0/V1.TensorboardRun)\n- [0.15.0](/php/docs/reference/cloud-ai-platform/0.15.0/V1.TensorboardRun)\n- [0.13.0](/php/docs/reference/cloud-ai-platform/0.13.0/V1.TensorboardRun)\n- [0.12.0](/php/docs/reference/cloud-ai-platform/0.12.0/V1.TensorboardRun)\n- [0.11.1](/php/docs/reference/cloud-ai-platform/0.11.1/V1.TensorboardRun)\n- [0.10.0](/php/docs/reference/cloud-ai-platform/0.10.0/V1.TensorboardRun) \nReference documentation and code samples for the Google Cloud Ai Platform V1 Client class TensorboardRun.\n\nTensorboardRun maps to a specific execution of a training job with a given\nset of hyperparameter values, model definition, dataset, etc\n\nGenerated from protobuf message `google.cloud.aiplatform.v1.TensorboardRun`\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 TensorboardRun.\n\nFormat:\n`projects/{project}/locations/{location}/tensorboards/{tensorboard}/experiments/{experiment}/runs/{run}`\n\n### setName\n\nOutput only. Name of the TensorboardRun.\n\nFormat:\n`projects/{project}/locations/{location}/tensorboards/{tensorboard}/experiments/{experiment}/runs/{run}`\n\n### getDisplayName\n\nRequired. User provided name of this TensorboardRun.\n\nThis value must be unique among all TensorboardRuns\nbelonging to the same parent TensorboardExperiment.\n\n### setDisplayName\n\nRequired. User provided name of this TensorboardRun.\n\nThis value must be unique among all TensorboardRuns\nbelonging to the same parent TensorboardExperiment.\n\n### getDescription\n\nDescription of this TensorboardRun.\n\n### setDescription\n\nDescription of this TensorboardRun.\n\n### getCreateTime\n\nOutput only. Timestamp when this TensorboardRun was created.\n\n### hasCreateTime\n\n### clearCreateTime\n\n### setCreateTime\n\nOutput only. Timestamp when this TensorboardRun was created.\n\n### getUpdateTime\n\nOutput only. Timestamp when this TensorboardRun was last updated.\n\n### hasUpdateTime\n\n### clearUpdateTime\n\n### setUpdateTime\n\nOutput only. Timestamp when this TensorboardRun was last updated.\n\n### getLabels\n\nThe labels with user-defined metadata to organize your TensorboardRuns.\n\nThis field will be used to filter and visualize Runs in the Tensorboard UI.\nFor example, a Vertex AI training job can set a label\naiplatform.googleapis.com/training_job_id=xxxxx to all the runs created\nwithin that job. An end user can set a label experiment_id=xxxxx for all\nthe runs produced in a Jupyter notebook. These runs can be grouped by a\nlabel value and visualized together in the Tensorboard UI.\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 TensorboardRun\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 TensorboardRuns.\n\nThis field will be used to filter and visualize Runs in the Tensorboard UI.\nFor example, a Vertex AI training job can set a label\naiplatform.googleapis.com/training_job_id=xxxxx to all the runs created\nwithin that job. An end user can set a label experiment_id=xxxxx for all\nthe runs produced in a Jupyter notebook. These runs can be grouped by a\nlabel value and visualized together in the Tensorboard UI.\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 TensorboardRun\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."]]
