Stay organized with collections
Save and categorize content based on your preferences.
Updates a Tensorboard.
This method waits—the workflow execution is paused—until the operation is
complete, fails, or times out. The default timeout value is 1800 seconds (30
minutes) and can be changed to a maximum value of 31536000 seconds (one year)
for long-running operations using the connector_params field. See the
Connectors reference.
The connector uses polling to monitor the long-running operation, which might
generate additional billable steps. For more information about retries and
long-running operations, refer to Understand connectors.
The polling policy for the long-running operation can be configured. To set the
connector-specific parameters (connector_params), refer to
Invoke a connector call.
Arguments
Parameters
name
string
Required. Output only. Name of the Tensorboard. Format: projects/{project}/locations/{location}/tensorboards/{tensorboard}
Required. Field mask is used to specify the fields to be overwritten in the Tensorboard resource by the update. The fields specified in the update_mask are relative to the resource, not the full request. A field is overwritten if it's in the mask. If the user does not provide a mask then all fields are overwritten if new values are specified.
region
string
Required. Region of the HTTP endpoint. For example, if region is set to us-central1, the endpoint https://us-central1-integrations.googleapis.com will be used. See service endpoints.
[[["Easy to understand","easyToUnderstand","thumb-up"],["Solved my problem","solvedMyProblem","thumb-up"],["Other","otherUp","thumb-up"]],[["Hard to understand","hardToUnderstand","thumb-down"],["Incorrect information or sample code","incorrectInformationOrSampleCode","thumb-down"],["Missing the information/samples I need","missingTheInformationSamplesINeed","thumb-down"],["Other","otherDown","thumb-down"]],["Last updated 2025-08-28 UTC."],[],[],null,["# Method: googleapis.aiplatform.v1.projects.locations.tensorboards.patch\n\n| **Preview**\n|\n|\n| This feature is subject to the \"Pre-GA Offerings Terms\" in the General Service Terms section\n| of the [Service Specific Terms](/terms/service-terms#1).\n|\n| Pre-GA features are available \"as is\" and might have limited support.\n|\n| For more information, see the\n| [launch stage descriptions](/products#product-launch-stages).\n\nUpdates a Tensorboard.\n\nThis method waits---the workflow execution is paused---until the operation is\ncomplete, fails, or times out. The default timeout value is `1800` seconds (30\nminutes) and can be changed to a maximum value of `31536000` seconds (one year)\nfor long-running operations using the `connector_params` field. See the\n[Connectors reference](/workflows/docs/reference/googleapis).\n\nThe connector uses polling to monitor the long-running operation, which might\ngenerate additional billable steps. For more information about retries and\nlong-running operations, refer to [Understand connectors](/workflows/docs/connectors).\n\nThe polling policy for the long-running operation can be configured. To set the\nconnector-specific parameters (`connector_params`), refer to\n[Invoke a connector call](/workflows/docs/reference/googleapis#invoke_a_connector_call).\n\nArguments\n---------\n\nRaised exceptions\n-----------------\n\nResponse\n--------\n\nIf successful, the response contains an instance of [`GoogleLongrunningOperation`](https://cloud.google.com/workflows/docs/reference/googleapis/aiplatform/v1/Overview#GoogleLongrunningOperation).\n\nSubworkflow snippet\n-------------------\n\nSome fields might be optional or required.\nTo identify required fields, refer to the [API documentation](https://cloud.google.com/vertex-ai/docs/reference/rest/v1/projects.locations.tensorboards/patch). \n\n### YAML\n\n```yaml\n- patch:\n call: googleapis.aiplatform.v1.projects.locations.tensorboards.patch\n args:\n name: ...\n updateMask: ...\n region: ...\n body:\n description: ...\n displayName: ...\n encryptionSpec:\n kmsKeyName: ...\n etag: ...\n isDefault: ...\n labels: ...\n result: patchResult\n```\n\n### JSON\n\n```json\n[\n {\n \"patch\": {\n \"call\": \"googleapis.aiplatform.v1.projects.locations.tensorboards.patch\",\n \"args\": {\n \"name\": \"...\",\n \"updateMask\": \"...\",\n \"region\": \"...\",\n \"body\": {\n \"description\": \"...\",\n \"displayName\": \"...\",\n \"encryptionSpec\": {\n \"kmsKeyName\": \"...\"\n },\n \"etag\": \"...\",\n \"isDefault\": \"...\",\n \"labels\": \"...\"\n }\n },\n \"result\": \"patchResult\"\n }\n }\n]\n```"]]