list method

Future<ListProgramsResponse> list(
  1. String parent, {
  2. int? pageSize,
  3. String? pageToken,
  4. String? $fields,
})

Retrieves all programs for the account.

Request parameters:

parent - Required. The name of the account for which to retrieve all programs. Format: accounts/{account} Value must have pattern ^accounts/\[^/\]+$.

pageSize - Optional. The maximum number of programs to return in a single response. If unspecified (or 0), a default size of 1000 is used. The maximum value is 1000; values above 1000 will be coerced to 1000.

pageToken - Optional. A continuation token, received from a previous ListPrograms call. Provide this to retrieve the next page.

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

Completes with a ListProgramsResponse.

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

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

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