Method: projects.locations.tensorboards.experiments.runs.batchCreate

Batch create TensorboardRuns.

HTTP request

POST https://{service-endpoint}/v1beta1/{parent}/runs:batchCreate

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

Path parameters

Parameters
parent

string

Required. The resource name of the TensorboardExperiment to create the TensorboardRuns in. Format: projects/{project}/locations/{location}/tensorboards/{tensorboard}/experiments/{experiment} The parent field in the CreateTensorboardRunRequest messages must match this field.

Request body

The request body contains data with the following structure:

JSON representation
{
  "requests": [
    {
      object (CreateTensorboardRunRequest)
    }
  ]
}
Fields
requests[]

object (CreateTensorboardRunRequest)

Required. The request message specifying the TensorboardRuns to create. A maximum of 1000 TensorboardRuns can be created in a batch.

Response body

Response message for TensorboardService.BatchCreateTensorboardRuns.

If successful, the response body contains data with the following structure:

JSON representation
{
  "tensorboardRuns": [
    {
      object (TensorboardRun)
    }
  ]
}
Fields
tensorboardRuns[]

object (TensorboardRun)

The created TensorboardRuns.

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 parent resource:

  • aiplatform.tensorboardRuns.batchCreate

For more information, see the IAM documentation.

CreateTensorboardRunRequest

Request message for TensorboardService.CreateTensorboardRun.

JSON representation
{
  "parent": string,
  "tensorboardRun": {
    object (TensorboardRun)
  },
  "tensorboardRunId": string
}
Fields
parent

string

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

tensorboardRun

object (TensorboardRun)

Required. The TensorboardRun to create.

tensorboardRunId

string

Required. The ID to use for the Tensorboard run, which becomes the final component of the Tensorboard run's resource name.

This value should be 1-128 characters, and valid characters are /[a-z][0-9]-/.