aggregatedList method
Retrieves an aggregated list of reservations.
To prevent failure, Google recommends that you set the
returnPartialSuccess parameter to true.
Request parameters:
project - Project ID for this request.
Value must have pattern
(?:(?:\[-a-z0-9\]{1,63}\.)*(?:\[a-z\](?:\[-a-z0-9\]{0,61}\[a-z0-9\])?):)?(?:\[0-9\]{1,19}|(?:\[a-z0-9\](?:\[-a-z0-9\]{0,61}\[a-z0-9\])?)).
filter - A filter expression that filters resources listed in the
response. Most Compute resources support two types of filter expressions:
expressions that support regular expressions and expressions that follow
API improvement proposal AIP-160. These two types of filter expressions
cannot be mixed in one request. If you want to use AIP-160, your
expression must specify the field name, an operator, and the value that
you want to use for filtering. The value must be a string, a number, or a
boolean. The operator must be either =, !=, >, <, <=, >= or
:. For example, if you are filtering Compute Engine instances, you can
exclude instances named example-instance by specifying name != example-instance. The :* comparison can be used to test whether a key
has been defined. For example, to find all objects with owner label use:
labels.owner:* You can also filter nested fields. For example, you
could specify scheduling.automaticRestart = false to include instances
only if they are not scheduled for automatic restarts. You can use
filtering on nested fields to filter based on resource labels. To filter
on multiple expressions, provide each separate expression within
parentheses. For example: (scheduling.automaticRestart = true) (cpuPlatform = "Intel Skylake") By default, each expression is an
AND expression. However, you can include AND and OR expressions
explicitly. For example: (cpuPlatform = "Intel Skylake") OR (cpuPlatform = "Intel Broadwell") AND (scheduling.automaticRestart = true) If you want to use a regular expression, use the eq (equal) or ne
(not equal) operator against a single un-parenthesized expression with or
without quotes or against multiple parenthesized expressions. Examples:
fieldname eq unquoted literal fieldname eq 'single quoted literal'
fieldname eq "double quoted literal" (fieldname1 eq literal) (fieldname2 ne "literal") The literal value is interpreted as a regular
expression using Google RE2 library syntax. The literal value must match
the entire field. For example, to filter for instances that do not end
with name "instance", you would use name ne .*instance. You cannot
combine constraints on multiple fields using regular expressions.
includeAllScopes - Indicates whether every visible scope for each scope
type (zone, region, global) should be included in the response. For new
resource types added after this field, the flag has no effect as new
resource types will always include every visible scope for each scope type
in response. For resource types which predate this field, if this flag is
omitted or false, only scopes of the scope types where the resource type
is expected to be found will be included.
maxResults - The maximum number of results per page that should be
returned. If the number of available results is larger than maxResults,
Compute Engine returns a nextPageToken that can be used to get the next
page of results in subsequent list requests. Acceptable values are 0 to
500, inclusive. (Default: 500)
orderBy - Sorts list results by a certain order. By default, results are
returned in alphanumerical order based on the resource name. You can also
sort results in descending order based on the creation timestamp using
orderBy="creationTimestamp desc". This sorts results based on the
creationTimestamp field in reverse chronological order (newest result
first). Use this to sort resources like operations so that the newest
operation is returned first. Currently, only sorting by name or
creationTimestamp desc is supported.
pageToken - Specifies a page token to use. Set pageToken to the
nextPageToken returned by a previous list request to get the next page
of results.
returnPartialSuccess - Opt-in for partial success behavior which
provides partial results in case of failure. The default value is false.
For example, when partial success behavior is enabled, aggregatedList for
a single zone scope either returns all resources in the zone or no
resources, with an error code.
serviceProjectNumber - The Shared VPC service project id or service
project number for which aggregated list request is invoked for
subnetworks list-usable api.
$fields - Selector specifying which fields to include in a partial
response.
Completes with a ReservationAggregatedList.
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<ReservationAggregatedList> aggregatedList(
core.String project, {
core.String? filter,
core.bool? includeAllScopes,
core.int? maxResults,
core.String? orderBy,
core.String? pageToken,
core.bool? returnPartialSuccess,
core.String? serviceProjectNumber,
core.String? $fields,
}) async {
final queryParams_ = <core.String, core.List<core.String>>{
if (filter != null) 'filter': [filter],
if (includeAllScopes != null) 'includeAllScopes': ['${includeAllScopes}'],
if (maxResults != null) 'maxResults': ['${maxResults}'],
if (orderBy != null) 'orderBy': [orderBy],
if (pageToken != null) 'pageToken': [pageToken],
if (returnPartialSuccess != null)
'returnPartialSuccess': ['${returnPartialSuccess}'],
if (serviceProjectNumber != null)
'serviceProjectNumber': [serviceProjectNumber],
if ($fields != null) 'fields': [$fields],
};
final url_ = 'projects/' +
commons.escapeVariable('$project') +
'/aggregated/reservations';
final response_ = await _requester.request(
url_,
'GET',
queryParams: queryParams_,
);
return ReservationAggregatedList.fromJson(
response_ as core.Map<core.String, core.dynamic>);
}