tensorboards

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

Overview

Name	tensorboards
Type	Resource
Id	google.aiplatform.tensorboards

Fields

The following fields are returned by SELECT queries:

get

Successful response

Name	Datatype	Description
name	string	Output only. Name of the Tensorboard. Format: projects/{project}/locations/{location}/tensorboards/{tensorboard}
blobStoragePathPrefix	string	Output only. Consumer project Cloud Storage path prefix used to store blob data, which can either be a bucket or directory. Does not end with a '/'.
createTime	string (google-datetime)	Output only. Timestamp when this Tensorboard was created.
description	string	Description of this Tensorboard.
displayName	string	Required. User provided name of this Tensorboard.
encryptionSpec	object	Customer-managed encryption key spec for a Tensorboard. If set, this Tensorboard and all sub-resources of this Tensorboard will be secured by this key. (id: GoogleCloudAiplatformV1EncryptionSpec)
etag	string	Used to perform a consistent read-modify-write updates. If not set, a blind "overwrite" update happens.
isDefault	boolean	Used to indicate if the TensorBoard instance is the default one. Each project & region can have at most one default TensorBoard instance. Creation of a default TensorBoard instance and updating an existing TensorBoard instance to be default will mark all other TensorBoard instances (if any) as non default.
labels	object	The labels with user-defined metadata to organize your Tensorboards. Label keys and values can be no longer than 64 characters (Unicode codepoints), can only contain lowercase letters, numeric characters, underscores and dashes. International characters are allowed. No more than 64 user labels can be associated with one Tensorboard (System labels are excluded). See https://goo.gl/xmQnxf for more information and examples of labels. System reserved label keys are prefixed with "aiplatform.googleapis.com/" and are immutable.
runCount	integer (int32)	Output only. The number of Runs stored in this Tensorboard.
satisfiesPzi	boolean	Output only. Reserved for future use.
satisfiesPzs	boolean	Output only. Reserved for future use.
updateTime	string (google-datetime)	Output only. Timestamp when this Tensorboard was last updated.

list

Successful response

Name	Datatype	Description
name	string	Output only. Name of the Tensorboard. Format: projects/{project}/locations/{location}/tensorboards/{tensorboard}
blobStoragePathPrefix	string	Output only. Consumer project Cloud Storage path prefix used to store blob data, which can either be a bucket or directory. Does not end with a '/'.
createTime	string (google-datetime)	Output only. Timestamp when this Tensorboard was created.
description	string	Description of this Tensorboard.
displayName	string	Required. User provided name of this Tensorboard.
encryptionSpec	object	Customer-managed encryption key spec for a Tensorboard. If set, this Tensorboard and all sub-resources of this Tensorboard will be secured by this key. (id: GoogleCloudAiplatformV1EncryptionSpec)
etag	string	Used to perform a consistent read-modify-write updates. If not set, a blind "overwrite" update happens.
isDefault	boolean	Used to indicate if the TensorBoard instance is the default one. Each project & region can have at most one default TensorBoard instance. Creation of a default TensorBoard instance and updating an existing TensorBoard instance to be default will mark all other TensorBoard instances (if any) as non default.
labels	object	The labels with user-defined metadata to organize your Tensorboards. Label keys and values can be no longer than 64 characters (Unicode codepoints), can only contain lowercase letters, numeric characters, underscores and dashes. International characters are allowed. No more than 64 user labels can be associated with one Tensorboard (System labels are excluded). See https://goo.gl/xmQnxf for more information and examples of labels. System reserved label keys are prefixed with "aiplatform.googleapis.com/" and are immutable.
runCount	integer (int32)	Output only. The number of Runs stored in this Tensorboard.
satisfiesPzi	boolean	Output only. Reserved for future use.
satisfiesPzs	boolean	Output only. Reserved for future use.
updateTime	string (google-datetime)	Output only. Timestamp when this Tensorboard was last updated.

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
get	select	projectsId, locationsId, tensorboardsId		Gets a Tensorboard.
list	select	projectsId, locationsId	filter, pageSize, pageToken, orderBy, readMask	Lists Tensorboards in a Location.
create	insert	projectsId, locationsId		Creates a Tensorboard.
patch	update	projectsId, locationsId, tensorboardsId	updateMask	Updates a Tensorboard.
delete	delete	projectsId, locationsId, tensorboardsId		Deletes a Tensorboard.
read_usage	exec	projectsId, locationsId, tensorboardsId		Returns a list of monthly active users for a given TensorBoard instance.
read_size	exec	projectsId, locationsId, tensorboardsId		Returns the storage size for a given TensorBoard instance.
batch_read	exec	projectsId, locationsId, tensorboardsId	timeSeries	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.

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
locationsId	string
projectsId	string
tensorboardsId	string
filter	string
orderBy	string
pageSize	integer (int32)
pageToken	string
readMask	string (google-fieldmask)
timeSeries	string
updateMask	string (google-fieldmask)

SELECT examples

get

Gets a Tensorboard.

SELECT
name,
blobStoragePathPrefix,
createTime,
description,
displayName,
encryptionSpec,
etag,
isDefault,
labels,
runCount,
satisfiesPzi,
satisfiesPzs,
updateTime
FROM google.aiplatform.tensorboards
WHERE projectsId = '{{ projectsId }}' -- required
AND locationsId = '{{ locationsId }}' -- required
AND tensorboardsId = '{{ tensorboardsId }}' -- required;

list

Lists Tensorboards in a Location.

SELECT
name,
blobStoragePathPrefix,
createTime,
description,
displayName,
encryptionSpec,
etag,
isDefault,
labels,
runCount,
satisfiesPzi,
satisfiesPzs,
updateTime
FROM google.aiplatform.tensorboards
WHERE projectsId = '{{ projectsId }}' -- required
AND locationsId = '{{ locationsId }}' -- required
AND filter = '{{ filter }}'
AND pageSize = '{{ pageSize }}'
AND pageToken = '{{ pageToken }}'
AND orderBy = '{{ orderBy }}'
AND readMask = '{{ readMask }}';

INSERT examples

create

Creates a Tensorboard.

INSERT INTO google.aiplatform.tensorboards (
data__displayName,
data__description,
data__encryptionSpec,
data__labels,
data__etag,
data__isDefault,
projectsId,
locationsId
)
SELECT 
'{{ displayName }}',
'{{ description }}',
'{{ encryptionSpec }}',
'{{ labels }}',
'{{ etag }}',
{{ isDefault }},
'{{ projectsId }}',
'{{ locationsId }}'
RETURNING
name,
done,
error,
metadata,
response
;

Manifest

# Description fields are for documentation purposes
- name: tensorboards
  props:
    - name: projectsId
      value: string
      description: Required parameter for the tensorboards resource.
    - name: locationsId
      value: string
      description: Required parameter for the tensorboards resource.
    - name: displayName
      value: string
      description: >
        Required. User provided name of this Tensorboard.
        
    - name: description
      value: string
      description: >
        Description of this Tensorboard.
        
    - name: encryptionSpec
      value: object
      description: >
        Customer-managed encryption key spec for a Tensorboard. If set, this Tensorboard and all sub-resources of this Tensorboard will be secured by this key.
        
    - name: labels
      value: object
      description: >
        The labels with user-defined metadata to organize your Tensorboards. Label keys and values can be no longer than 64 characters (Unicode codepoints), can only contain lowercase letters, numeric characters, underscores and dashes. International characters are allowed. No more than 64 user labels can be associated with one Tensorboard (System labels are excluded). See https://goo.gl/xmQnxf for more information and examples of labels. System reserved label keys are prefixed with "aiplatform.googleapis.com/" and are immutable.
        
    - name: etag
      value: string
      description: >
        Used to perform a consistent read-modify-write updates. If not set, a blind "overwrite" update happens.
        
    - name: isDefault
      value: boolean
      description: >
        Used to indicate if the TensorBoard instance is the default one. Each project & region can have at most one default TensorBoard instance. Creation of a default TensorBoard instance and updating an existing TensorBoard instance to be default will mark all other TensorBoard instances (if any) as non default.
        

UPDATE examples

patch

Updates a Tensorboard.

UPDATE google.aiplatform.tensorboards
SET 
data__displayName = '{{ displayName }}',
data__description = '{{ description }}',
data__encryptionSpec = '{{ encryptionSpec }}',
data__labels = '{{ labels }}',
data__etag = '{{ etag }}',
data__isDefault = {{ isDefault }}
WHERE 
projectsId = '{{ projectsId }}' --required
AND locationsId = '{{ locationsId }}' --required
AND tensorboardsId = '{{ tensorboardsId }}' --required
AND updateMask = '{{ updateMask}}'
RETURNING
name,
done,
error,
metadata,
response;

DELETE examples

delete

Deletes a Tensorboard.

DELETE FROM google.aiplatform.tensorboards
WHERE projectsId = '{{ projectsId }}' --required
AND locationsId = '{{ locationsId }}' --required
AND tensorboardsId = '{{ tensorboardsId }}' --required;

Lifecycle Methods

read_usage

Returns a list of monthly active users for a given TensorBoard instance.

EXEC google.aiplatform.tensorboards.read_usage 
@projectsId='{{ projectsId }}' --required, 
@locationsId='{{ locationsId }}' --required, 
@tensorboardsId='{{ tensorboardsId }}' --required;

read_size

Returns the storage size for a given TensorBoard instance.

EXEC google.aiplatform.tensorboards.read_size 
@projectsId='{{ projectsId }}' --required, 
@locationsId='{{ locationsId }}' --required, 
@tensorboardsId='{{ tensorboardsId }}' --required;

batch_read

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.

EXEC google.aiplatform.tensorboards.batch_read 
@projectsId='{{ projectsId }}' --required, 
@locationsId='{{ locationsId }}' --required, 
@tensorboardsId='{{ tensorboardsId }}' --required, 
@timeSeries='{{ timeSeries }}';