riskExportDatasetWithHttpInfo method

Future<Response> riskExportDatasetWithHttpInfo(
  1. String name, {
  2. int? version,
  3. String? split,
  4. int? offset,
  5. int? limit,
})

Read a version's rows back, one page at a time

Reads a published version's rows back, one bounded page at a time, in the version's own stable row order. Only a published version can be exported. Rows written by an attempt that never completed are inert — no register row names them — and they are disposed of with the dataset.

Note: This method returns the HTTP Response.

Parameters:

  • String name (required): Name is the dataset, from the path.

  • int version: Version is the version to read. Zero takes the newest published one.

  • String split: Split narrows to train, val or test. Empty reads every split.

  • int offset: Offset is where the page starts, in the version's own row order (by id, which is derived from the row and therefore stable forever).

  • int limit: Limit is how many rows to return. Zero and anything above the plane's bound take the bound.

Implementation

Future<Response> riskExportDatasetWithHttpInfo(String name, { int? version, String? split, int? offset, int? limit, }) async {
  // ignore: prefer_const_declarations
  final path = r'/v1/dataset/{name}/export'
    .replaceAll('{name}', name);

  // ignore: prefer_final_locals
  Object? postBody;

  final queryParams = <QueryParam>[];
  final headerParams = <String, String>{};
  final formParams = <String, String>{};

  if (version != null) {
    queryParams.addAll(_queryParams('', 'version', version));
  }
  if (split != null) {
    queryParams.addAll(_queryParams('', 'split', split));
  }
  if (offset != null) {
    queryParams.addAll(_queryParams('', 'offset', offset));
  }
  if (limit != null) {
    queryParams.addAll(_queryParams('', 'limit', limit));
  }

  const contentTypes = <String>[];


  return apiClient.invokeAPI(
    path,
    'GET',
    queryParams,
    postBody,
    headerParams,
    formParams,
    contentTypes.isEmpty ? null : contentTypes.first,
  );
}