Stay organized with collections
Save and categorize content based on your preferences.
Reads multiple TensorboardTimeSeries' data. The data point number limit
is 1000 for scalars, 100 for tensors and blob references. If the number
of data points stored is less than the limit, all data is returned.
Otherwise, the number limit of data points is randomly selected from
this time series and returned.
Arguments
Parameters
tensorboard
string
Required. The resource name of the Tensorboard containing TensorboardTimeSeries to read data from. Format: projects/{project}/locations/{location}/tensorboards/{tensorboard}. The TensorboardTimeSeries referenced by time_series must be sub resources of this Tensorboard.
timeSeries
string
Required. The resource names of the TensorboardTimeSeries to read data from. Format: projects/{project}/locations/{location}/tensorboards/{tensorboard}/experiments/{experiment}/runs/{run}/timeSeries/{time_series}
region
string
Required. Region of the HTTP endpoint. For example, if region is set to us-central1, the endpoint https://us-central1-integrations.googleapis.com will be used. See service endpoints.
Raised exceptions
Exceptions
ConnectionError
In case of a network problem (such as DNS failure or refused connection).
HttpError
If the response status is >= 400 (excluding 429 and 503).
TimeoutError
If a long-running operation takes longer to finish than the specified timeout limit.
TypeError
If an operation or function receives an argument of the wrong type.
ValueError
If an operation or function receives an argument of the right type but an inappropriate value. For example, a negative timeout.
[[["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-08-28 UTC."],[],[],null,["# Method: googleapis.aiplatform.v1.projects.locations.tensorboards.batchRead\n\n| **Preview**\n|\n|\n| This feature is subject to the \"Pre-GA Offerings Terms\" in the General Service Terms section\n| of the [Service Specific Terms](/terms/service-terms#1).\n|\n| Pre-GA features are available \"as is\" and might have limited support.\n|\n| For more information, see the\n| [launch stage descriptions](/products#product-launch-stages).\n\nReads multiple TensorboardTimeSeries' data. The data point number limit\nis 1000 for scalars, 100 for tensors and blob references. If the number\nof data points stored is less than the limit, all data is returned.\nOtherwise, the number limit of data points is randomly selected from\nthis time series and returned.\n\nArguments\n---------\n\nRaised exceptions\n-----------------\n\nResponse\n--------\n\nIf successful, the response contains an instance of [`GoogleCloudAiplatformV1BatchReadTensorboardTimeSeriesDataResponse`](https://cloud.google.com/workflows/docs/reference/googleapis/aiplatform/v1/Overview#GoogleCloudAiplatformV1BatchReadTensorboardTimeSeriesDataResponse).\n\nSubworkflow snippet\n-------------------\n\nSome fields might be optional or required.\nTo identify required fields, refer to the [API documentation](https://cloud.google.com/vertex-ai/docs/reference/rest/v1/projects.locations.tensorboards/batchRead). \n\n### YAML\n\n```yaml\n- batchRead:\n call: googleapis.aiplatform.v1.projects.locations.tensorboards.batchRead\n args:\n tensorboard: ...\n timeSeries: ...\n region: ...\n result: batchReadResult\n```\n\n### JSON\n\n```json\n[\n {\n \"batchRead\": {\n \"call\": \"googleapis.aiplatform.v1.projects.locations.tensorboards.batchRead\",\n \"args\": {\n \"tensorboard\": \"...\",\n \"timeSeries\": \"...\",\n \"region\": \"...\"\n },\n \"result\": \"batchReadResult\"\n }\n }\n]\n```"]]