[−][src]Struct google_securitycenter1::GroupFindingsRequest
Request message for grouping by findings.
Activities
This type is used in activities, which are methods you may call on this type or where this type is involved in. The list links the activity name, along with information about where it is used (one of request and response).
- sources findings group organizations (request)
Fields
filter: Option<String>
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 supported, and OR
has higher precedence than AND
.
Restrictions have the form <field> <operator> <value>
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
andfalse
without quotes.
The following field and operator combinations are supported:
- name:
=
- parent:
=
,:
- resource_name:
=
,:
- state:
=
,:
- category:
=
,:
- external_uri:
=
,:
- event_time:
>
,<
,>=
,<=
- security_marks:
=
,:
- source_properties:
=
,:
,>
,<
,>=
,<=
For example, source_properties.size = 100
is a valid filter string.
page_token: Option<String>
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.
compare_duration: Option<String>
When compare_duration is set, the GroupResult's "state_change" attribute is updated to indicate whether the finding had its state changed, the finding's state remained unchanged, or if the finding was added during the compare_duration period of time that precedes the read_time. This is the time between (read_time - compare_duration) and read_time.
The state_change value is derived based on the presence and state of the finding at the two points in time. Intermediate state changes between the two times don't affect the result. For example, the results aren't affected if the finding is made inactive and then active again.
Possible "state_change" values when compare_duration is specified:
- "CHANGED": indicates that the finding was present at the start of compare_duration, but changed its state at read_time.
- "UNCHANGED": indicates that the finding was present at the start of compare_duration and did not change state at read_time.
- "ADDED": indicates that the finding was not present at the start of compare_duration, but was present at read_time.
If compare_duration is not specified, then the only possible state_change is "UNUSED", which will be the state_change set for all findings present at read_time.
If this field is set then state_change
must be a specified field in
group_by
.
page_size: Option<i32>
The maximum number of results to return in a single response. Default is 10, minimum is 1, maximum is 1000.
group_by: Option<String>
Expression that defines what assets fields to use for grouping (including
state_change
). 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
The following fields are supported when compare_duration is set:
- state_change
read_time: Option<String>
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.
Trait Implementations
impl RequestValue for GroupFindingsRequest
[src]
impl Default for GroupFindingsRequest
[src]
fn default() -> GroupFindingsRequest
[src]
impl Clone for GroupFindingsRequest
[src]
fn clone(&self) -> GroupFindingsRequest
[src]
fn clone_from(&mut self, source: &Self)
1.0.0[src]
Performs copy-assignment from source
. Read more
impl Debug for GroupFindingsRequest
[src]
impl Serialize for GroupFindingsRequest
[src]
fn serialize<__S>(&self, __serializer: __S) -> Result<__S::Ok, __S::Error> where
__S: Serializer,
[src]
__S: Serializer,
impl<'de> Deserialize<'de> for GroupFindingsRequest
[src]
fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error> where
__D: Deserializer<'de>,
[src]
__D: Deserializer<'de>,
Auto Trait Implementations
impl Send for GroupFindingsRequest
impl Unpin for GroupFindingsRequest
impl Sync for GroupFindingsRequest
impl UnwindSafe for GroupFindingsRequest
impl RefUnwindSafe for GroupFindingsRequest
Blanket Implementations
impl<T> ToOwned for T where
T: Clone,
[src]
T: Clone,
type Owned = T
The resulting type after obtaining ownership.
fn to_owned(&self) -> T
[src]
fn clone_into(&self, target: &mut T)
[src]
impl<T> From<T> for T
[src]
impl<T, U> Into<U> for T where
U: From<T>,
[src]
U: From<T>,
impl<T, U> TryFrom<U> for T where
U: Into<T>,
[src]
U: Into<T>,
type Error = Infallible
The type returned in the event of a conversion error.
fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>
[src]
impl<T, U> TryInto<U> for T where
U: TryFrom<T>,
[src]
U: TryFrom<T>,
type Error = <U as TryFrom<T>>::Error
The type returned in the event of a conversion error.
fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>
[src]
impl<T> BorrowMut<T> for T where
T: ?Sized,
[src]
T: ?Sized,
fn borrow_mut(&mut self) -> &mut T
[src]
impl<T> Borrow<T> for T where
T: ?Sized,
[src]
T: ?Sized,
impl<T> Any for T where
T: 'static + ?Sized,
[src]
T: 'static + ?Sized,
impl<T> Typeable for T where
T: Any,
T: Any,
impl<T> DeserializeOwned for T where
T: Deserialize<'de>,
[src]
T: Deserialize<'de>,