list method
- @Deprecated('Not supported. Member documentation may have more information.')
Lists an organization's assets.
Request parameters:
parent
- Required. The name of the parent resource that contains the
assets. The value that you can specify on parent depends on the method in
which you specify parent. You can specify one of the following values:
"organizations/[organization_id]", "folders/[folder_id]", or
"projects/[project_id]".
Value must have pattern ^organizations/\[^/\]+$
.
compareDuration
- When compare_duration is set, the ListAssetsResult's
"state_change" attribute is updated to indicate whether the asset was
added, removed, or remained present during the compare_duration period of
time that precedes the read_time. This is the time between (read_time -
compare_duration) and read_time. The state_change value is derived based
on the presence of the asset at the two points in time. Intermediate state
changes between the two times don't affect the result. For example, the
results aren't affected if the asset is removed and re-created again.
Possible "state_change" values when compare_duration is specified: *
"ADDED": indicates that the asset was not present at the start of
compare_duration, but present at read_time. * "REMOVED": indicates that
the asset was present at the start of compare_duration, but not present at
read_time. * "ACTIVE": indicates that the asset was present at both the
start and the end of the time period defined by compare_duration and
read_time. If compare_duration is not specified, then the only possible
state_change is "UNUSED", which will be the state_change set for all
assets present at read_time.
fieldMask
- A field mask to specify the ListAssetsResult fields to be
listed in the response. An empty field mask will list all fields.
filter
- Expression that defines the filter to apply across assets. The
expression is a list of zero or more restrictions combined via logical
operators AND
and OR
. Parentheses are supported, and OR
has higher
precedence than AND
. Restrictions have the form
and may have a -
character in front of them to indicate negation. The fields map to those
defined in the Asset resource. Examples include: * name *
security_center_properties.resource_name * resource_properties.a_property
- security_marks.marks.marka The supported operators are: *
=
for all value types. *>
,<
,>=
,<=
for integer values. *:
, meaning substring matching, for strings. The supported value types are: * string literals in quotes. * integer literals without quotes. * boolean literalstrue
andfalse
without quotes. The following are the allowed field and operator combinations: * name:=
* update_time:=
,>
,<
,>=
,<=
Usage: This should be milliseconds since epoch or an RFC3339 string. Examples:update_time = "2019-06-10T16:07:18-07:00"
update_time = 1560208038000
* create_time:=
,>
,<
,>=
,<=
Usage: This should be milliseconds since epoch or an RFC3339 string. Examples:create_time = "2019-06-10T16:07:18-07:00"
create_time = 1560208038000
* iam_policy.policy_blob:=
,:
* resource_properties:=
,:
,>
,<
,>=
,<=
* security_marks.marks:=
,:
* security_center_properties.resource_name:=
,:
* security_center_properties.resource_display_name:=
,:
* security_center_properties.resource_type:=
,:
* security_center_properties.resource_parent:=
,:
* security_center_properties.resource_parent_display_name:=
,:
* security_center_properties.resource_project:=
,:
* security_center_properties.resource_project_display_name:=
,:
* security_center_properties.resource_owners:=
,:
For example,resource_properties.size = 100
is a valid filter string. Use a partial match on the empty string to filter based on a property existing:resource_properties.my_property : ""
Use a negated partial match on the empty string to filter based on a property not existing:-resource_properties.my_property : ""
orderBy
- Expression that defines what fields and order to use for
sorting. The string value should follow SQL syntax: comma separated list
of fields. For example: "name,resource_properties.a_property". The default
sorting order is ascending. To specify descending order for a field, a
suffix " desc" should be appended to the field name. For example: "name
desc,resource_properties.a_property". Redundant space characters in the
syntax are insignificant. "name desc,resource_properties.a_property" and "
name desc , resource_properties.a_property " are equivalent. The following
fields are supported: name update_time resource_properties
security_marks.marks security_center_properties.resource_name
security_center_properties.resource_display_name
security_center_properties.resource_parent
security_center_properties.resource_parent_display_name
security_center_properties.resource_project
security_center_properties.resource_project_display_name
security_center_properties.resource_type
pageSize
- The maximum number of results to return in a single response.
Default is 10, minimum is 1, maximum is 1000.
pageToken
- The value returned by the last ListAssetsResponse
;
indicates that this is a continuation of a prior ListAssets
call, and
that the system should return the next page of data.
readTime
- Time used as a reference point when filtering assets. The
filter is limited to assets existing at the supplied time and their values
are those at that specific time. Absence of this field will default to the
API's version of NOW.
$fields
- Selector specifying which fields to include in a partial
response.
Completes with a ListAssetsResponse.
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
@core.Deprecated(
'Not supported. Member documentation may have more information.',
)
async.Future<ListAssetsResponse> list(
core.String parent, {
core.String? compareDuration,
core.String? fieldMask,
core.String? filter,
core.String? orderBy,
core.int? pageSize,
core.String? pageToken,
core.String? readTime,
core.String? $fields,
}) async {
final queryParams_ = <core.String, core.List<core.String>>{
if (compareDuration != null) 'compareDuration': [compareDuration],
if (fieldMask != null) 'fieldMask': [fieldMask],
if (filter != null) 'filter': [filter],
if (orderBy != null) 'orderBy': [orderBy],
if (pageSize != null) 'pageSize': ['${pageSize}'],
if (pageToken != null) 'pageToken': [pageToken],
if (readTime != null) 'readTime': [readTime],
if ($fields != null) 'fields': [$fields],
};
final url_ = 'v1/' + core.Uri.encodeFull('$parent') + '/assets';
final response_ = await _requester.request(
url_,
'GET',
queryParams: queryParams_,
);
return ListAssetsResponse.fromJson(
response_ as core.Map<core.String, core.dynamic>);
}