Class SearchAllResourcesRequest (3.1.0)

Stay organized with collections Save and categorize content based on your preferences.
SearchAllResourcesRequest(mapping=None, *, ignore_unknown_fields=False, **kwargs)

Search all resources request. .. attribute:: scope

Required. A scope can be a project, a folder, or an organization. The search is limited to the resources within the scope. The caller must be granted the `cloudasset.assets.searchAllResources https://cloud.google.com/asset-inventory/docs/access-control#required_permissions`__ permission on the desired scope.

The allowed values are:

  • projects/{PROJECT_ID} (e.g., "projects/foo-bar")
  • projects/{PROJECT_NUMBER} (e.g., "projects/12345678")
  • folders/{FOLDER_NUMBER} (e.g., "folders/1234567")
  • organizations/{ORGANIZATION_NUMBER} (e.g., "organizations/123456")

    :type: str

Attributes

NameDescription
query str
Optional. The query statement. 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". Only singular primitive fields in the response are sortable: - name - assetType - project - displayName - description - location - kmsKey - createTime - updateTime - state - parentFullResourceName - parentAssetType All the other fields such as repeated fields (e.g., ``networkTags``), map fields (e.g., ``labels``) and struct fields (e.g., ``additionalAttributes``) are not supported.

Inheritance

builtins.object > proto.message.Message > SearchAllResourcesRequest