tensorboards

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

Overview

Name	tensorboards
Type	Resource
Id	google.aiplatform.tensorboards

Fields

Name	Datatype	Description
name	string	Output only. Name of the Tensorboard. Format: projects/{project}/locations/{location}/tensorboards/{tensorboard}
description	string	Description of this 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	Output only. Timestamp when this Tensorboard was created.
displayName	string	Required. User provided name of this Tensorboard.
encryptionSpec	object	Represents a customer-managed encryption key spec that can be applied to a top-level resource.
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	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	Output only. Timestamp when this Tensorboard was last updated.

Methods

Name	Accessible by	Required Params	Description
get	SELECT	locationsId, projectsId, tensorboardsId	Gets a Tensorboard.
list	SELECT	locationsId, projectsId	Lists Tensorboards in a Location.
create	INSERT	locationsId, projectsId	Creates a Tensorboard.
delete	DELETE	locationsId, projectsId, tensorboardsId	Deletes a Tensorboard.
patch	UPDATE	locationsId, projectsId, tensorboardsId	Updates a Tensorboard.
batch_read	EXEC	locationsId, projectsId, tensorboardsId	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.
read_size	EXEC	locationsId, projectsId, tensorboardsId	Returns the storage size for a given TensorBoard instance.
read_usage	EXEC	locationsId, projectsId, tensorboardsId	Returns a list of monthly active users for a given TensorBoard instance.

SELECT examples

Lists Tensorboards in a Location.

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

INSERT example

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

All Properties

/*+ create */
INSERT INTO google.aiplatform.tensorboards (
locationsId,
projectsId,
etag,
displayName,
labels,
description,
isDefault,
encryptionSpec
)
SELECT 
'{{ locationsId }}',
'{{ projectsId }}',
'{{ etag }}',
'{{ displayName }}',
'{{ labels }}',
'{{ description }}',
{{ isDefault }},
'{{ encryptionSpec }}'
;

Manifest

- name: your_resource_model_name
  props:
    - name: blobStoragePathPrefix
      value: string
    - name: runCount
      value: integer
    - name: satisfiesPzi
      value: boolean
    - name: name
      value: string
    - name: etag
      value: string
    - name: updateTime
      value: string
    - name: satisfiesPzs
      value: boolean
    - name: displayName
      value: string
    - name: labels
      value: object
    - name: description
      value: string
    - name: createTime
      value: string
    - name: isDefault
      value: boolean
    - name: encryptionSpec
      value:
        - name: kmsKeyName
          value: string

UPDATE example

Updates a tensorboards resource.

/*+ update */
UPDATE google.aiplatform.tensorboards
SET 
etag = '{{ etag }}',
displayName = '{{ displayName }}',
labels = '{{ labels }}',
description = '{{ description }}',
isDefault = true|false,
encryptionSpec = '{{ encryptionSpec }}'
WHERE 
locationsId = '{{ locationsId }}'
AND projectsId = '{{ projectsId }}'
AND tensorboardsId = '{{ tensorboardsId }}';

DELETE example

Deletes the specified tensorboards resource.

/*+ delete */
DELETE FROM google.aiplatform.tensorboards
WHERE locationsId = '{{ locationsId }}'
AND projectsId = '{{ projectsId }}'
AND tensorboardsId = '{{ tensorboardsId }}';