start method

Future<Operation> start(WorkloadCapturesStartRequest request, String project, String instance, { String? $fields, })

Starts capturing the SQL queries, transactions, and other operations executed on the primary instance.

This traffic is securely stored and forms a "captured workload". This workload can be replayed later on a different instance to safely test performance impacts, database upgrades, configuration changes etc. before applying them to production.

request - The metadata request object.

Request parameters:

project - Required. Project ID of the project that contains the instance.

instance - Required. Cloud SQL instance ID. This does not include the project ID.

$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> start(
  WorkloadCapturesStartRequest request,
  core.String project,
  core.String instance, {
  core.String? $fields,
}) async {
  final body_ = convert.json.encode(request);
  final queryParams_ = <core.String, core.List<core.String>>{
    'fields': ?$fields == null ? null : [$fields],
  };

  final url_ =
      'v1/projects/' +
      commons.escapeVariable('$project') +
      '/instances/' +
      commons.escapeVariable('$instance') +
      '/workloadCaptures:start';

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