GroupFindingsRequest(mapping=None, *, ignore_unknown_fields=False, **kwargs)
Request message for grouping by findings.
Attributes | |
---|---|
Name | Description |
parent |
str
Required. Name of the source to groupBy. Its format is "organizations/[organization_id]/sources/[source_id]". To groupBy across all sources provide a source_id of - . For
example: organizations/{organization_id}/sources/-
|
filter |
str
Expression that defines the filter to apply across findings. The expression is a list of one or more restrictions combined via logical operators AND and OR .
Parentheses are not supported, and OR has higher
precedence than AND .
Restrictions have the form
and may have a - character in front of them to indicate
negation. Examples include:
- name
- source_properties.a_property
- security_marks.marks.marka
The supported operators are:
- = for all value types.
- > , , >= , <> for integer values.
- : , meaning substring matching, for strings.
The supported value types are:
- string literals in quotes.
- integer literals without quotes.
- boolean literals true and false without quotes.
For example, source_properties.size = 100 is a valid
filter string.
|
group_by |
str
Required. Expression that defines what assets fields to use for grouping (including state ). The string value should
follow SQL syntax: comma separated list of fields. For
example: "parent,resource_name".
The following fields are supported:
- resource_name
- category
- state
- parent
|
read_time |
google.protobuf.timestamp_pb2.Timestamp
Time used as a reference point when filtering findings. The filter is limited to findings existing at the supplied time and their values are those at that specific time. Absence of this field will default to the API's version of NOW. |
page_token |
str
The value returned by the last GroupFindingsResponse ;
indicates that this is a continuation of a prior
GroupFindings call, and that the system should return
the next page of data.
|
page_size |
int
The maximum number of results to return in a single response. Default is 10, minimum is 1, maximum is 1000. |