checkTrialEarlyStoppingState method
- GoogleCloudAiplatformV1CheckTrialEarlyStoppingStateRequest request,
- String trialName, {
- String? $fields,
Checks whether a Trial should stop or not.
Returns a long-running operation. When the operation is successful, it will contain a CheckTrialEarlyStoppingStateResponse.
request
- The metadata request object.
Request parameters:
trialName
- Required. The Trial's name. Format:
projects/{project}/locations/{location}/studies/{study}/trials/{trial}
Value must have pattern
^projects/\[^/\]+/locations/\[^/\]+/studies/\[^/\]+/trials/\[^/\]+$
.
$fields
- Selector specifying which fields to include in a partial
response.
Completes with a GoogleLongrunningOperation.
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<GoogleLongrunningOperation> checkTrialEarlyStoppingState(
GoogleCloudAiplatformV1CheckTrialEarlyStoppingStateRequest request,
core.String trialName, {
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('$trialName') +
':checkTrialEarlyStoppingState';
final response_ = await _requester.request(
url_,
'POST',
body: body_,
queryParams: queryParams_,
);
return GoogleLongrunningOperation.fromJson(
response_ as core.Map<core.String, core.dynamic>);
}