Method: googleapis.aiplatform.v1.projects.locations.tensorboards.experiments.runs.timeSeries.read

Reads a TensorboardTimeSeries' data. By default, if the number of data points stored is less than 1000, all data is returned. Otherwise, 1000 data points is randomly selected from this time series and returned. This value can be changed by changing max_data_points, which can't be greater than 10k.

Arguments

Parameters
`tensorboardTimeSeries`	`string` Required. The resource name of the TensorboardTimeSeries to read data from. Format: `projects/{project}/locations/{location}/tensorboards/{tensorboard}/experiments/{experiment}/runs/{run}/timeSeries/{time_series}`
`filter`	`string` Reads the TensorboardTimeSeries' data that match the filter expression.
`maxDataPoints`	`integer (int32 format)` The maximum number of TensorboardTimeSeries' data to return. This value should be a positive integer. This value can be set to -1 to return all data.
`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.

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 GoogleCloudAiplatformV1ReadTensorboardTimeSeriesDataResponse.

Subworkflow snippet

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

YAML

- read:
    call: googleapis.aiplatform.v1.projects.locations.tensorboards.experiments.runs.timeSeries.read
    args:
        tensorboardTimeSeries: ...
        filter: ...
        maxDataPoints: ...
        region: ...
    result: readResult

JSON

[
  {
    "read": {
      "call": "googleapis.aiplatform.v1.projects.locations.tensorboards.experiments.runs.timeSeries.read",
      "args": {
        "tensorboardTimeSeries": "...",
        "filter": "...",
        "maxDataPoints": "...",
        "region": "..."
      },
      "result": "readResult"
    }
  }
]