list method

Future<ListTablesResponse> list(
  1. String parent, {
  2. int? pageSize,
  3. String? pageToken,
  4. String? view,
  5. String? $fields,
})

List all tables in a specified database.

Request parameters:

parent - Required. The parent, which owns this collection of tables. Format: projects/{project_id_or_number}/locations/{location_id}/catalogs/{catalog_id}/databases/{database_id} Value must have pattern ^projects/\[^/\]+/locations/\[^/\]+/catalogs/\[^/\]+/databases/\[^/\]+$.

pageSize - The maximum number of tables to return. The service may return fewer than this value. If unspecified, at most 50 tables will be returned. The maximum value is 1000; values above 1000 will be coerced to 1000.

pageToken - A page token, received from a previous ListTables call. Provide this to retrieve the subsequent page. When paginating, all other parameters provided to ListTables must match the call that provided the page token.

view - The view for the returned tables. Possible string values are:

  • "TABLE_VIEW_UNSPECIFIED" : Default value. The API will default to the BASIC view.
  • "BASIC" : Include only table names. This is the default value.
  • "FULL" : Include everything.

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

Completes with a ListTablesResponse.

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<ListTablesResponse> list(
  core.String parent, {
  core.int? pageSize,
  core.String? pageToken,
  core.String? view,
  core.String? $fields,
}) async {
  final queryParams_ = <core.String, core.List<core.String>>{
    if (pageSize != null) 'pageSize': ['${pageSize}'],
    if (pageToken != null) 'pageToken': [pageToken],
    if (view != null) 'view': [view],
    if ($fields != null) 'fields': [$fields],
  };

  final url_ = 'v1/' + core.Uri.encodeFull('$parent') + '/tables';

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