get method

Future<Dataset> get(
  1. String projectId,
  2. String datasetId, {
  3. int? accessPolicyVersion,
  4. String? datasetView,
  5. String? $fields,
})

Returns the dataset specified by datasetID.

Request parameters:

projectId - Required. Project ID of the requested dataset Value must have pattern ^\[^/\]+$.

datasetId - Required. Dataset ID of the requested dataset Value must have pattern ^\[^/\]+$.

accessPolicyVersion - Optional. The version of the access policy schema to fetch. Valid values are 0, 1, and 3. Requests specifying an invalid value will be rejected. Requests for conditional access policy binding in datasets must specify version 3. Dataset with no conditional role bindings in access policy may specify any valid value or leave the field unset. This field will be mapped to IAM Policy version and will be used to fetch policy from IAM. If unset or if 0 or 1 value is used for dataset with conditional bindings, access entry with condition will have role string appended by 'withcond' string followed by a hash value. For example : { "access": [ { "role": "roles/bigquery.dataViewer_with_conditionalbinding_7a34awqsda", "userByEmail": "user@example.com", } ] } Please refer https://cloud.google.com/iam/docs/troubleshooting-withcond for more details.

datasetView - Optional. Specifies the view that determines which dataset information is returned. By default, metadata and ACL information are returned. Possible string values are:

  • "DATASET_VIEW_UNSPECIFIED" : The default value. Default to the FULL view.
  • "METADATA" : Includes metadata information for the dataset, such as location, etag, lastModifiedTime, etc.
  • "ACL" : Includes ACL information for the dataset, which defines dataset access for one or more entities.
  • "FULL" : Includes both dataset metadata and ACL information.

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

Completes with a Dataset.

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<Dataset> get(
  core.String projectId,
  core.String datasetId, {
  core.int? accessPolicyVersion,
  core.String? datasetView,
  core.String? $fields,
}) async {
  final queryParams_ = <core.String, core.List<core.String>>{
    if (accessPolicyVersion != null)
      'accessPolicyVersion': ['${accessPolicyVersion}'],
    if (datasetView != null) 'datasetView': [datasetView],
    if ($fields != null) 'fields': [$fields],
  };

  final url_ = 'projects/' +
      core.Uri.encodeFull('$projectId') +
      '/datasets/' +
      core.Uri.encodeFull('$datasetId');

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