Method: googleapis.aiplatform.v1.projects.locations.tensorboards.experiments.runs.patch

Updates a TensorboardRun.

Arguments

Parameters
`name`	`string` Required. Output only. Name of the TensorboardRun. Format: `projects/{project}/locations/{location}/tensorboards/{tensorboard}/experiments/{experiment}/runs/{run}`
`updateMask`	`string (FieldMask format)` Required. Field mask is used to specify the fields to be overwritten in the TensorboardRun 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.
`body`	`object (GoogleCloudAiplatformV1TensorboardRun)` Required.

Raised exceptions

Exceptions
`ConnectionError`	In case of a network problem (such as DNS failure or refused connection).
`HttpError`	If the response status is >= 400 (excluding 429 and 503).
`TimeoutError`	If a long-running operation takes longer to finish than the specified timeout limit.
`TypeError`	If an operation or function receives an argument of the wrong type.
`ValueError`	If an operation or function receives an argument of the right type but an inappropriate value. For example, a negative timeout.

Response

If successful, the response contains an instance of GoogleCloudAiplatformV1TensorboardRun.

Subworkflow snippet

Some fields might be optional or required. To identify required fields, refer to the API documentation.

YAML

- patch:
    call: googleapis.aiplatform.v1.projects.locations.tensorboards.experiments.runs.patch
    args:
        name: ...
        updateMask: ...
        region: ...
        body:
            description: ...
            displayName: ...
            etag: ...
            labels: ...
    result: patchResult

JSON

[
  {
    "patch": {
      "call": "googleapis.aiplatform.v1.projects.locations.tensorboards.experiments.runs.patch",
      "args": {
        "name": "...",
        "updateMask": "...",
        "region": "...",
        "body": {
          "description": "...",
          "displayName": "...",
          "etag": "...",
          "labels": "..."
        }
      },
      "result": "patchResult"
    }
  }
]