Method: googleapis.aiplatform.v1beta1.projects.locations.tensorboards.experiments.runs.list

Lists TensorboardRuns in a Location.

Arguments

Parameters
parent

string

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

filter

string

Lists the TensorboardRuns that match the filter expression.

orderBy

string

Field to use to sort the list.

pageSize

integer (int32 format)

The maximum number of TensorboardRuns to return. The service may return fewer than this value. If unspecified, at most 50 TensorboardRuns are returned. The maximum value is 1000; values above 1000 are coerced to 1000.

pageToken

string

A page token, received from a previous TensorboardService.ListTensorboardRuns call. Provide this to retrieve the subsequent page. When paginating, all other parameters provided to TensorboardService.ListTensorboardRuns must match the call that provided the page token.

readMask

string (FieldMask format)

Mask specifying which fields to read.

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

Subworkflow snippet

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

YAML

- list:
    call: googleapis.aiplatform.v1beta1.projects.locations.tensorboards.experiments.runs.list
    args:
        parent: ...
        filter: ...
        orderBy: ...
        pageSize: ...
        pageToken: ...
        readMask: ...
        region: ...
    result: listResult

JSON

[
  {
    "list": {
      "call": "googleapis.aiplatform.v1beta1.projects.locations.tensorboards.experiments.runs.list",
      "args": {
        "parent": "...",
        "filter": "...",
        "orderBy": "...",
        "pageSize": "...",
        "pageToken": "...",
        "readMask": "...",
        "region": "..."
      },
      "result": "listResult"
    }
  }
]