describeDataset method

Future<DescribeDatasetResponse> describeDataset({
  1. required String datasetId,
  2. String? datasetVersion,
  3. String? workspaceName,
})

Retrieves information about a dataset.

May throw InternalFailureException. May throw InvalidRequestException. May throw ResourceNotFoundException. May throw ThrottlingException.

Parameter datasetId : The ID of the dataset.

Parameter datasetVersion : The version of the dataset.

Parameter workspaceName : The name of the workspace that contains the dataset.

Implementation

Future<DescribeDatasetResponse> describeDataset({
  required String datasetId,
  String? datasetVersion,
  String? workspaceName,
}) async {
  final $query = <String, List<String>>{
    if (datasetVersion != null) 'datasetVersion': [datasetVersion],
    if (workspaceName != null) 'workspaceName': [workspaceName],
  };
  final response = await _protocol.send(
    payload: null,
    method: 'GET',
    requestUri: '/datasets/${Uri.encodeComponent(datasetId)}',
    queryParams: $query,
    hostPrefix: 'api.',
    exceptionFnMap: _exceptionFns,
  );
  return DescribeDatasetResponse.fromJson(response);
}