generateSshScript method

Future<SshScript> generateSshScript(
  1. GenerateSshScriptRequest request,
  2. String migrationJob, {
  3. String? $fields,
})

Generate a SSH configuration script to configure the reverse SSH connectivity.

request - The metadata request object.

Request parameters:

migrationJob - Name of the migration job resource to generate the SSH script. Value must have pattern ^projects/\[^/\]+/locations/\[^/\]+/migrationJobs/\[^/\]+$.

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

Completes with a SshScript.

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<SshScript> generateSshScript(
  GenerateSshScriptRequest request,
  core.String migrationJob, {
  core.String? $fields,
}) async {
  final body_ = convert_1.json.encode(request);
  final queryParams_ = <core.String, core.List<core.String>>{
    if ($fields != null) 'fields': [$fields],
  };

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

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