# Class Tensorboard (1.158.0)

1.158.0 (latest) 1.157.0 1.156.0 1.155.0 1.154.0 1.153.1 1.152.0 1.151.0 1.150.0 1.149.0 1.148.1 1.147.0 1.146.0 1.145.0 1.144.0 1.143.0 1.142.0 1.141.0 1.140.0 1.139.0 1.138.0 1.137.0 1.136.0 1.135.0 1.134.0 1.133.0 1.132.0 1.131.0 1.130.0 1.129.0 1.122.0 1.121.0 1.120.0 1.119.0 1.118.0 1.117.0 1.116.0 1.115.0 1.114.0 1.113.0 1.112.0 1.111.0 1.110.0 1.109.0 1.108.0 1.107.0 1.106.0 1.105.0 1.104.0 1.103.0 1.102.0 1.101.0 1.100.0 1.99.0 1.98.0 1.97.0 1.96.0 1.95.1 1.94.0 1.93.1 1.92.0 1.91.0 1.90.0 1.89.0 1.88.0 1.87.0 1.86.0 1.85.0 1.84.0 1.83.0 1.82.0 1.81.0 1.80.0 1.79.0 1.78.0 1.77.0 1.76.0 1.75.0 1.74.0 1.73.0 1.72.0 1.71.1 1.70.0 1.69.0 1.68.0 1.67.1 1.66.0 1.65.0 1.63.0 1.62.0 1.60.0 1.59.0 1.58.0 1.57.0 1.56.0 1.55.0 1.54.1 1.53.0 1.52.0 1.51.0 1.50.0 1.49.0 1.48.0 1.47.0 1.46.0 1.45.0 1.44.0 1.43.0 1.39.0 1.38.1 1.37.0 1.36.4 1.35.0 1.34.0 1.33.1 1.32.0 1.31.1 1.30.1 1.29.0 1.28.1 1.27.1 1.26.1 1.25.0 1.24.1 1.23.0 1.22.1 1.21.0 1.20.0 1.19.1 1.18.3 1.17.1 1.16.1 1.15.1 1.14.0 1.13.1 1.12.1 1.11.0 1.10.0 1.9.0 1.8.1 1.7.1 1.6.2 1.5.0 1.4.3 1.3.0 1.2.0 1.1.1 1.0.1 0.9.0 0.8.0 0.7.1 0.6.0 0.5.1 0.4.0 0.3.1

    Tensorboard(
        tensorboard_name: str,
        project: typing.Optional[str] = None,
        location: typing.Optional[str] = None,
        credentials: typing.Optional[google.auth.credentials.Credentials] = None,
    )

Managed tensorboard resource for Vertex AI.

## Properties

### create_time

Time this resource was created.

### display_name

Display name of this resource.

### encryption_spec

Customer-managed encryption key options for this Vertex AI resource.

If this is set, then all resources created by this Vertex AI resource will
be encrypted with the provided encryption key.

### gca_resource

The underlying resource proto representation.

### labels

User-defined labels containing metadata about this resource.

Read more about labels at <https://goo.gl/xmQnxf>

### name

Name of this resource.

### resource_name

Full qualified resource name.

### update_time

Time this resource was last updated.

## Methods

### Tensorboard

    Tensorboard(
        tensorboard_name: str,
        project: typing.Optional[str] = None,
        location: typing.Optional[str] = None,
        credentials: typing.Optional[google.auth.credentials.Credentials] = None,
    )

Retrieves an existing managed tensorboard given a tensorboard name or ID.

| **Parameters** ||
|---|---|
| **Name** | **Description** |
| `tensorboard_name` | `str` Required. A fully-qualified tensorboard resource name or tensorboard ID. Example: "projects/123/locations/us-central1/tensorboards/456" or "456" when project and location are initialized or passed. |
| `project` | `str` Optional. Project to retrieve tensorboard from. If not set, project set in aiplatform.init will be used. |
| `location` | `str` Optional. Location to retrieve tensorboard from. If not set, location set in aiplatform.init will be used. |
| `credentials` | `auth_credentials.Credentials` Optional. Custom credentials to use to retrieve this Tensorboard. Overrides credentials set in aiplatform.init. |

### create

    create(
        display_name: typing.Optional[str] = None,
        description: typing.Optional[str] = None,
        labels: typing.Optional[typing.Dict[str, str]] = None,
        project: typing.Optional[str] = None,
        location: typing.Optional[str] = None,
        credentials: typing.Optional[google.auth.credentials.Credentials] = None,
        request_metadata: typing.Optional[typing.Sequence[typing.Tuple[str, str]]] = (),
        encryption_spec_key_name: typing.Optional[str] = None,
        create_request_timeout: typing.Optional[float] = None,
        is_default: bool = False,
    ) -> google.cloud.aiplatform.tensorboard.tensorboard_resource.Tensorboard

Creates a new tensorboard.

Example Usage:

    tb = aiplatform.Tensorboard.create(
        display_name='my display name',
        description='my description',
        labels={
            'key1': 'value1',
            'key2': 'value2'
        }
    )

| **Parameters** ||
|---|---|
| **Name** | **Description** |
| `display_name` | `str` Optional. The user-defined name of the Tensorboard. The name can be up to 128 characters long and can be consist of any UTF-8 characters. |
| `description` | `str` Optional. Description of this Tensorboard. |
| `labels` | `Dict[str, str]` Optional. 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. |
| `project` | `str` Optional. Project to upload this model to. Overrides project set in aiplatform.init. |
| `location` | `str` Optional. Location to upload this model to. Overrides location set in aiplatform.init. |
| `credentials` | `auth_credentials.Credentials` Optional. Custom credentials to use to upload this model. Overrides credentials set in aiplatform.init. |
| `request_metadata` | `Sequence[Tuple[str, str]]` Optional. Strings which should be sent along with the request as metadata. |
| `encryption_spec_key_name` | `str` Optional. Cloud KMS resource identifier of the customer managed encryption key used to protect the tensorboard. Has the form: `projects/my-project/locations/my-region/keyRings/my-kr/cryptoKeys/my-key`. The key needs to be in the same region as where the compute resource is created. If set, this Tensorboard and all sub-resources of this Tensorboard will be secured by this key. Overrides encryption_spec_key_name set in aiplatform.init. |
| `create_request_timeout` | `float` Optional. The timeout for the create request in seconds. |
| `is_default` | `bool` If the TensorBoard instance is default or not. The default TensorBoard instance will be used by Experiment/ExperimentRun when needed if no TensorBoard instance is explicitly specified. |

| **Returns** ||
|---|---|
| **Type** | **Description** |
| `tensorboard (Tensorboard)` | Instantiated representation of the managed tensorboard resource. |

### delete

    delete(sync: bool = True) -> None

Deletes this Vertex AI resource. WARNING: This deletion is
permanent.

### list

    list(
        filter: typing.Optional[str] = None,
        order_by: typing.Optional[str] = None,
        project: typing.Optional[str] = None,
        location: typing.Optional[str] = None,
        credentials: typing.Optional[google.auth.credentials.Credentials] = None,
        parent: typing.Optional[str] = None,
    ) -> typing.List[google.cloud.aiplatform.base.VertexAiResourceNoun]

List all instances of this Vertex AI Resource.

Example Usage:

aiplatform.BatchPredictionJobs.list(
filter='state="JOB_STATE_SUCCEEDED" AND display_name="my_job"',
)

aiplatform.Model.list(order_by="create_time desc, display_name")

| **Parameters** ||
|---|---|
| **Name** | **Description** |
| `filter` | `str` Optional. An expression for filtering the results of the request. For field names both snake_case and camelCase are supported. |
| `order_by` | `str` Optional. A comma-separated list of fields to order by, sorted in ascending order. Use "desc" after a field name for descending. Supported fields: `display_name`, `create_time`, `update_time` |
| `project` | `str` Optional. Project to retrieve list from. If not set, project set in aiplatform.init will be used. |
| `location` | `str` Optional. Location to retrieve list from. If not set, location set in aiplatform.init will be used. |
| `credentials` | `auth_credentials.Credentials` Optional. Custom credentials to use to retrieve list. Overrides credentials set in aiplatform.init. |
| `parent` | `str` Optional. The parent resource name if any to retrieve list from. |

### to_dict

    to_dict() -> typing.Dict[str, typing.Any]

Returns the resource proto as a dictionary.

### update

    update(
        display_name: typing.Optional[str] = None,
        description: typing.Optional[str] = None,
        labels: typing.Optional[typing.Dict[str, str]] = None,
        request_metadata: typing.Optional[typing.Sequence[typing.Tuple[str, str]]] = (),
        encryption_spec_key_name: typing.Optional[str] = None,
        is_default: typing.Optional[bool] = None,
    ) -> google.cloud.aiplatform.tensorboard.tensorboard_resource.Tensorboard

Updates an existing tensorboard.

Example Usage:

    tb = aiplatform.Tensorboard(tensorboard_name='123456')
    tb.update(
        display_name='update my display name',
        description='update my description',
    )

| **Parameters** ||
|---|---|
| **Name** | **Description** |
| `display_name` | `str` Optional. User-defined name of the Tensorboard. The name can be up to 128 characters long and can be consist of any UTF-8 characters. |
| `description` | `str` Optional. Description of this Tensorboard. |
| `labels` | `Dict[str, str]` Optional. 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. |
| `request_metadata` | `Sequence[Tuple[str, str]]` Optional. Strings which should be sent along with the request as metadata. |
| `encryption_spec_key_name` | `str` Optional. Cloud KMS resource identifier of the customer managed encryption key used to protect the tensorboard. Has the form: `projects/my-project/locations/my-region/keyRings/my-kr/cryptoKeys/my-key`. The key needs to be in the same region as where the compute resource is created. If set, this Tensorboard and all sub-resources of this Tensorboard will be secured by this key. Overrides encryption_spec_key_name set in aiplatform.init. |
| `is_default` | `bool` Optional. If the TensorBoard instance is default or not. The default TensorBoard instance will be used by Experiment/ExperimentRun when needed if no TensorBoard instance is explicitly specified. |

| **Returns** ||
|---|---|
| **Type** | **Description** |
| `Tensorboard` | The managed tensorboard resource. |

### wait

    wait()

Helper method that blocks until all futures are complete.