Class: Google::Apis::SecuritycenterV1beta1::GroupFindingsRequest

Inherits:
Object
  • Object
show all
Includes:
Core::Hashable, Core::JsonObjectSupport
Defined in:
generated/google/apis/securitycenter_v1beta1/classes.rb,
generated/google/apis/securitycenter_v1beta1/representations.rb,
generated/google/apis/securitycenter_v1beta1/representations.rb

Overview

Request message for grouping by findings.

Instance Attribute Summary collapse

Instance Method Summary collapse

Methods included from Core::JsonObjectSupport

#to_json

Methods included from Core::Hashable

process_value, #to_h

Constructor Details

#initialize(**args) ⇒ GroupFindingsRequest

Returns a new instance of GroupFindingsRequest.



1366
1367
1368
# File 'generated/google/apis/securitycenter_v1beta1/classes.rb', line 1366

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

Instance Attribute Details

#filterString

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 <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 and false without quotes. For example, source_properties.size = 100 is a valid filter string. Corresponds to the JSON property filter

Returns:

  • (String)


1329
1330
1331
# File 'generated/google/apis/securitycenter_v1beta1/classes.rb', line 1329

def filter
  @filter
end

#group_byString

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

Returns:

  • (String)


1343
1344
1345
# File 'generated/google/apis/securitycenter_v1beta1/classes.rb', line 1343

def group_by
  @group_by
end

#page_sizeFixnum

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)


1349
1350
1351
# File 'generated/google/apis/securitycenter_v1beta1/classes.rb', line 1349

def page_size
  @page_size
end

#page_tokenString

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)


1356
1357
1358
# File 'generated/google/apis/securitycenter_v1beta1/classes.rb', line 1356

def page_token
  @page_token
end

#read_timeString

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)


1364
1365
1366
# File 'generated/google/apis/securitycenter_v1beta1/classes.rb', line 1364

def read_time
  @read_time
end

Instance Method Details

#update!(**args) ⇒ Object

Update properties of this object



1371
1372
1373
1374
1375
1376
1377
# File 'generated/google/apis/securitycenter_v1beta1/classes.rb', line 1371

def update!(**args)
  @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