Skip to main content

time_series

Overview

Nametime_series
TypeResource
Idgoogle.aiplatform.time_series

Fields

NameDatatypeDescription
namestringOutput only. Name of the TensorboardTimeSeries.
descriptionstringDescription of this TensorboardTimeSeries.
createTimestringOutput only. Timestamp when this TensorboardTimeSeries was created.
displayNamestringRequired. User provided name of this TensorboardTimeSeries. This value should be unique among all TensorboardTimeSeries resources belonging to the same TensorboardRun resource (parent resource).
etagstringUsed to perform a consistent read-modify-write updates. If not set, a blind "overwrite" update happens.
metadataobjectDescribes metadata for a TensorboardTimeSeries.
pluginDatastringData of the current plugin, with the size limited to 65KB.
pluginNamestringImmutable. Name of the plugin this time series pertain to. Such as Scalar, Tensor, Blob
updateTimestringOutput only. Timestamp when this TensorboardTimeSeries was last updated.
valueTypestringRequired. Immutable. Type of TensorboardTimeSeries value.

Methods

NameAccessible byRequired ParamsDescription
getSELECTexperimentsId, locationsId, projectsId, runsId, tensorboardsId, timeSeriesIdGets a TensorboardTimeSeries.
listSELECTexperimentsId, locationsId, projectsId, runsId, tensorboardsIdLists TensorboardTimeSeries in a Location.
createINSERTexperimentsId, locationsId, projectsId, runsId, tensorboardsIdCreates a TensorboardTimeSeries.
deleteDELETEexperimentsId, locationsId, projectsId, runsId, tensorboardsId, timeSeriesIdDeletes a TensorboardTimeSeries.
_listEXECexperimentsId, locationsId, projectsId, runsId, tensorboardsIdLists TensorboardTimeSeries in a Location.
batch_createEXECexperimentsId, locationsId, projectsId, runsId, tensorboardsIdBatch create TensorboardTimeSeries that belong to a TensorboardExperiment.
batch_readEXECexperimentsId, locationsId, projectsId, runsId, tensorboardsIdReads 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.
export_tensorboard_time_seriesEXECexperimentsId, locationsId, projectsId, runsId, tensorboardsId, timeSeriesIdExports a TensorboardTimeSeries' data. Data is returned in paginated responses.
patchEXECexperimentsId, locationsId, projectsId, runsId, tensorboardsId, timeSeriesIdUpdates a TensorboardTimeSeries.
readEXECexperimentsId, locationsId, projectsId, runsId, tensorboardsId, timeSeriesIdReads a TensorboardTimeSeries' data. By default, if the number of data points stored is less than 1000, all data is returned. Otherwise, 1000 data points is randomly selected from this time series and returned. This value can be changed by changing max_data_points, which can't be greater than 10k.
read_blob_dataEXECexperimentsId, locationsId, projectsId, runsId, tensorboardsId, timeSeriesIdGets bytes of TensorboardBlobs. This is to allow reading blob data stored in consumer project's Cloud Storage bucket without users having to obtain Cloud Storage access permission.