Generated from protobuf message google.cloud.aiplatform.v1.ExportTensorboardTimeSeriesDataRequest
Namespace
Google \ Cloud \ AIPlatform \ V1
Methods
__construct
Constructor.
Parameters
Name
Description
data
array
Optional. Data for populating the Message object.
↳ tensorboard_time_series
string
Required. The resource name of the TensorboardTimeSeries to export data from. Format: projects/{project}/locations/{location}/tensorboards/{tensorboard}/experiments/{experiment}/runs/{run}/timeSeries/{time_series}
↳ filter
string
Exports the TensorboardTimeSeries' data that match the filter expression.
↳ page_size
int
The maximum number of data points to return per page. The default page_size is 1000. Values must be between 1 and 10000. Values above 10000 are coerced to 10000.
↳ page_token
string
A page token, received from a previous ExportTensorboardTimeSeriesData call. Provide this to retrieve the subsequent page. When paginating, all other parameters provided to ExportTensorboardTimeSeriesData must match the call that provided the page token.
↳ order_by
string
Field to use to sort the TensorboardTimeSeries' data. By default, TensorboardTimeSeries' data is returned in a pseudo random order.
getTensorboardTimeSeries
Required. The resource name of the TensorboardTimeSeries to export data
from. Format:
projects/{project}/locations/{location}/tensorboards/{tensorboard}/experiments/{experiment}/runs/{run}/timeSeries/{time_series}
Returns
Type
Description
string
setTensorboardTimeSeries
Required. The resource name of the TensorboardTimeSeries to export data
from. Format:
projects/{project}/locations/{location}/tensorboards/{tensorboard}/experiments/{experiment}/runs/{run}/timeSeries/{time_series}
Parameter
Name
Description
var
string
Returns
Type
Description
$this
getFilter
Exports the TensorboardTimeSeries' data that match the filter expression.
Returns
Type
Description
string
setFilter
Exports the TensorboardTimeSeries' data that match the filter expression.
Parameter
Name
Description
var
string
Returns
Type
Description
$this
getPageSize
The maximum number of data points to return per page.
The default page_size is 1000. Values must be between 1 and 10000.
Values above 10000 are coerced to 10000.
Returns
Type
Description
int
setPageSize
The maximum number of data points to return per page.
The default page_size is 1000. Values must be between 1 and 10000.
Values above 10000 are coerced to 10000.
When paginating, all other parameters provided to
ExportTensorboardTimeSeriesData
must match the call that provided the page token.
Parameter
Name
Description
var
string
Returns
Type
Description
$this
getOrderBy
Field to use to sort the TensorboardTimeSeries' data.
By default, TensorboardTimeSeries' data is returned in a pseudo random
order.
Returns
Type
Description
string
setOrderBy
Field to use to sort the TensorboardTimeSeries' data.
By default, TensorboardTimeSeries' data is returned in a pseudo random
order.
Parameter
Name
Description
var
string
Returns
Type
Description
$this
static::build
Parameter
Name
Description
tensorboardTimeSeries
string
Required. The resource name of the TensorboardTimeSeries to export data
from. Format:
projects/{project}/locations/{location}/tensorboards/{tensorboard}/experiments/{experiment}/runs/{run}/timeSeries/{time_series}
Please see TensorboardServiceClient::tensorboardTimeSeriesName() for help formatting this field.
[[["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 ExportTensorboardTimeSeriesDataRequest (1.35.0)\n\nVersion latestkeyboard_arrow_down\n\n- [1.35.0 (latest)](/php/docs/reference/cloud-ai-platform/latest/V1.ExportTensorboardTimeSeriesDataRequest)\n- [1.34.0](/php/docs/reference/cloud-ai-platform/1.34.0/V1.ExportTensorboardTimeSeriesDataRequest)\n- [1.33.0](/php/docs/reference/cloud-ai-platform/1.33.0/V1.ExportTensorboardTimeSeriesDataRequest)\n- [1.32.1](/php/docs/reference/cloud-ai-platform/1.32.1/V1.ExportTensorboardTimeSeriesDataRequest)\n- [1.31.0](/php/docs/reference/cloud-ai-platform/1.31.0/V1.ExportTensorboardTimeSeriesDataRequest)\n- [1.30.0](/php/docs/reference/cloud-ai-platform/1.30.0/V1.ExportTensorboardTimeSeriesDataRequest)\n- [1.26.0](/php/docs/reference/cloud-ai-platform/1.26.0/V1.ExportTensorboardTimeSeriesDataRequest)\n- [1.23.0](/php/docs/reference/cloud-ai-platform/1.23.0/V1.ExportTensorboardTimeSeriesDataRequest)\n- [1.22.0](/php/docs/reference/cloud-ai-platform/1.22.0/V1.ExportTensorboardTimeSeriesDataRequest)\n- [1.21.0](/php/docs/reference/cloud-ai-platform/1.21.0/V1.ExportTensorboardTimeSeriesDataRequest)\n- [1.20.0](/php/docs/reference/cloud-ai-platform/1.20.0/V1.ExportTensorboardTimeSeriesDataRequest)\n- [1.19.0](/php/docs/reference/cloud-ai-platform/1.19.0/V1.ExportTensorboardTimeSeriesDataRequest)\n- [1.18.0](/php/docs/reference/cloud-ai-platform/1.18.0/V1.ExportTensorboardTimeSeriesDataRequest)\n- [1.17.0](/php/docs/reference/cloud-ai-platform/1.17.0/V1.ExportTensorboardTimeSeriesDataRequest)\n- [1.16.0](/php/docs/reference/cloud-ai-platform/1.16.0/V1.ExportTensorboardTimeSeriesDataRequest)\n- [1.15.0](/php/docs/reference/cloud-ai-platform/1.15.0/V1.ExportTensorboardTimeSeriesDataRequest)\n- [1.14.0](/php/docs/reference/cloud-ai-platform/1.14.0/V1.ExportTensorboardTimeSeriesDataRequest)\n- [1.13.1](/php/docs/reference/cloud-ai-platform/1.13.1/V1.ExportTensorboardTimeSeriesDataRequest)\n- [1.12.0](/php/docs/reference/cloud-ai-platform/1.12.0/V1.ExportTensorboardTimeSeriesDataRequest)\n- [1.11.0](/php/docs/reference/cloud-ai-platform/1.11.0/V1.ExportTensorboardTimeSeriesDataRequest)\n- [1.10.0](/php/docs/reference/cloud-ai-platform/1.10.0/V1.ExportTensorboardTimeSeriesDataRequest)\n- [1.9.0](/php/docs/reference/cloud-ai-platform/1.9.0/V1.ExportTensorboardTimeSeriesDataRequest)\n- [1.8.0](/php/docs/reference/cloud-ai-platform/1.8.0/V1.ExportTensorboardTimeSeriesDataRequest)\n- [1.7.0](/php/docs/reference/cloud-ai-platform/1.7.0/V1.ExportTensorboardTimeSeriesDataRequest)\n- [1.6.0](/php/docs/reference/cloud-ai-platform/1.6.0/V1.ExportTensorboardTimeSeriesDataRequest)\n- [1.5.0](/php/docs/reference/cloud-ai-platform/1.5.0/V1.ExportTensorboardTimeSeriesDataRequest)\n- [1.4.0](/php/docs/reference/cloud-ai-platform/1.4.0/V1.ExportTensorboardTimeSeriesDataRequest)\n- [1.3.0](/php/docs/reference/cloud-ai-platform/1.3.0/V1.ExportTensorboardTimeSeriesDataRequest)\n- [1.2.0](/php/docs/reference/cloud-ai-platform/1.2.0/V1.ExportTensorboardTimeSeriesDataRequest)\n- [1.1.0](/php/docs/reference/cloud-ai-platform/1.1.0/V1.ExportTensorboardTimeSeriesDataRequest)\n- [1.0.0](/php/docs/reference/cloud-ai-platform/1.0.0/V1.ExportTensorboardTimeSeriesDataRequest)\n- [0.39.0](/php/docs/reference/cloud-ai-platform/0.39.0/V1.ExportTensorboardTimeSeriesDataRequest)\n- [0.38.0](/php/docs/reference/cloud-ai-platform/0.38.0/V1.ExportTensorboardTimeSeriesDataRequest)\n- [0.37.1](/php/docs/reference/cloud-ai-platform/0.37.1/V1.ExportTensorboardTimeSeriesDataRequest)\n- [0.32.0](/php/docs/reference/cloud-ai-platform/0.32.0/V1.ExportTensorboardTimeSeriesDataRequest)\n- [0.31.0](/php/docs/reference/cloud-ai-platform/0.31.0/V1.ExportTensorboardTimeSeriesDataRequest)\n- [0.30.0](/php/docs/reference/cloud-ai-platform/0.30.0/V1.ExportTensorboardTimeSeriesDataRequest)\n- [0.29.0](/php/docs/reference/cloud-ai-platform/0.29.0/V1.ExportTensorboardTimeSeriesDataRequest)\n- [0.28.0](/php/docs/reference/cloud-ai-platform/0.28.0/V1.ExportTensorboardTimeSeriesDataRequest)\n- [0.27.0](/php/docs/reference/cloud-ai-platform/0.27.0/V1.ExportTensorboardTimeSeriesDataRequest)\n- [0.26.2](/php/docs/reference/cloud-ai-platform/0.26.2/V1.ExportTensorboardTimeSeriesDataRequest)\n- [0.25.0](/php/docs/reference/cloud-ai-platform/0.25.0/V1.ExportTensorboardTimeSeriesDataRequest)\n- [0.24.0](/php/docs/reference/cloud-ai-platform/0.24.0/V1.ExportTensorboardTimeSeriesDataRequest)\n- [0.23.0](/php/docs/reference/cloud-ai-platform/0.23.0/V1.ExportTensorboardTimeSeriesDataRequest)\n- [0.22.0](/php/docs/reference/cloud-ai-platform/0.22.0/V1.ExportTensorboardTimeSeriesDataRequest)\n- [0.21.0](/php/docs/reference/cloud-ai-platform/0.21.0/V1.ExportTensorboardTimeSeriesDataRequest)\n- [0.20.0](/php/docs/reference/cloud-ai-platform/0.20.0/V1.ExportTensorboardTimeSeriesDataRequest)\n- [0.19.0](/php/docs/reference/cloud-ai-platform/0.19.0/V1.ExportTensorboardTimeSeriesDataRequest)\n- [0.18.0](/php/docs/reference/cloud-ai-platform/0.18.0/V1.ExportTensorboardTimeSeriesDataRequest)\n- [0.17.0](/php/docs/reference/cloud-ai-platform/0.17.0/V1.ExportTensorboardTimeSeriesDataRequest)\n- [0.16.0](/php/docs/reference/cloud-ai-platform/0.16.0/V1.ExportTensorboardTimeSeriesDataRequest)\n- [0.15.0](/php/docs/reference/cloud-ai-platform/0.15.0/V1.ExportTensorboardTimeSeriesDataRequest)\n- [0.13.0](/php/docs/reference/cloud-ai-platform/0.13.0/V1.ExportTensorboardTimeSeriesDataRequest)\n- [0.12.0](/php/docs/reference/cloud-ai-platform/0.12.0/V1.ExportTensorboardTimeSeriesDataRequest)\n- [0.11.1](/php/docs/reference/cloud-ai-platform/0.11.1/V1.ExportTensorboardTimeSeriesDataRequest)\n- [0.10.0](/php/docs/reference/cloud-ai-platform/0.10.0/V1.ExportTensorboardTimeSeriesDataRequest) \nReference documentation and code samples for the Google Cloud Ai Platform V1 Client class ExportTensorboardTimeSeriesDataRequest.\n\nRequest message for\n[TensorboardService.ExportTensorboardTimeSeriesData](/php/docs/reference/cloud-ai-platform/latest/V1.Client.TensorboardServiceClient#_Google_Cloud_AIPlatform_V1_Client_TensorboardServiceClient__exportTensorboardTimeSeriesData__).\n\nGenerated from protobuf message `google.cloud.aiplatform.v1.ExportTensorboardTimeSeriesDataRequest`\n\nNamespace\n---------\n\nGoogle \\\\ Cloud \\\\ AIPlatform \\\\ V1\n\nMethods\n-------\n\n### __construct\n\nConstructor.\n\n### getTensorboardTimeSeries\n\nRequired. The resource name of the TensorboardTimeSeries to export data\nfrom. Format:\n`projects/{project}/locations/{location}/tensorboards/{tensorboard}/experiments/{experiment}/runs/{run}/timeSeries/{time_series}`\n\n### setTensorboardTimeSeries\n\nRequired. The resource name of the TensorboardTimeSeries to export data\nfrom. Format:\n`projects/{project}/locations/{location}/tensorboards/{tensorboard}/experiments/{experiment}/runs/{run}/timeSeries/{time_series}`\n\n### getFilter\n\nExports the TensorboardTimeSeries' data that match the filter expression.\n\n### setFilter\n\nExports the TensorboardTimeSeries' data that match the filter expression.\n\n### getPageSize\n\nThe maximum number of data points to return per page.\n\nThe default page_size is 1000. Values must be between 1 and 10000.\nValues above 10000 are coerced to 10000.\n\n### setPageSize\n\nThe maximum number of data points to return per page.\n\nThe default page_size is 1000. Values must be between 1 and 10000.\nValues above 10000 are coerced to 10000.\n\n### getPageToken\n\nA page token, received from a previous\n[ExportTensorboardTimeSeriesData](/php/docs/reference/cloud-ai-platform/latest/V1.Client.TensorboardServiceClient#_Google_Cloud_AIPlatform_V1_Client_TensorboardServiceClient__exportTensorboardTimeSeriesData__)\ncall. Provide this to retrieve the subsequent page.\n\nWhen paginating, all other parameters provided to\n[ExportTensorboardTimeSeriesData](/php/docs/reference/cloud-ai-platform/latest/V1.Client.TensorboardServiceClient#_Google_Cloud_AIPlatform_V1_Client_TensorboardServiceClient__exportTensorboardTimeSeriesData__)\nmust match the call that provided the page token.\n\n### setPageToken\n\nA page token, received from a previous\n[ExportTensorboardTimeSeriesData](/php/docs/reference/cloud-ai-platform/latest/V1.Client.TensorboardServiceClient#_Google_Cloud_AIPlatform_V1_Client_TensorboardServiceClient__exportTensorboardTimeSeriesData__)\ncall. Provide this to retrieve the subsequent page.\n\nWhen paginating, all other parameters provided to\n[ExportTensorboardTimeSeriesData](/php/docs/reference/cloud-ai-platform/latest/V1.Client.TensorboardServiceClient#_Google_Cloud_AIPlatform_V1_Client_TensorboardServiceClient__exportTensorboardTimeSeriesData__)\nmust match the call that provided the page token.\n\n### getOrderBy\n\nField to use to sort the TensorboardTimeSeries' data.\n\nBy default, TensorboardTimeSeries' data is returned in a pseudo random\norder.\n\n### setOrderBy\n\nField to use to sort the TensorboardTimeSeries' data.\n\nBy default, TensorboardTimeSeries' data is returned in a pseudo random\norder.\n\n### static::build"]]
