get method

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

Gets metadata of given entity type

Request parameters:

name - Required. Resource name of the Entity Type. Format: projects/{project}/locations/{location}/connections/{connection}/entityTypes/{entityType} Value must have pattern ^projects/\[^/\]+/locations/\[^/\]+/connections/\[^/\]+/entityTypes/\[^/\]+$.

view - Specifies view for entity type schema. Possible string values are:

  • "ENTITY_TYPE_SCHEMA_VIEW_UNSPECIFIED" : VIEW_UNSPECIFIED. The unset value. Defaults to BASIC View.
  • "ENTITY_TYPE_SCHEMA_VIEW_BASIC" : Return basic entity type schema.
  • "ENTITY_TYPE_SCHEMA_VIEW_ENRICHED" : Return enriched entity types schema.

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

Completes with a EntityType.

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<EntityType> 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_ = 'v2/' + core.Uri.encodeFull('$name');

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