list method

Future<WorkloadCapturesListResponse> list(
  1. String project,
  2. String instance, {
  3. String? $fields,
})

Lists all captured workloads associated with the instance.

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 WorkloadCapturesListResponse.

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<WorkloadCapturesListResponse> list(
  core.String project,
  core.String instance, {
  core.String? $fields,
}) async {
  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';

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