Reference documentation and code samples for the Cloud Security Command Center V1 API class Google::Cloud::SecurityCenter::V1::GroupFindingsRequest.
Request message for grouping by findings.
Inherits
- Object
Extended By
- Google::Protobuf::MessageExts::ClassMethods
Includes
- Google::Protobuf::MessageExts
Methods
#compare_duration
def compare_duration() -> ::Google::Protobuf::Duration
-
(::Google::Protobuf::Duration) — 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 and matched the given filter at the start of compare_duration, but changed its state at read_time.
- "UNCHANGED": indicates that the finding was present and matched the given filter at the start of compare_duration and did not change state at read_time.
- "ADDED": indicates that the finding did not match the given filter or was not present at the start of compare_duration, but was present at read_time.
- "REMOVED": indicates that the finding was present and matched the filter at the start of compare_duration, but did not match the filter 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 ingroup_by
.
#compare_duration=
def compare_duration=(value) -> ::Google::Protobuf::Duration
-
value (::Google::Protobuf::Duration) — 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 and matched the given filter at the start of compare_duration, but changed its state at read_time.
- "UNCHANGED": indicates that the finding was present and matched the given filter at the start of compare_duration and did not change state at read_time.
- "ADDED": indicates that the finding did not match the given filter or was not present at the start of compare_duration, but was present at read_time.
- "REMOVED": indicates that the finding was present and matched the filter at the start of compare_duration, but did not match the filter 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 ingroup_by
.
-
(::Google::Protobuf::Duration) — 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 and matched the given filter at the start of compare_duration, but changed its state at read_time.
- "UNCHANGED": indicates that the finding was present and matched the given filter at the start of compare_duration and did not change state at read_time.
- "ADDED": indicates that the finding did not match the given filter or was not present at the start of compare_duration, but was present at read_time.
- "REMOVED": indicates that the finding was present and matched the filter at the start of compare_duration, but did not match the filter 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 ingroup_by
.
#filter
def filter() -> ::String
-
(::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
andOR
. Parentheses are supported, andOR
has higher precedence thanAND
.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:
=
,>
,<
,>=
,<=
Usage: This should be milliseconds since epoch or an RFC3339 string. Examples:
event_time = "2019-06-10T16:07:18-07:00"
event_time = 1560208038000
- severity:
=
,:
- workflow_state:
=
,:
- security_marks.marks:
=
,:
- source_properties:
=
,:
,>
,<
,>=
,<=
For example,
source_properties.size = 100
is a valid filter string.Use a partial match on the empty string to filter based on a property existing:
source_properties.my_property : ""
Use a negated partial match on the empty string to filter based on a property not existing:
-source_properties.my_property : ""
- resource:
- resource.name:
=
,:
- resource.parent_name:
=
,:
- resource.parent_display_name:
=
,:
- resource.project_name:
=
,:
- resource.project_display_name:
=
,:
- resource.type:
=
,:
- resource.name:
#filter=
def filter=(value) -> ::String
-
value (::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
andOR
. Parentheses are supported, andOR
has higher precedence thanAND
.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:
=
,>
,<
,>=
,<=
Usage: This should be milliseconds since epoch or an RFC3339 string. Examples:
event_time = "2019-06-10T16:07:18-07:00"
event_time = 1560208038000
- severity:
=
,:
- workflow_state:
=
,:
- security_marks.marks:
=
,:
- source_properties:
=
,:
,>
,<
,>=
,<=
For example,
source_properties.size = 100
is a valid filter string.Use a partial match on the empty string to filter based on a property existing:
source_properties.my_property : ""
Use a negated partial match on the empty string to filter based on a property not existing:
-source_properties.my_property : ""
- resource:
- resource.name:
=
,:
- resource.parent_name:
=
,:
- resource.parent_display_name:
=
,:
- resource.project_name:
=
,:
- resource.project_display_name:
=
,:
- resource.type:
=
,:
- resource.name:
-
(::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
andOR
. Parentheses are supported, andOR
has higher precedence thanAND
.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:
=
,>
,<
,>=
,<=
Usage: This should be milliseconds since epoch or an RFC3339 string. Examples:
event_time = "2019-06-10T16:07:18-07:00"
event_time = 1560208038000
- severity:
=
,:
- workflow_state:
=
,:
- security_marks.marks:
=
,:
- source_properties:
=
,:
,>
,<
,>=
,<=
For example,
source_properties.size = 100
is a valid filter string.Use a partial match on the empty string to filter based on a property existing:
source_properties.my_property : ""
Use a negated partial match on the empty string to filter based on a property not existing:
-source_properties.my_property : ""
- resource:
- resource.name:
=
,:
- resource.parent_name:
=
,:
- resource.parent_display_name:
=
,:
- resource.project_name:
=
,:
- resource.project_display_name:
=
,:
- resource.type:
=
,:
- resource.name:
#group_by
def group_by() -> ::String
-
(::String) —
Required. 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
- severity
The following fields are supported when compare_duration is set:
- state_change
#group_by=
def group_by=(value) -> ::String
-
value (::String) —
Required. 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
- severity
The following fields are supported when compare_duration is set:
- state_change
-
(::String) —
Required. 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
- severity
The following fields are supported when compare_duration is set:
- state_change
#page_size
def page_size() -> ::Integer
- (::Integer) — The maximum number of results to return in a single response. Default is 10, minimum is 1, maximum is 1000.
#page_size=
def page_size=(value) -> ::Integer
- value (::Integer) — The maximum number of results to return in a single response. Default is 10, minimum is 1, maximum is 1000.
- (::Integer) — The maximum number of results to return in a single response. Default is 10, minimum is 1, maximum is 1000.
#page_token
def page_token() -> ::String
-
(::String) — The value returned by the last
GroupFindingsResponse
; indicates that this is a continuation of a priorGroupFindings
call, and that the system should return the next page of data.
#page_token=
def page_token=(value) -> ::String
-
value (::String) — The value returned by the last
GroupFindingsResponse
; indicates that this is a continuation of a priorGroupFindings
call, and that the system should return the next page of data.
-
(::String) — The value returned by the last
GroupFindingsResponse
; indicates that this is a continuation of a priorGroupFindings
call, and that the system should return the next page of data.
#parent
def parent() -> ::String
-
(::String) — Required. Name of the source to groupBy. Its format is
"organizations/[organization_id]/sources/[source_id]",
folders/[folder_id]/sources/[source_id], or
projects/[project_id]/sources/[source_id]. To groupBy across all sources
provide a source_id of
-
. For example: organizations/{organization_id}/sources/-, folders/{folder_id}/sources/-, or projects/{project_id}/sources/-
#parent=
def parent=(value) -> ::String
-
value (::String) — Required. Name of the source to groupBy. Its format is
"organizations/[organization_id]/sources/[source_id]",
folders/[folder_id]/sources/[source_id], or
projects/[project_id]/sources/[source_id]. To groupBy across all sources
provide a source_id of
-
. For example: organizations/{organization_id}/sources/-, folders/{folder_id}/sources/-, or projects/{project_id}/sources/-
-
(::String) — Required. Name of the source to groupBy. Its format is
"organizations/[organization_id]/sources/[source_id]",
folders/[folder_id]/sources/[source_id], or
projects/[project_id]/sources/[source_id]. To groupBy across all sources
provide a source_id of
-
. For example: organizations/{organization_id}/sources/-, folders/{folder_id}/sources/-, or projects/{project_id}/sources/-
#read_time
def read_time() -> ::Google::Protobuf::Timestamp
- (::Google::Protobuf::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.
#read_time=
def read_time=(value) -> ::Google::Protobuf::Timestamp
- value (::Google::Protobuf::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.
- (::Google::Protobuf::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.