get method

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

Gets a schema.

Request parameters:

name - Required. The name of the schema to get. Format is projects/{project}/schemas/{schema}. Value must have pattern ^projects/\[^/\]+/schemas/\[^/\]+$.

view - The set of fields to return in the response. If not set, returns a Schema with all fields filled out. Set to BASIC to omit the definition. Possible string values are:

  • "SCHEMA_VIEW_UNSPECIFIED" : The default / unset value. The API will default to the BASIC view.
  • "BASIC" : Include the name and type of the schema, but not the definition.
  • "FULL" : Include all Schema object fields.

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

Completes with a Schema.

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<Schema> 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 Schema.fromJson(response_ as core.Map<core.String, core.dynamic>);
}