list method
Lists the Products in a ProductSet, in an unspecified order.
If the ProductSet does not exist, the products field of the response will be empty. Possible errors: * Returns INVALID_ARGUMENT if page_size is greater than 100 or less than 1.
Request parameters:
name
- Required. The ProductSet resource for which to retrieve Products.
Format is:
projects/PROJECT_ID/locations/LOC_ID/productSets/PRODUCT_SET_ID
Value must have pattern
^projects/\[^/\]+/locations/\[^/\]+/productSets/\[^/\]+$
.
pageSize
- The maximum number of items to return. Default 10, maximum
100.
pageToken
- The next_page_token returned from a previous List request,
if any.
$fields
- Selector specifying which fields to include in a partial
response.
Completes with a ListProductsInProductSetResponse.
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<ListProductsInProductSetResponse> list(
core.String name, {
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_ = 'v1/' + core.Uri.encodeFull('$name') + '/products';
final response_ = await _requester.request(
url_,
'GET',
queryParams: queryParams_,
);
return ListProductsInProductSetResponse.fromJson(
response_ as core.Map<core.String, core.dynamic>);
}