list method
Lists all namespaces.
Request parameters:
parent
- Required. The resource name of the project and location whose
namespaces you'd like to list.
Value must have pattern ^projects/\[^/\]+/locations/\[^/\]+$
.
filter
- Optional. The filter to list results by. General filter
string syntax: ()
* can be `name` or `labels.` for map field *
can be <
, >
, <=
, >=
, !=
, =
, :
. Of which :
means HAS
, and
is roughly the same as =
* must be the same data type as field *
can be AND
, OR
, NOT
Examples of valid filters: * labels.owner
returns namespaces that have a label with the key owner
, this is the
same as labels:owner
* labels.owner=sd
returns namespaces that have
key/value owner=sd
*
name>projects/my-project/locations/us-east1/namespaces/namespace-c
returns namespaces that have name that is alphabetically later than the
string, so "namespace-e" is returned but "namespace-a" is not *
labels.owner!=sd AND labels.foo=bar
returns namespaces that have owner
in label key but value is not sd
AND have key/value foo=bar
*
doesnotexist.foo=bar
returns an empty list. Note that namespace doesn't
have a field called "doesnotexist". Since the filter does not match any
namespaces, it returns no results For more information about filtering,
see API Filtering.
orderBy
- Optional. The order to list results by. General order_by
string syntax: () (,)
* allows value: `name` *
ascending or
descending order by ``. If this is left blank, asc
is used Note that an
empty order_by
string results in default order, which is order by name
in ascending order.
pageSize
- Optional. The maximum number of items to return.
pageToken
- Optional. The next_page_token value returned from a previous
List request, if any.
$fields
- Selector specifying which fields to include in a partial
response.
Completes with a ListNamespacesResponse.
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<ListNamespacesResponse> list(
core.String parent, {
core.String? filter,
core.String? orderBy,
core.int? pageSize,
core.String? pageToken,
core.String? $fields,
}) async {
final queryParams_ = <core.String, core.List<core.String>>{
if (filter != null) 'filter': [filter],
if (orderBy != null) 'orderBy': [orderBy],
if (pageSize != null) 'pageSize': ['${pageSize}'],
if (pageToken != null) 'pageToken': [pageToken],
if ($fields != null) 'fields': [$fields],
};
final url_ = 'v1/' + core.Uri.encodeFull('$parent') + '/namespaces';
final response_ = await _requester.request(
url_,
'GET',
queryParams: queryParams_,
);
return ListNamespacesResponse.fromJson(
response_ as core.Map<core.String, core.dynamic>);
}