list method

Future<GoogleHomeEnterpriseSdmV1ListStructuresResponse> list(
  1. String parent, {
  2. String? filter,
  3. String? $fields,
})

Lists structures managed by the enterprise.

Request parameters:

parent - The parent enterprise to list structures under. E.g. "enterprises/XYZ". Value must have pattern ^enterprises/\[^/\]+$.

filter - Optional filter to list structures.

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

Completes with a GoogleHomeEnterpriseSdmV1ListStructuresResponse.

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

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

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