fetchEntitiesStatusView method

Future<FetchEntitiesStatusViewResponse> fetchEntitiesStatusView(
  1. String conversionWorkspace, {
  2. String? fetchView,
  3. String? filter,
  4. int? pageSize,
  5. String? pageToken,
  6. String? tree,
  7. String? $fields,
})

An internal, RPC only method that returns a list of the (filtered) entities with minimal information required for the entities tree view.

Request parameters:

conversionWorkspace - Required. Name of the conversion workspace resource whose database entities are described. Must be in the form of: projects/{project}/locations/{location}/conversionWorkspaces/{conversion_workspace}. Value must have pattern ^projects/\[^/\]+/locations/\[^/\]+/conversionWorkspaces/\[^/\]+$.

fetchView - Optional. The view to fetch. If not specified, FULL is used. Possible string values are:

  • "FETCH_VIEW_UNSPECIFIED" : Unspecified view. Defaults to FULL.
  • "FULL" : Get all entities matching the filter.
  • "SUMMARY" : Each schema will have one entity per (non sub) type with a dummy name that will contain the aggregated information for all entities of that type. Counters like number of statements and issues will be aggregated accordingly.
  • "FULL_WITH_DEPENDENCIES" : Same as FULL plus dependency information.

filter - Optional. Filter the returned entities based on AIP-160 standard.

pageSize - Optional. The maximum number of entities to return. The service may return fewer entities than the value specifies. Default is 100000.

pageToken - Optional. The nextPageToken value received in the previous call to conversionWorkspace.FetchEntitiesStatusView, used in the subsequent request to retrieve the next page of results. On first call this should be left blank. When paginating, all other parameters provided to conversionWorkspace.FetchEntitiesStatusView must match the call that provided the page token, except for the page_size parameter.

tree - Required. The tree to fetch. Possible string values are:

  • "DB_TREE_TYPE_UNSPECIFIED" : Unspecified tree type.
  • "SOURCE_TREE" : The source database tree.
  • "DRAFT_TREE" : The draft database tree.

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

Completes with a FetchEntitiesStatusViewResponse.

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<FetchEntitiesStatusViewResponse> fetchEntitiesStatusView(
  core.String conversionWorkspace, {
  core.String? fetchView,
  core.String? filter,
  core.int? pageSize,
  core.String? pageToken,
  core.String? tree,
  core.String? $fields,
}) async {
  final queryParams_ = <core.String, core.List<core.String>>{
    'fetchView': ?fetchView == null ? null : [fetchView],
    'filter': ?filter == null ? null : [filter],
    'pageSize': ?pageSize == null ? null : ['${pageSize}'],
    'pageToken': ?pageToken == null ? null : [pageToken],
    'tree': ?tree == null ? null : [tree],
    'fields': ?$fields == null ? null : [$fields],
  };

  final url_ =
      'v1/' +
      core.Uri.encodeFull('$conversionWorkspace') +
      ':fetchEntitiesStatusView';

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