list method
List all attributes.
Request parameters:
parent
- Required. The parent resource for Attribute. Format:
projects/{project}/locations/{location}
Value must have pattern ^projects/\[^/\]+/locations/\[^/\]+$
.
filter
- Optional. An expression that filters the list of Attributes. A
filter expression consists of a field name, a comparison operator, and a
value for filtering. The value must be a string or a boolean. The
comparison operator must be one of: <
, >
or =
. Filters are not case
sensitive. The following fields in the Attribute
are eligible for
filtering: * display_name
- The display name of the Attribute. Allowed
comparison operators: =
. * definition_type
- The definition type of
the attribute. Allowed comparison operators: =
. * scope
- The scope of
the attribute. Allowed comparison operators: =
. * data_type
- The type
of the data of the attribute. Allowed comparison operators: =
. *
mandatory
- Denotes whether the attribute is mandatory or not. Allowed
comparison operators: =
. * create_time
- The time at which the
Attribute was created. The value should be in the
(RFC3339)[https://tools.ietf.org/html/rfc3339] format. Allowed
comparison operators: >
and <
. Expressions are combined with either
AND
logic operator or OR
logical operator but not both of them
together i.e. only one of the AND
or OR
operator can be used
throughout the filter string and both the operators cannot be used
together. No other logical operators are supported. At most three filter
fields are allowed in the filter string and if provided more than that
then INVALID_ARGUMENT
error is returned by the API. Here are a few
examples: * display_name = production
- - The display name of the
attribute is production. * (display_name = production) AND (create_time < \"2021-08-15T14:50:00Z\") AND (create_time > \"2021-08-10T12:00:00Z\")
- The display name of the attribute is production and the attribute was
created before 2021-08-15 14:50:00 UTC and after 2021-08-10 12:00:00
UTC. *
display_name = production OR scope = api
- The attribute where the display name is production or the scope is api.
pageSize
- Optional. The maximum number of attribute resources to
return. The service may return fewer than this value. If unspecified, at
most 50 attributes will be returned. The maximum value is 1000; values
above 1000 will be coerced to 1000.
pageToken
- Optional. A page token, received from a previous
ListAttributes
call. Provide this to retrieve the subsequent page. When
paginating, all other parameters provided to ListAttributes
must match
the call that provided the page token.
$fields
- Selector specifying which fields to include in a partial
response.
Completes with a GoogleCloudApihubV1ListAttributesResponse.
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<GoogleCloudApihubV1ListAttributesResponse> 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') + '/attributes';
final response_ = await _requester.request(
url_,
'GET',
queryParams: queryParams_,
);
return GoogleCloudApihubV1ListAttributesResponse.fromJson(
response_ as core.Map<core.String, core.dynamic>,
);
}