time_series

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

Overview

Name	time_series
Type	Resource
Id	google.aiplatform.time_series

Fields

The following fields are returned by SELECT queries:

get

Successful response

Name	Datatype	Description
name	string	Output only. Name of the TensorboardTimeSeries.
createTime	string (google-datetime)	Output only. Timestamp when this TensorboardTimeSeries was created.
description	string	Description of this TensorboardTimeSeries.
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	Output only. Scalar, Tensor, or Blob metadata for this TensorboardTimeSeries. (id: GoogleCloudAiplatformV1TensorboardTimeSeriesMetadata)
pluginData	string (byte)	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 (google-datetime)	Output only. Timestamp when this TensorboardTimeSeries was last updated.
valueType	string	Required. Immutable. Type of TensorboardTimeSeries value.

list

Successful response

Name	Datatype	Description
name	string	Output only. Name of the TensorboardTimeSeries.
createTime	string (google-datetime)	Output only. Timestamp when this TensorboardTimeSeries was created.
description	string	Description of this TensorboardTimeSeries.
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	Output only. Scalar, Tensor, or Blob metadata for this TensorboardTimeSeries. (id: GoogleCloudAiplatformV1TensorboardTimeSeriesMetadata)
pluginData	string (byte)	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 (google-datetime)	Output only. Timestamp when this TensorboardTimeSeries was last updated.
valueType	string	Required. Immutable. Type of TensorboardTimeSeries value.

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
get	select	projectsId, locationsId, tensorboardsId, experimentsId, runsId, timeSeriesId		Gets a TensorboardTimeSeries.
list	select	projectsId, locationsId, tensorboardsId, experimentsId, runsId	filter, pageSize, pageToken, orderBy, readMask	Lists TensorboardTimeSeries in a Location.
create	insert	projectsId, locationsId, tensorboardsId, experimentsId, runsId	tensorboardTimeSeriesId	Creates a TensorboardTimeSeries.
patch	update	projectsId, locationsId, tensorboardsId, experimentsId, runsId, timeSeriesId	updateMask	Updates a TensorboardTimeSeries.
delete	delete	projectsId, locationsId, tensorboardsId, experimentsId, runsId, timeSeriesId		Deletes a TensorboardTimeSeries.
read	exec	projectsId, locationsId, tensorboardsId, experimentsId, runsId, timeSeriesId	maxDataPoints, filter	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	projectsId, locationsId, tensorboardsId, experimentsId, runsId, timeSeriesId	blobIds	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.
export_tensorboard_time_series	exec	projectsId, locationsId, tensorboardsId, experimentsId, runsId, timeSeriesId		Exports a TensorboardTimeSeries' data. Data is returned in paginated responses.

Parameters

Parameters can be passed in the WHERE clause of a query. Check the Methods section to see which parameters are required or optional for each operation.

Name	Datatype	Description
experimentsId	string
locationsId	string
projectsId	string
runsId	string
tensorboardsId	string
timeSeriesId	string
blobIds	string
filter	string
maxDataPoints	integer (int32)
orderBy	string
pageSize	integer (int32)
pageToken	string
readMask	string (google-fieldmask)
tensorboardTimeSeriesId	string
updateMask	string (google-fieldmask)

SELECT examples

get

Gets a TensorboardTimeSeries.

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

list

Lists TensorboardTimeSeries in a Location.

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

INSERT examples

create

Creates a TensorboardTimeSeries.

INSERT INTO google.aiplatform.time_series (
data__displayName,
data__description,
data__valueType,
data__etag,
data__pluginName,
data__pluginData,
projectsId,
locationsId,
tensorboardsId,
experimentsId,
runsId,
tensorboardTimeSeriesId
)
SELECT 
'{{ displayName }}',
'{{ description }}',
'{{ valueType }}',
'{{ etag }}',
'{{ pluginName }}',
'{{ pluginData }}',
'{{ projectsId }}',
'{{ locationsId }}',
'{{ tensorboardsId }}',
'{{ experimentsId }}',
'{{ runsId }}',
'{{ tensorboardTimeSeriesId }}'
RETURNING
name,
createTime,
description,
displayName,
etag,
metadata,
pluginData,
pluginName,
updateTime,
valueType
;

Manifest

# Description fields are for documentation purposes
- name: time_series
  props:
    - name: projectsId
      value: string
      description: Required parameter for the time_series resource.
    - name: locationsId
      value: string
      description: Required parameter for the time_series resource.
    - name: tensorboardsId
      value: string
      description: Required parameter for the time_series resource.
    - name: experimentsId
      value: string
      description: Required parameter for the time_series resource.
    - name: runsId
      value: string
      description: Required parameter for the time_series resource.
    - name: displayName
      value: string
      description: >
        Required. User provided name of this TensorboardTimeSeries. This value should be unique among all TensorboardTimeSeries resources belonging to the same TensorboardRun resource (parent resource).
        
    - name: description
      value: string
      description: >
        Description of this TensorboardTimeSeries.
        
    - name: valueType
      value: string
      description: >
        Required. Immutable. Type of TensorboardTimeSeries value.
        
      valid_values: ['VALUE_TYPE_UNSPECIFIED', 'SCALAR', 'TENSOR', 'BLOB_SEQUENCE']
    - name: etag
      value: string
      description: >
        Used to perform a consistent read-modify-write updates. If not set, a blind "overwrite" update happens.
        
    - name: pluginName
      value: string
      description: >
        Immutable. Name of the plugin this time series pertain to. Such as Scalar, Tensor, Blob
        
    - name: pluginData
      value: string
      description: >
        Data of the current plugin, with the size limited to 65KB.
        
    - name: tensorboardTimeSeriesId
      value: string

UPDATE examples

patch

Updates a TensorboardTimeSeries.

UPDATE google.aiplatform.time_series
SET 
data__displayName = '{{ displayName }}',
data__description = '{{ description }}',
data__valueType = '{{ valueType }}',
data__etag = '{{ etag }}',
data__pluginName = '{{ pluginName }}',
data__pluginData = '{{ pluginData }}'
WHERE 
projectsId = '{{ projectsId }}' --required
AND locationsId = '{{ locationsId }}' --required
AND tensorboardsId = '{{ tensorboardsId }}' --required
AND experimentsId = '{{ experimentsId }}' --required
AND runsId = '{{ runsId }}' --required
AND timeSeriesId = '{{ timeSeriesId }}' --required
AND updateMask = '{{ updateMask}}'
RETURNING
name,
createTime,
description,
displayName,
etag,
metadata,
pluginData,
pluginName,
updateTime,
valueType;

DELETE examples

delete

Deletes a TensorboardTimeSeries.

DELETE FROM google.aiplatform.time_series
WHERE projectsId = '{{ projectsId }}' --required
AND locationsId = '{{ locationsId }}' --required
AND tensorboardsId = '{{ tensorboardsId }}' --required
AND experimentsId = '{{ experimentsId }}' --required
AND runsId = '{{ runsId }}' --required
AND timeSeriesId = '{{ timeSeriesId }}' --required;

Lifecycle Methods

read

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.

EXEC google.aiplatform.time_series.read 
@projectsId='{{ projectsId }}' --required, 
@locationsId='{{ locationsId }}' --required, 
@tensorboardsId='{{ tensorboardsId }}' --required, 
@experimentsId='{{ experimentsId }}' --required, 
@runsId='{{ runsId }}' --required, 
@timeSeriesId='{{ timeSeriesId }}' --required, 
@maxDataPoints='{{ maxDataPoints }}', 
@filter='{{ filter }}';

read_blob_data

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.

EXEC google.aiplatform.time_series.read_blob_data 
@projectsId='{{ projectsId }}' --required, 
@locationsId='{{ locationsId }}' --required, 
@tensorboardsId='{{ tensorboardsId }}' --required, 
@experimentsId='{{ experimentsId }}' --required, 
@runsId='{{ runsId }}' --required, 
@timeSeriesId='{{ timeSeriesId }}' --required, 
@blobIds='{{ blobIds }}';

export_tensorboard_time_series

Exports a TensorboardTimeSeries' data. Data is returned in paginated responses.

EXEC google.aiplatform.time_series.export_tensorboard_time_series 
@projectsId='{{ projectsId }}' --required, 
@locationsId='{{ locationsId }}' --required, 
@tensorboardsId='{{ tensorboardsId }}' --required, 
@experimentsId='{{ experimentsId }}' --required, 
@runsId='{{ runsId }}' --required, 
@timeSeriesId='{{ timeSeriesId }}' --required 
@@json=
'{
"filter": "{{ filter }}", 
"pageSize": {{ pageSize }}, 
"pageToken": "{{ pageToken }}", 
"orderBy": "{{ orderBy }}"
}';