Lists TensorboardTimeSeries in a Location.
Arguments
Parameters | |
---|---|
parent |
Required. The resource name of the TensorboardRun to list TensorboardTimeSeries. Format: |
filter |
Lists the TensorboardTimeSeries that match the filter expression. |
orderBy |
Field to use to sort the list. |
pageSize |
The maximum number of TensorboardTimeSeries to return. The service may return fewer than this value. If unspecified, at most 50 TensorboardTimeSeries are returned. The maximum value is 1000; values above 1000 are coerced to 1000. |
pageToken |
A page token, received from a previous TensorboardService.ListTensorboardTimeSeries call. Provide this to retrieve the subsequent page. When paginating, all other parameters provided to TensorboardService.ListTensorboardTimeSeries must match the call that provided the page token. |
readMask |
Mask specifying which fields to read. |
region |
Required. Region of the HTTP endpoint. For example, if region is set to |
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 GoogleCloudAiplatformV1ListTensorboardTimeSeriesResponse
.
Subworkflow snippet
Some fields might be optional or required. To identify required fields, refer to the API documentation.
YAML
- list: call: googleapis.aiplatform.v1.projects.locations.tensorboards.experiments.runs.timeSeries.list args: parent: ... filter: ... orderBy: ... pageSize: ... pageToken: ... readMask: ... region: ... result: listResult
JSON
[ { "list": { "call": "googleapis.aiplatform.v1.projects.locations.tensorboards.experiments.runs.timeSeries.list", "args": { "parent": "...", "filter": "...", "orderBy": "...", "pageSize": "...", "pageToken": "...", "readMask": "...", "region": "..." }, "result": "listResult" } } ]