get method

Future<GoogleCloudDataplexV1Entity> get(
  1. String name, {
  2. String? view,
  3. String? $fields,
})

Get a metadata entity.

Request parameters:

name - Required. The resource name of the entity: projects/{project_number}/locations/{location_id}/lakes/{lake_id}/zones/{zone_id}/entities/{entity_id}. Value must have pattern ^projects/\[^/\]+/locations/\[^/\]+/lakes/\[^/\]+/zones/\[^/\]+/entities/\[^/\]+$.

view - Optional. Used to select the subset of entity information to return. Defaults to BASIC. Possible string values are:

  • "ENTITY_VIEW_UNSPECIFIED" : The API will default to the BASIC view.
  • "BASIC" : Minimal view that does not include the schema.
  • "SCHEMA" : Include basic information and schema.
  • "FULL" : Include everything. Currently, this is the same as the SCHEMA view.

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

Completes with a GoogleCloudDataplexV1Entity.

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<GoogleCloudDataplexV1Entity> get(
  core.String name, {
  core.String? view,
  core.String? $fields,
}) async {
  final queryParams_ = <core.String, core.List<core.String>>{
    if (view != null) 'view': [view],
    if ($fields != null) 'fields': [$fields],
  };

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

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