list method

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

Lists reference images.

Possible errors: * Returns NOT_FOUND if the parent product does not exist.

  • Returns INVALID_ARGUMENT if the page_size is greater than 100, or less than 1.

Request parameters:

parent - Required. Resource name of the product containing the reference images. Format is projects/PROJECT_ID/locations/LOC_ID/products/PRODUCT_ID. Value must have pattern ^projects/\[^/\]+/locations/\[^/\]+/products/\[^/\]+$.

pageSize - The maximum number of items to return. Default 10, maximum 100.

pageToken - A token identifying a page of results to be returned. This is the value of nextPageToken returned in a previous reference image list request. Defaults to the first page if not specified.

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

Completes with a ListReferenceImagesResponse.

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<ListReferenceImagesResponse> 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_ = 'v1/' + core.Uri.encodeFull('$parent') + '/referenceImages';

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