Class SearchAllResourcesRequest (3.15.0)

SearchAllResourcesRequest(mapping=None, *, ignore_unknown_fields=False, **kwargs)

Search all resources request.

Attributes

NameDescription
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 caller must be granted the ``cloudasset.assets.searchAllResources __ 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")
query str
Optional. The query statement. See `how to construct a query
asset_types MutableSequence[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 - createTime - updateTime - state - parentFullResourceName - parentAssetType All the other fields such as repeated fields (e.g., networkTags, kmsKeys), 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 - tagKeys - tagValues - tagValueIds - labels - networkTags - kmsKey (This field is deprecated. Please use the kmsKeys field to retrieve KMS key information.) - kmsKeys - 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.