startManualRuns method

Future<StartManualTransferRunsResponse> startManualRuns(
  1. StartManualTransferRunsRequest request,
  2. String parent, {
  3. String? $fields,
})

Manually initiates transfer runs.

You can schedule these runs in two ways: 1. For a specific point in time using the 'requested_run_time' parameter. 2. For a period between 'start_time' (inclusive) and 'end_time' (exclusive). If scheduling a single run, it is set to execute immediately (schedule_time equals the current time). When scheduling multiple runs within a time range, the first run starts now, and subsequent runs are delayed by 15 seconds each.

request - The metadata request object.

Request parameters:

parent - Required. Transfer configuration name. If you are using the regionless method, the location must be US and the name should be in the following form: * projects/{project_id}/transferConfigs/{config_id} If you are using the regionalized method, the name should be in the following form: * projects/{project_id}/locations/{location_id}/transferConfigs/{config_id} Value must have pattern ^projects/\[^/\]+/locations/\[^/\]+/transferConfigs/\[^/\]+$.

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

Completes with a StartManualTransferRunsResponse.

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<StartManualTransferRunsResponse> startManualRuns(
  StartManualTransferRunsRequest request,
  core.String parent, {
  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('$parent') + ':startManualRuns';

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