list method
Retrieves a list of placement strategies, possibly filtered.
This method supports paging.
Request parameters:
profileId - User profile ID associated with this request.
Value must have pattern ^\[^/\]+$.
ids - Select only placement strategies with these IDs.
maxResults - Maximum number of results to return.
pageToken - Value of the nextPageToken from the previous result page.
searchString - Allows searching for objects by name or ID. Wildcards ()
are allowed. For example, "placementstrategy2015" will return objects
with names like "placementstrategy June 2015", "placementstrategy April
2015", or simply "placementstrategy 2015". Most of the searches also add
wildcards implicitly at the start and the end of the search string. For
example, a search string of "placementstrategy" will match objects with
name "my placementstrategy", "placementstrategy 2015", or simply
"placementstrategy".
sortField - Field by which to sort the list.
Possible string values are:
- "ID"
- "NAME"
sortOrder - Order of sorted results.
Possible string values are:
- "ASCENDING" : Ascending order.
- "DESCENDING" : Descending order.
$fields - Selector specifying which fields to include in a partial
response.
Completes with a PlacementStrategiesListResponse.
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<PlacementStrategiesListResponse> list(
core.String profileId, {
core.List<core.String>? ids,
core.int? maxResults,
core.String? pageToken,
core.String? searchString,
core.String? sortField,
core.String? sortOrder,
core.String? $fields,
}) async {
final queryParams_ = <core.String, core.List<core.String>>{
if (ids != null) 'ids': ids,
if (maxResults != null) 'maxResults': ['${maxResults}'],
if (pageToken != null) 'pageToken': [pageToken],
if (searchString != null) 'searchString': [searchString],
if (sortField != null) 'sortField': [sortField],
if (sortOrder != null) 'sortOrder': [sortOrder],
if ($fields != null) 'fields': [$fields],
};
final url_ = 'userprofiles/' +
core.Uri.encodeFull('$profileId') +
'/placementStrategies';
final response_ = await _requester.request(
url_,
'GET',
queryParams: queryParams_,
);
return PlacementStrategiesListResponse.fromJson(
response_ as core.Map<core.String, core.dynamic>);
}