list method
Lists PrivateCloud
resources in a given project and location.
Request parameters:
parent
- Required. The resource name of the private cloud to be queried
for clusters. Resource names are schemeless URIs that follow the
conventions in https://cloud.google.com/apis/design/resource_names. For
example: projects/my-project/locations/us-central1-a
Value must have pattern ^projects/\[^/\]+/locations/\[^/\]+$
.
filter
- A filter expression that matches resources returned in the
response. The expression must specify the field name, a comparison
operator, and the value that you want to use for filtering. The value must
be a string, a number, or a boolean. The comparison operator must be =
,
!=
, >
, or <
. For example, if you are filtering a list of private
clouds, you can exclude the ones named example-pc
by specifying name != "example-pc"
. You can also filter nested fields. For example, you could
specify networkConfig.managementCidr = "192.168.0.0/24"
to include
private clouds only if they have a matching address in their network
configuration. To filter on multiple expressions, provide each separate
expression within parentheses. For example: (name = "example-pc") (createTime > "2021-04-12T08:15:10.40Z")
By default, each expression
is an AND
expression. However, you can include AND
and OR
expressions explicitly. For example: (name = "private-cloud-1") AND (createTime > "2021-04-12T08:15:10.40Z") OR (name = "private-cloud-2")
orderBy
- Sorts list results by a certain order. By default, returned
results are ordered by name
in ascending order. You can also sort
results in descending order based on the name
value using orderBy="name desc"
. Currently, only ordering by name
is supported.
pageSize
- The maximum number of private clouds to return in one page.
The service may return fewer than this value. The maximum value is coerced
to 1000. The default value of this field is 500.
pageToken
- A page token, received from a previous ListPrivateClouds
call. Provide this to retrieve the subsequent page. When paginating, all
other parameters provided to ListPrivateClouds
must match the call that
provided the page token.
$fields
- Selector specifying which fields to include in a partial
response.
Completes with a ListPrivateCloudsResponse.
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<ListPrivateCloudsResponse> 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') + '/privateClouds';
final response_ = await _requester.request(
url_,
'GET',
queryParams: queryParams_,
);
return ListPrivateCloudsResponse.fromJson(
response_ as core.Map<core.String, core.dynamic>);
}