scheduleRuns method

  1. @Deprecated('Not supported. Member documentation may have more information.')
Future<ScheduleTransferRunsResponse> scheduleRuns(
  1. ScheduleTransferRunsRequest request,
  2. String parent, {
  3. String? $fields,
})

Creates transfer runs for a time range [start_time, end_time].

For each date - or whatever granularity the data source supports - in the range, one transfer run is created. Note that runs are created per UTC time in the time range. DEPRECATED: use StartManualTransferRuns instead.

request - The metadata request object.

Request parameters:

parent - Required. Transfer configuration name in the form: projects/{project_id}/transferConfigs/{config_id} or projects/{project_id}/locations/{location_id}/transferConfigs/{config_id}. Value must have pattern ^projects/\[^/\]+/transferConfigs/\[^/\]+$.

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

Completes with a ScheduleTransferRunsResponse.

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

@core.Deprecated(
  'Not supported. Member documentation may have more information.',
)
async.Future<ScheduleTransferRunsResponse> scheduleRuns(
  ScheduleTransferRunsRequest 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') + ':scheduleRuns';

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