listOptimalTrials method

Future<GoogleCloudAiplatformV1ListOptimalTrialsResponse> listOptimalTrials(
  1. GoogleCloudAiplatformV1ListOptimalTrialsRequest request,
  2. String parent, {
  3. String? $fields,
})

Lists the pareto-optimal Trials for multi-objective Study or the optimal Trials for single-objective Study.

The definition of pareto-optimal can be checked in wiki page. https://en.wikipedia.org/wiki/Pareto_efficiency

request - The metadata request object.

Request parameters:

parent - Required. The name of the Study that the optimal Trial belongs to. Value must have pattern ^projects/\[^/\]+/locations/\[^/\]+/studies/\[^/\]+$.

$fields - Selector specifying which fields to include in a partial response.

Completes with a GoogleCloudAiplatformV1ListOptimalTrialsResponse.

Completes with a commons.ApiRequestError if the API endpoint returned an error.

If the used http.Client completes with an error when making a REST call, this method will complete with the same error.

Implementation

async.Future<GoogleCloudAiplatformV1ListOptimalTrialsResponse>
    listOptimalTrials(
  GoogleCloudAiplatformV1ListOptimalTrialsRequest request,
  core.String parent, {
  core.String? $fields,
}) async {
  final body_ = convert.json.encode(request);
  final queryParams_ = <core.String, core.List<core.String>>{
    if ($fields != null) 'fields': [$fields],
  };

  final url_ =
      'v1/' + core.Uri.encodeFull('$parent') + '/trials:listOptimalTrials';

  final response_ = await _requester.request(
    url_,
    'POST',
    body: body_,
    queryParams: queryParams_,
  );
  return GoogleCloudAiplatformV1ListOptimalTrialsResponse.fromJson(
      response_ as core.Map<core.String, core.dynamic>);
}