Method: googleapis.aiplatform.v1beta1.projects.locations.hyperparameterTuningJobs.list

Preview

This feature is subject to the "Pre-GA Offerings Terms" in the General Service Terms section of the Service Specific Terms. Pre-GA features are available "as is" and might have limited support. For more information, see the launch stage descriptions.

Lists HyperparameterTuningJobs in a Location.

Arguments

Parameters
parent	string Required. The resource name of the Location to list the HyperparameterTuningJobs from. Format: projects/{project}/locations/{location}
filter	string The standard list filter. Supported fields: * display_name supports =, != comparisons, and : wildcard. * state supports =, != comparisons. * create_time supports =, !=,<, <=,>, >= comparisons. create_time must be in RFC 3339 format. * labels supports general map functions that is: labels.key=value - key:value equality labels.key:* - key existence Some examples of using the filter are: *state="JOB_STATE_SUCCEEDED" AND display_name:"my_job_"*state!="JOB_STATE_FAILED" OR display_name="my_job"*NOT display_name="my_job"*create_time>"2021-05-18T00:00:00Z"*labels.keyA=valueA*labels.keyB:`
pageSize	integer (int32 format) The standard list page size.
pageToken	string The standard list page token. Typically obtained via ListHyperparameterTuningJobsResponse.next_page_token of the previous JobService.ListHyperparameterTuningJobs call.
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 GoogleCloudAiplatformV1beta1ListHyperparameterTuningJobsResponse.

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.hyperparameterTuningJobs.list
    args:
        parent: ...
        filter: ...
        pageSize: ...
        pageToken: ...
        readMask: ...
        region: ...
    result: listResult

JSON

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