isUpgradeable method

Future<IsInstanceUpgradeableResponse> isUpgradeable(
  1. String notebookInstance, {
  2. String? type,
  3. String? $fields,
})

Checks whether a notebook instance is upgradable.

Request parameters:

notebookInstance - Required. Format: projects/{project_id}/locations/{location}/instances/{instance_id} Value must have pattern ^projects/\[^/\]+/locations/\[^/\]+/instances/\[^/\]+$.

type - Optional. The optional UpgradeType. Setting this field will search for additional compute images to upgrade this instance. Possible string values are:

  • "UPGRADE_TYPE_UNSPECIFIED" : Upgrade type is not specified.
  • "UPGRADE_FRAMEWORK" : Upgrade ML framework.
  • "UPGRADE_OS" : Upgrade Operating System.
  • "UPGRADE_CUDA" : Upgrade CUDA.
  • "UPGRADE_ALL" : Upgrade All (OS, Framework and CUDA).

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

Completes with a IsInstanceUpgradeableResponse.

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<IsInstanceUpgradeableResponse> isUpgradeable(
  core.String notebookInstance, {
  core.String? type,
  core.String? $fields,
}) async {
  final queryParams_ = <core.String, core.List<core.String>>{
    if (type != null) 'type': [type],
    if ($fields != null) 'fields': [$fields],
  };

  final url_ =
      'v1/' + core.Uri.encodeFull('$notebookInstance') + ':isUpgradeable';

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