Class: Google::Apis::SecuritycenterV1::GroupFindingsRequest

Inherits:

Object

• Object
• Google::Apis::SecuritycenterV1::GroupFindingsRequest

Includes:

Core::Hashable, Core::JsonObjectSupport

Defined in:

lib/google/apis/securitycenter_v1/classes.rb,
lib/google/apis/securitycenter_v1/representations.rb,
lib/google/apis/securitycenter_v1/representations.rb

Overview

Request message for grouping by findings.

Instance Attribute Summary

• #compare_duration ⇒ 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.

• #filter ⇒ String

  Expression that defines the filter to apply across findings.

• #group_by ⇒ String

  Required.

• #page_size ⇒ Fixnum

  The maximum number of results to return in a single response.

• #page_token ⇒ 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.

• #read_time ⇒ String

  Time used as a reference point when filtering findings.

Instance Method Summary

• #initialize(**args) ⇒ GroupFindingsRequest constructor

  A new instance of GroupFindingsRequest.

• #update!(**args) ⇒ Object

  Update properties of this object.

Constructor Details

#initialize(**args) ⇒ GroupFindingsRequest

Returns a new instance of GroupFindingsRequest.

# File 'lib/google/apis/securitycenter_v1/classes.rb', line 1730

def initialize(**args)
   update!(**args)
end

Instance Attribute Details

#compare_duration ⇒ 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 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 in group_by. Corresponds to the JSON property compareDuration

Returns:

• (String)

# File 'lib/google/apis/securitycenter_v1/classes.rb', line 1671

def compare_duration
  @compare_duration
end

#filter ⇒ 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 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. 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: =, : Corresponds to the JSON property filter

Returns:

• (String)

# File 'lib/google/apis/securitycenter_v1/classes.rb', line 1698

def filter
  @filter
end

#group_by ⇒ 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 Corresponds to the JSON property groupBy

Returns:

• (String)

# File 'lib/google/apis/securitycenter_v1/classes.rb', line 1708

def group_by
  @group_by
end

#page_size ⇒ Fixnum

The maximum number of results to return in a single response. Default is 10, minimum is 1, maximum is 1000. Corresponds to the JSON property pageSize

Returns:

• (Fixnum)

# File 'lib/google/apis/securitycenter_v1/classes.rb', line 1714

def page_size
  @page_size
end

#page_token ⇒ 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. Corresponds to the JSON property pageToken

Returns:

• (String)

# File 'lib/google/apis/securitycenter_v1/classes.rb', line 1721

def page_token
  @page_token
end

#read_time ⇒ 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. Corresponds to the JSON property readTime

Returns:

• (String)

# File 'lib/google/apis/securitycenter_v1/classes.rb', line 1728

def read_time
  @read_time
end

Instance Method Details

#update!(**args) ⇒ Object

Update properties of this object

# File 'lib/google/apis/securitycenter_v1/classes.rb', line 1735

def update!(**args)
  @compare_duration = args[:compare_duration] if args.key?(:compare_duration)
  @filter = args[:filter] if args.key?(:filter)
  @group_by = args[:group_by] if args.key?(:group_by)
  @page_size = args[:page_size] if args.key?(:page_size)
  @page_token = args[:page_token] if args.key?(:page_token)
  @read_time = args[:read_time] if args.key?(:read_time)
end