list method

Future<GoogleCloudApigeeV1ListOfDevelopersResponse> list(String parent, { String? app, String? count, bool? expand, String? ids, bool? includeCompany, String? startKey, String? $fields, })

Lists all developers in an organization by email address.

By default, the response does not include company developers. Set the includeCompany query parameter to true to include company developers. Note: A maximum of 1000 developers are returned in the response. You paginate the list of developers returned using the startKey and count query parameters.

Request parameters:

parent - Required. Name of the Apigee organization. Use the following structure in your request: organizations/{org}. Value must have pattern ^organizations/\[^/\]+$.

app - Optional. List only Developers that are associated with the app. Note that start_key, count are not applicable for this filter criteria.

count - Optional. Number of developers to return in the API call. Use with the startKey parameter to provide more targeted filtering. The limit is 1000.

expand - Specifies whether to expand the results. Set to true to expand the results. This query parameter is not valid if you use the count or startKey query parameters.

ids - Optional. List of IDs to include, separated by commas.

includeCompany - Flag that specifies whether to include company details in the response.

startKey - Note: Must be used in conjunction with the count parameter. Email address of the developer from which to start displaying the list of developers. For example, if the an unfiltered list returns: [e-mail] [e-mail] [e-mail] and your startKey is [e-mail], the list returned will be [e-mail] [e-mail]

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

Completes with a GoogleCloudApigeeV1ListOfDevelopersResponse.

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<GoogleCloudApigeeV1ListOfDevelopersResponse> list(
  core.String parent, {
  core.String? app,
  core.String? count,
  core.bool? expand,
  core.String? ids,
  core.bool? includeCompany,
  core.String? startKey,
  core.String? $fields,
}) async {
  final queryParams_ = <core.String, core.List<core.String>>{
    if (app != null) 'app': [app],
    if (count != null) 'count': [count],
    if (expand != null) 'expand': ['${expand}'],
    if (ids != null) 'ids': [ids],
    if (includeCompany != null) 'includeCompany': ['${includeCompany}'],
    if (startKey != null) 'startKey': [startKey],
    if ($fields != null) 'fields': [$fields],
  };

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

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