getSchema method

Future<Schema> getSchema(String name, { bool? debugOptions_enableDebugging, String? $fields, })

Gets the schema of a data source.

Note: This API requires an admin or service account to execute.

Request parameters:

name - The name of the data source to get Schema. Format: datasources/{source_id} Value must have pattern ^datasources/\[^/\]+$.

debugOptions_enableDebugging - If you are asked by Google to help with debugging, set this field. Otherwise, ignore this field.

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

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

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