time_series

Creates, updates, deletes, gets or lists a time_series resource.

Overview

Name	time_series
Type	Resource
Id	google.aiplatform.time_series

Fields

Name	Datatype	Description
name	string	Output only. Name of the TensorboardTimeSeries.
description	string	Description of this TensorboardTimeSeries.
createTime	string	Output only. Timestamp when this TensorboardTimeSeries was created.
displayName	string	Required. User provided name of this TensorboardTimeSeries. This value should be unique among all TensorboardTimeSeries resources belonging to the same TensorboardRun resource (parent resource).
etag	string	Used to perform a consistent read-modify-write updates. If not set, a blind "overwrite" update happens.
metadata	object	Describes metadata for a TensorboardTimeSeries.
pluginData	string	Data of the current plugin, with the size limited to 65KB.
pluginName	string	Immutable. Name of the plugin this time series pertain to. Such as Scalar, Tensor, Blob
updateTime	string	Output only. Timestamp when this TensorboardTimeSeries was last updated.
valueType	string	Required. Immutable. Type of TensorboardTimeSeries value.

Methods

Name	Accessible by	Required Params	Description
get	SELECT	experimentsId, locationsId, projectsId, runsId, tensorboardsId, timeSeriesId	Gets a TensorboardTimeSeries.
list	SELECT	experimentsId, locationsId, projectsId, runsId, tensorboardsId	Lists TensorboardTimeSeries in a Location.
create	INSERT	experimentsId, locationsId, projectsId, runsId, tensorboardsId	Creates a TensorboardTimeSeries.
delete	DELETE	experimentsId, locationsId, projectsId, runsId, tensorboardsId, timeSeriesId	Deletes a TensorboardTimeSeries.
patch	UPDATE	experimentsId, locationsId, projectsId, runsId, tensorboardsId, timeSeriesId	Updates a TensorboardTimeSeries.
export_tensorboard_time_series	EXEC	experimentsId, locationsId, projectsId, runsId, tensorboardsId, timeSeriesId	Exports a TensorboardTimeSeries' data. Data is returned in paginated responses.
read	EXEC	experimentsId, locationsId, projectsId, runsId, tensorboardsId, timeSeriesId	Reads 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_data	EXEC	experimentsId, locationsId, projectsId, runsId, tensorboardsId, timeSeriesId	Gets 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.

SELECT examples

Lists TensorboardTimeSeries in a Location.

SELECT
name,
description,
createTime,
displayName,
etag,
metadata,
pluginData,
pluginName,
updateTime,
valueType
FROM google.aiplatform.time_series
WHERE experimentsId = '{{ experimentsId }}'
AND locationsId = '{{ locationsId }}'
AND projectsId = '{{ projectsId }}'
AND runsId = '{{ runsId }}'
AND tensorboardsId = '{{ tensorboardsId }}';

INSERT example

Use the following StackQL query and manifest file to create a new time_series resource.

All Properties

/*+ create */
INSERT INTO google.aiplatform.time_series (
experimentsId,
locationsId,
projectsId,
runsId,
tensorboardsId,
description,
pluginData,
valueType,
etag,
displayName,
pluginName
)
SELECT 
'{{ experimentsId }}',
'{{ locationsId }}',
'{{ projectsId }}',
'{{ runsId }}',
'{{ tensorboardsId }}',
'{{ description }}',
'{{ pluginData }}',
'{{ valueType }}',
'{{ etag }}',
'{{ displayName }}',
'{{ pluginName }}'
;

Manifest

- name: your_resource_model_name
  props:
    - name: metadata
      value:
        - name: maxStep
          value: string
        - name: maxWallTime
          value: string
        - name: maxBlobSequenceLength
          value: string
    - name: description
      value: string
    - name: pluginData
      value: string
    - name: name
      value: string
    - name: valueType
      value: string
    - name: etag
      value: string
    - name: displayName
      value: string
    - name: pluginName
      value: string
    - name: updateTime
      value: string
    - name: createTime
      value: string

UPDATE example

Updates a time_series resource.

/*+ update */
UPDATE google.aiplatform.time_series
SET 
description = '{{ description }}',
pluginData = '{{ pluginData }}',
valueType = '{{ valueType }}',
etag = '{{ etag }}',
displayName = '{{ displayName }}',
pluginName = '{{ pluginName }}'
WHERE 
experimentsId = '{{ experimentsId }}'
AND locationsId = '{{ locationsId }}'
AND projectsId = '{{ projectsId }}'
AND runsId = '{{ runsId }}'
AND tensorboardsId = '{{ tensorboardsId }}'
AND timeSeriesId = '{{ timeSeriesId }}';

DELETE example

Deletes the specified time_series resource.

/*+ delete */
DELETE FROM google.aiplatform.time_series
WHERE experimentsId = '{{ experimentsId }}'
AND locationsId = '{{ locationsId }}'
AND projectsId = '{{ projectsId }}'
AND runsId = '{{ runsId }}'
AND tensorboardsId = '{{ tensorboardsId }}'
AND timeSeriesId = '{{ timeSeriesId }}';