delete method
Deletes a single migration job.
Request parameters:
name
- Required. Name of the migration job resource to delete.
Value must have pattern
^projects/\[^/\]+/locations/\[^/\]+/migrationJobs/\[^/\]+$
.
force
- The destination CloudSQL connection profile is always deleted
with the migration job. In case of force delete, the destination CloudSQL
replica database is also deleted.
requestId
- A unique ID used to identify the request. If the server
receives two requests with the same ID, then the second request is
ignored. It is recommended to always set this value to a UUID. The ID must
contain only letters (a-z, A-Z), numbers (0-9), underscores (_), and
hyphens (-). The maximum length is 40 characters.
$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> delete(
core.String name, {
core.bool? force,
core.String? requestId,
core.String? $fields,
}) async {
final queryParams_ = <core.String, core.List<core.String>>{
if (force != null) 'force': ['${force}'],
if (requestId != null) 'requestId': [requestId],
if ($fields != null) 'fields': [$fields],
};
final url_ = 'v1/' + core.Uri.encodeFull('$name');
final response_ = await _requester.request(
url_,
'DELETE',
queryParams: queryParams_,
);
return Operation.fromJson(response_ as core.Map<core.String, core.dynamic>);
}