Lists HyperparameterTuningJobs in a Location.
Endpoint
gethttps://{endpoint}/v1/{parent}/hyperparameterTuningJobs
Where {service-endpoint}
is one of the supported service endpoints.
Path parameters
parent
string
Required. The resource name of the Location to list the HyperparameterTuningJobs from. Format: projects/{project}/locations/{location}
Query parameters
filter
string
The standard list filter.
Supported fields:
displayName
supports=
,!=
comparisons, and:
wildcard.state
supports=
,!=
comparisons.createTime
supports=
,!=
,<
,<=
,>
,>=
comparisons.createTime
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 displayName:"my_job_*"
state!="JOB_STATE_FAILED" OR displayName="my_job"
NOT displayName="my_job"
createTime>"2021-05-18T00:00:00Z"
labels.keyA=valueA
labels.keyB:*
pageSize
integer
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.
Mask specifying which fields to read.
This is a comma-separated list of fully qualified names of fields. Example: "user.displayName,photo"
.
Request body
The request body must be empty.
Response body
Response message for JobService.ListHyperparameterTuningJobs
If successful, the response body contains data with the following structure:
List of HyperparameterTuningJobs in the requested page. HyperparameterTuningJob.trials
of the jobs will be not be returned.
nextPageToken
string
A token to retrieve the next page of results. Pass to ListHyperparameterTuningJobsRequest.page_token
to obtain that page.
JSON representation |
---|
{
"hyperparameterTuningJobs": [
{
object ( |