debug method

Future<Operation> debug(DebugInstanceRequest request, String appsId, String servicesId, String versionsId, String instancesId, { String? $fields, })

Enables debugging on a VM instance.

This allows you to use the SSH command to connect to the virtual machine where the instance lives. While in "debug mode", the instance continues to serve live traffic. You should delete the instance when you are done debugging and then allow the system to take over and determine if another instance should be started.Only applicable for instances in App Engine flexible environment.

request - The metadata request object.

Request parameters:

appsId - Part of name. Name of the resource requested. Example: apps/myapp/services/default/versions/v1/instances/instance-1.

servicesId - Part of name. See documentation of appsId.

versionsId - Part of name. See documentation of appsId.

instancesId - Part of name. See documentation of appsId.

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

Completes with a Operation.

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<Operation> debug(
  DebugInstanceRequest request,
  core.String appsId,
  core.String servicesId,
  core.String versionsId,
  core.String instancesId, {
  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/apps/' +
      commons.escapeVariable('$appsId') +
      '/services/' +
      commons.escapeVariable('$servicesId') +
      '/versions/' +
      commons.escapeVariable('$versionsId') +
      '/instances/' +
      commons.escapeVariable('$instancesId') +
      ':debug';

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