Class SearchAllResourcesRequest (3.3.0)

Version 3.3.0

• 3.28.0 (latest)
• 3.27.1
• 3.26.4
• 3.25.1
• 3.24.3
• 3.23.0
• 3.22.0
• 3.21.0
• 3.20.1
• 3.19.1
• 3.18.1
• 3.17.1
• 3.16.0
• 3.15.0
• 3.14.2
• 3.13.1
• 3.12.0
• 3.11.0
• 3.10.0
• 3.9.1
• 3.8.1
• 3.7.1
• 3.6.1
• 3.5.0
• 3.4.0
• 3.3.0
• 3.2.1
• 3.1.0
• 2.2.2
• 2.1.0
• 2.0.0
• 1.3.2
• 1.2.0
• 1.1.0
• 1.0.0
• 0.10.0
• 0.9.0
• 0.8.0
• 0.7.0
• 0.6.0
• 0.5.0
• 0.4.1
• 0.3.0

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

Name	Description
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.
read_mask	google.protobuf.field_mask_pb2.FieldMask Optional. A comma-separated list of fields specifying which fields to be returned in ResourceSearchResult. Only '*' or combination of top level fields can be specified. Field names of both snake_case and camelCase are supported. Examples: "*", "name,location", "name,versionedResources". The read_mask paths must be valid field paths listed but not limited to (both snake_case and camelCase are supported): - name - assetType - project - displayName - description - location - labels - networkTags - kmsKey - createTime - updateTime - state - additionalAttributes - versionedResources If read_mask is not specified, all fields except versionedResources will be returned. If only '*' is specified, all fields including versionedResources will be returned. Any invalid field path will trigger INVALID_ARGUMENT error.