list method
Lists the DICOM stores in the given dataset.
Request parameters:
parent
- Required. Name of the dataset.
Value must have pattern
^projects/\[^/\]+/locations/\[^/\]+/datasets/\[^/\]+$
.
filter
- Restricts stores returned to those matching a filter. The
following syntax is available: * A string field value can be written as
text inside quotation marks, for example "query text"
. The only valid
relational operation for text fields is equality (=
), where text is
searched within the field, rather than having the field be equal to the
text. For example, "Comment = great"
returns messages with great
in
the comment field. * A number field value can be written as an integer, a
decimal, or an exponential. The valid relational operators for number
fields are the equality operator (=
), along with the less than/greater
than operators (<
, <=
, >
, >=
). Note that there is no inequality
(!=
) operator. You can prepend the NOT
operator to an expression to
negate it. * A date field value must be written in yyyy-mm-dd
form.
Fields with date and time use the RFC3339 time format. Leading zeros are
required for one-digit months and days. The valid relational operators for
date fields are the equality operator (=
) , along with the less
than/greater than operators (<
, <=
, >
, >=
). Note that there is no
inequality (!=
) operator. You can prepend the NOT
operator to an
expression to negate it. * Multiple field query expressions can be
combined in one query by adding AND
or OR
operators between the
expressions. If a boolean operator appears within a quoted string, it is
not treated as special, it's just another part of the character string to
be matched. You can prepend the NOT
operator to an expression to negate
it. Only filtering on labels is supported. For example,
labels.key=value
.
pageSize
- Limit on the number of DICOM stores to return in a single
response. If not specified, 100 is used. May not be larger than 1000.
pageToken
- The next_page_token value returned from the previous List
request, if any.
$fields
- Selector specifying which fields to include in a partial
response.
Completes with a ListDicomStoresResponse.
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<ListDicomStoresResponse> list(
core.String parent, {
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],
};
final url_ = 'v1/' + core.Uri.encodeFull('$parent') + '/dicomStores';
final response_ = await _requester.request(
url_,
'GET',
queryParams: queryParams_,
);
return ListDicomStoresResponse.fromJson(
response_ as core.Map<core.String, core.dynamic>);
}