Method: googleapis.aiplatform.v1beta1.projects.locations.studies.trials.list

Lists the Trials associated with a Study.

Arguments

Parameters
parent

string

Required. The resource name of the Study to list the Trial from. Format: projects/{project}/locations/{location}/studies/{study}

pageSize

integer (int32 format)

Optional. The number of Trials to retrieve per "page" of results. If unspecified, the service will pick an appropriate default.

pageToken

string

Optional. A page token to request the next page of results. If unspecified, there are no subsequent pages.

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

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.studies.trials.list
    args:
        parent: ...
        pageSize: ...
        pageToken: ...
        region: ...
    result: listResult

JSON

[
  {
    "list": {
      "call": "googleapis.aiplatform.v1beta1.projects.locations.studies.trials.list",
      "args": {
        "parent": "...",
        "pageSize": "...",
        "pageToken": "...",
        "region": "..."
      },
      "result": "listResult"
    }
  }
]