list method
Lists all the PhotoSequences that belong to the user, in descending CreatePhotoSequence timestamp order.
Request parameters:
filter
- Optional. The filter expression. For example:
`imagery_type=SPHERICAL`. The filters supported are: `imagery_type`,
`processing_state`, `min_latitude`, `max_latitude`,
`min_longitude`, `max_longitude`, `filename_query`,
`min_capture_time_seconds`, `max_capture_time_seconds. See
https://google.aip.dev/160 for more information. Filename queries should
sent as a Phrase in order to support multiple words and special characters
by adding escaped quotes. Ex: filename_query="example of a phrase.mp4"
pageSize
- Optional. The maximum number of photo sequences to return.
pageSize
must be non-negative. If pageSize
is zero or is not provided,
the default page size of 100 is used. The number of photo sequences
returned in the response may be less than pageSize
if the number of
matches is less than pageSize
. This is currently unimplemented but is in
process.
pageToken
- Optional. The nextPageToken value returned from a previous
ListPhotoSequences request, if any.
$fields
- Selector specifying which fields to include in a partial
response.
Completes with a ListPhotoSequencesResponse.
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<ListPhotoSequencesResponse> list({
core.String? filter,
core.int? pageSize,
core.String? pageToken,
core.String? $fields,
}) async {
final queryParams_ = <core.String, core.List<core.String>>{
if (filter != null) 'filter': [filter],
if (pageSize != null) 'pageSize': ['${pageSize}'],
if (pageToken != null) 'pageToken': [pageToken],
if ($fields != null) 'fields': [$fields],
};
const url_ = 'v1/photoSequences';
final response_ = await _requester.request(
url_,
'GET',
queryParams: queryParams_,
);
return ListPhotoSequencesResponse.fromJson(
response_ as core.Map<core.String, core.dynamic>);
}