list method
List subjects in the schema registry.
The response will be an array of subject names.
Request parameters:
parent
- Required. The parent schema registry/context whose subjects are
to be listed. Structured like:
projects/{project}/locations/{location}/schemaRegistries/{schema_registry}
or
projects/{project}/locations/{location}/schemaRegistries/{schema_registry}/contexts/{context}
Value must have pattern
^projects/\[^/\]+/locations/\[^/\]+/schemaRegistries/\[^/\]+/contexts/\[^/\]+$
.
deleted
- Optional. If true, the response will include soft-deleted
subjects. The default is false.
subjectPrefix
- Optional. The context to filter the subjects by, in the
format of :.{context}:
. If unset, all subjects in the registry are
returned. Set to empty string or add as '?subjectPrefix=' at the end of
this request to list subjects in the default context.
$fields
- Selector specifying which fields to include in a partial
response.
Completes with a HttpBody.
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<HttpBody> list(
core.String parent, {
core.bool? deleted,
core.String? subjectPrefix,
core.String? $fields,
}) async {
final queryParams_ = <core.String, core.List<core.String>>{
if (deleted != null) 'deleted': ['${deleted}'],
if (subjectPrefix != null) 'subjectPrefix': [subjectPrefix],
if ($fields != null) 'fields': [$fields],
};
final url_ = 'v1/' + core.Uri.encodeFull('$parent') + '/subjects';
final response_ = await _requester.request(
url_,
'GET',
queryParams: queryParams_,
);
return HttpBody.fromJson(response_ as core.Map<core.String, core.dynamic>);
}