SearchAllResourcesRequest(mapping=None, *, ignore_unknown_fields=False, **kwargs)Search all resources request.
Attributes
| Name | Description |
scope |
str
Required. A scope can be a project, a folder or an organization. The search is limited to the resources within the scope.
The allowed values are:
- projects/{PROJECT_ID}
- projects/{PROJECT_NUMBER}
- folders/{FOLDER_NUMBER}
- organizations/{ORGANIZATION_NUMBER}
|
query |
str
Optional. The query statement. An empty query can be specified to search all the resources of certain asset_types within the given scope.
Examples:
- name : "Important" to find Cloud resources whose name
contains "Important" as a word.
- displayName : "Impor*" to find Cloud resources whose
display name contains "Impor" as a word prefix.
- description : "*por*" to find Cloud resources whose
description contains "por" as a substring.
- location : "us-west*" to find Cloud resources whose
location is prefixed with "us-west".
- labels : "prod" to find Cloud resources whose labels
contain "prod" as a key or value.
- labels.env : "prod" to find Cloud resources which
have a label "env" and its value is "prod".
- labels.env : * to find Cloud resources which have a
label "env".
- "Important" to find Cloud resources which contain
"Important" as a word in any of the searchable fields.
- "Impor*" to find Cloud resources which contain
"Impor" as a word prefix in any of the searchable fields.
- "*por*" to find Cloud resources which contain "por"
as a substring in any of the searchable fields.
- ("Important" AND location : ("us-west1" OR "global"))
to find Cloud resources which contain "Important" as a
word in any of the searchable fields and are also located
in the "us-west1" region or the "global" location.
See `how to construct a
query |
asset_types |
Sequence[str]
Optional. A list of asset types that this request searches for. If empty, it will search all the `searchable asset types |
page_size |
int
Optional. The page size for search result pagination. Page size is capped at 500 even if a larger value is given. If set to zero, server will pick an appropriate default. Returned results may be fewer than requested. When this happens, there could be more results as long as next_page_token is returned.
|
page_token |
str
Optional. If present, then retrieve the next batch of results from the preceding call to this method. page_token must be the value of next_page_token from
the previous response. The values of all other method
parameters, must be identical to those in the previous call.
|
order_by |
str
Optional. A comma separated list of fields specifying the sorting order of the results. The default order is ascending. Add " DESC" after the field name to indicate descending order. Redundant space characters are ignored. Example: "location DESC, name". See `supported resource metadata fields |