Method: projects.locations.tensorboards.experiments.write

Write time series data points of multiple TensorboardTimeSeries in multiple TensorboardRun's. If any data fail to be ingested, an error is returned.

HTTP request

POST https://{service-endpoint}/v1beta1/{tensorboardExperiment}:write

Where {service-endpoint} is one of the supported service endpoints.

Path parameters

Parameters
tensorboardExperiment

string

Required. The resource name of the TensorboardExperiment to write data to. Format: projects/{project}/locations/{location}/tensorboards/{tensorboard}/experiments/{experiment}

Request body

The request body contains data with the following structure:

JSON representation 
{
  "writeRunDataRequests": [
    {
      object (WriteTensorboardRunDataRequest)
    }
  ]
}
Fields
writeRunDataRequests[]

object (WriteTensorboardRunDataRequest)

Required. Requests containing per-run TensorboardTimeSeries data to write.

Response body

If successful, the response body is empty.

Authorization scopes

Requires the following OAuth scope:

  • https://www.googleapis.com/auth/cloud-platform

For more information, see the Authentication Overview.

IAM Permissions

Requires the following IAM permission on the tensorboardExperiment resource:

  • aiplatform.tensorboardExperiments.write

For more information, see the IAM documentation.

WriteTensorboardRunDataRequest

Request message for TensorboardService.WriteTensorboardRunData.

JSON representation 
{
  "tensorboardRun": string,
  "timeSeriesData": [
    {
      object (TimeSeriesData)
    }
  ]
}
Fields
tensorboardRun

string

Required. The resource name of the TensorboardRun to write data to. Format: projects/{project}/locations/{location}/tensorboards/{tensorboard}/experiments/{experiment}/runs/{run}
timeSeriesData[]

object (TimeSeriesData)

Required. The TensorboardTimeSeries data to write. Values with in a time series are indexed by their step value. Repeated writes to the same step will overwrite the existing value for that step. The upper limit of data points per write request is 5000.