Reference documentation and code samples for the Google Cloud Security Command Center V2 Client class GroupFindingsRequest.
Request message for grouping by findings.
Generated from protobuf message google.cloud.securitycenter.v2.GroupFindingsRequest
Namespace
Google \ Cloud \ SecurityCenter \ V2
Methods
__construct
Constructor.
Parameters
Name
Description
data
array
Optional. Data for populating the Message object.
↳ parent
string
Required. Name of the source to groupBy. If no location is specified, finding is assumed to be in global. The following list shows some examples: + organizations/[organization_id]/sources/[source_id] + organizations/[organization_id]/sources/[source_id]/locations/[location_id] + folders/[folder_id]/sources/[source_id] + folders/[folder_id]/sources/[source_id]/locations/[location_id] + projects/[project_id]/sources/[source_id] + projects/[project_id]/sources/[source_id]/locations/[location_id] To groupBy across all sources provide a source_id of -. The following list shows some examples: + organizations/{organization_id}/sources/- + organizations/{organization_id}/sources/-/locations/[location_id] + folders/{folder_id}/sources/- + folders/{folder_id}/sources/-/locations/[location_id] + projects/{project_id}/sources/- + projects/{project_id}/sources/-/locations/[location_id]
↳ 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 <field> <operator> <value> and may have a - character in front of them to indicate negation. Examples include: * * name * * 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: =, : * * security_marks.marks: =, : * * resource: * * resource.name: =, : * * resource.parent_name: =, : * * resource.parent_display_name: =, : * * resource.project_name: =, : * * resource.project_display_name: =, : * * resource.type: =, :
↳ group_by
string
Required. Expression that defines what assets fields to use for grouping. The string value should follow SQL syntax: comma separated list of fields. For example: "parent,resource_name".
↳ 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.
↳ page_size
int
The maximum number of results to return in a single response. Default is 10, minimum is 1, maximum is 1000.
getParent
Required. Name of the source to groupBy. If no location is specified,
finding is assumed to be in global.
projects/[project_id]/sources/[source_id]/locations/[location_id]
To groupBy across all sources provide a source_id of -. The following
list shows some examples:
projects/[project_id]/sources/[source_id]/locations/[location_id]
To groupBy across all sources provide a source_id of -. The following
list shows some examples:
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
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: =, :
security_marks.marks: =, :
resource:
resource.name: =, :
resource.parent_name: =, :
resource.parent_display_name: =, :
resource.project_name: =, :
resource.project_display_name: =, :
resource.type: =, :
Returns
Type
Description
string
setFilter
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
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: =, :
security_marks.marks: =, :
resource:
resource.name: =, :
resource.parent_name: =, :
resource.parent_display_name: =, :
resource.project_name: =, :
resource.project_display_name: =, :
resource.type: =, :
Parameter
Name
Description
var
string
Returns
Type
Description
$this
getGroupBy
Required. Expression that defines what assets fields to use for grouping.
The string value should follow SQL syntax: comma separated list of fields.
For example: "parent,resource_name".
Returns
Type
Description
string
setGroupBy
Required. Expression that defines what assets fields to use for grouping.
The string value should follow SQL syntax: comma separated list of fields.
For example: "parent,resource_name".
Parameter
Name
Description
var
string
Returns
Type
Description
$this
getPageToken
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.
Returns
Type
Description
string
setPageToken
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.
Parameter
Name
Description
var
string
Returns
Type
Description
$this
getPageSize
The maximum number of results to return in a single response. Default is
10, minimum is 1, maximum is 1000.
Returns
Type
Description
int
setPageSize
The maximum number of results to return in a single response. Default is
10, minimum is 1, maximum is 1000.
Parameter
Name
Description
var
int
Returns
Type
Description
$this
static::build
Parameters
Name
Description
parent
string
Required. Name of the source to groupBy. If no location is specified,
finding is assumed to be in global.
The following list shows some examples:
projects/{project_id}/sources/-/locations/[location_id]
Please see SecurityCenterClient::sourceName() for help formatting this field.
groupBy
string
Required. Expression that defines what assets fields to use for grouping.
The string value should follow SQL syntax: comma separated list of fields.
For example: "parent,resource_name".
[[["Easy to understand","easyToUnderstand","thumb-up"],["Solved my problem","solvedMyProblem","thumb-up"],["Other","otherUp","thumb-up"]],[["Hard to understand","hardToUnderstand","thumb-down"],["Incorrect information or sample code","incorrectInformationOrSampleCode","thumb-down"],["Missing the information/samples I need","missingTheInformationSamplesINeed","thumb-down"],["Other","otherDown","thumb-down"]],["Last updated 2025-09-04 UTC."],[],[],null,["# Google Cloud Security Command Center V2 Client - Class GroupFindingsRequest (2.2.1)\n\nVersion latestkeyboard_arrow_down\n\n- [2.2.1 (latest)](/php/docs/reference/cloud-security-center/latest/V2.GroupFindingsRequest)\n- [2.2.0](/php/docs/reference/cloud-security-center/2.2.0/V2.GroupFindingsRequest)\n- [2.1.1](/php/docs/reference/cloud-security-center/2.1.1/V2.GroupFindingsRequest)\n- [2.0.4](/php/docs/reference/cloud-security-center/2.0.4/V2.GroupFindingsRequest)\n- [1.32.0](/php/docs/reference/cloud-security-center/1.32.0/V2.GroupFindingsRequest)\n- [1.31.0](/php/docs/reference/cloud-security-center/1.31.0/V2.GroupFindingsRequest)\n- [1.30.0](/php/docs/reference/cloud-security-center/1.30.0/V2.GroupFindingsRequest)\n- [1.29.0](/php/docs/reference/cloud-security-center/1.29.0/V2.GroupFindingsRequest)\n- [1.28.2](/php/docs/reference/cloud-security-center/1.28.2/V2.GroupFindingsRequest)\n- [1.21.0](/php/docs/reference/cloud-security-center/1.21.0/V2.GroupFindingsRequest)\n- [1.20.2](/php/docs/reference/cloud-security-center/1.20.2/V2.GroupFindingsRequest)\n- [1.19.1](/php/docs/reference/cloud-security-center/1.19.1/V2.GroupFindingsRequest)\n- [1.18.0](/php/docs/reference/cloud-security-center/1.18.0/V2.GroupFindingsRequest)\n- [1.17.0](/php/docs/reference/cloud-security-center/1.17.0/V2.GroupFindingsRequest)\n- [1.16.0](/php/docs/reference/cloud-security-center/1.16.0/V2.GroupFindingsRequest)\n- [1.15.1](/php/docs/reference/cloud-security-center/1.15.1/V2.GroupFindingsRequest)\n- [1.14.2](/php/docs/reference/cloud-security-center/1.14.2/V2.GroupFindingsRequest)\n- [1.13.1](/php/docs/reference/cloud-security-center/1.13.1/V2.GroupFindingsRequest) \nReference documentation and code samples for the Google Cloud Security Command Center V2 Client class GroupFindingsRequest.\n\nRequest message for grouping by findings.\n\nGenerated from protobuf message `google.cloud.securitycenter.v2.GroupFindingsRequest`\n\nNamespace\n---------\n\nGoogle \\\\ Cloud \\\\ SecurityCenter \\\\ V2\n\nMethods\n-------\n\n### __construct\n\nConstructor.\n\n### getParent\n\nRequired. Name of the source to groupBy. If no location is specified,\nfinding is assumed to be in global.\n\nThe following list shows some examples:\n\n- `organizations/[organization_id]/sources/[source_id]` + `organizations/[organization_id]/sources/[source_id]/locations/[location_id]`\n- `folders/[folder_id]/sources/[source_id]`\n- `folders/[folder_id]/sources/[source_id]/locations/[location_id]`\n- `projects/[project_id]/sources/[source_id]`\n- `projects/[project_id]/sources/[source_id]/locations/[location_id]` To groupBy across all sources provide a source_id of `-`. The following list shows some examples:\n- `organizations/{organization_id}/sources/-`\n- `organizations/{organization_id}/sources/-/locations/[location_id]`\n- `folders/{folder_id}/sources/-`\n- `folders/{folder_id}/sources/-/locations/[location_id]`\n- `projects/{project_id}/sources/-`\n- `projects/{project_id}/sources/-/locations/[location_id]`\n\n### setParent\n\nRequired. Name of the source to groupBy. If no location is specified,\nfinding is assumed to be in global.\n\nThe following list shows some examples:\n\n- `organizations/[organization_id]/sources/[source_id]` + `organizations/[organization_id]/sources/[source_id]/locations/[location_id]`\n- `folders/[folder_id]/sources/[source_id]`\n- `folders/[folder_id]/sources/[source_id]/locations/[location_id]`\n- `projects/[project_id]/sources/[source_id]`\n- `projects/[project_id]/sources/[source_id]/locations/[location_id]` To groupBy across all sources provide a source_id of `-`. The following list shows some examples:\n- `organizations/{organization_id}/sources/-`\n- `organizations/{organization_id}/sources/-/locations/[location_id]`\n- `folders/{folder_id}/sources/-`\n- `folders/{folder_id}/sources/-/locations/[location_id]`\n- `projects/{project_id}/sources/-`\n- `projects/{project_id}/sources/-/locations/[location_id]`\n\n### getFilter\n\nExpression that defines the filter to apply across findings.\n\nThe expression is a list of one or more restrictions combined via logical\noperators `AND` and `OR`.\nParentheses are supported, and `OR` has higher precedence than `AND`.\nRestrictions have the form `\u003cfield\u003e \u003coperator\u003e \u003cvalue\u003e` and may have a `-`\ncharacter in front of them to indicate negation. Examples include:\n\n- name\n- security_marks.marks.marka The supported operators are:\n - `=` for all value types.\n - `\u003e`, `\u003c`, `\u003e=`, `\u003c=` for integer values.\n - `:`, meaning substring matching, for strings. The supported value types are:\n - string literals in quotes.\n - integer literals without quotes.\n - boolean literals `true` and `false` without quotes. The following field and operator combinations are supported:\n - name: `=`\n - parent: `=`, `:`\n - resource_name: `=`, `:`\n - state: `=`, `:`\n - category: `=`, `:`\n - external_uri: `=`, `:`\n - event_time: `=`, `\u003e`, `\u003c`, `\u003e=`, `\u003c=` Usage: This should be milliseconds since epoch or an RFC3339 string. Examples: `event_time = \"2019-06-10T16:07:18-07:00\"` `event_time = 1560208038000`\n - severity: `=`, `:`\n - security_marks.marks: `=`, `:`\n - resource:\n - resource.name: `=`, `:`\n - resource.parent_name: `=`, `:`\n - resource.parent_display_name: `=`, `:`\n - resource.project_name: `=`, `:`\n - resource.project_display_name: `=`, `:`\n - resource.type: `=`, `:`\n\n### setFilter\n\nExpression that defines the filter to apply across findings.\n\nThe expression is a list of one or more restrictions combined via logical\noperators `AND` and `OR`.\nParentheses are supported, and `OR` has higher precedence than `AND`.\nRestrictions have the form `\u003cfield\u003e \u003coperator\u003e \u003cvalue\u003e` and may have a `-`\ncharacter in front of them to indicate negation. Examples include:\n\n- name\n- security_marks.marks.marka The supported operators are:\n - `=` for all value types.\n - `\u003e`, `\u003c`, `\u003e=`, `\u003c=` for integer values.\n - `:`, meaning substring matching, for strings. The supported value types are:\n - string literals in quotes.\n - integer literals without quotes.\n - boolean literals `true` and `false` without quotes. The following field and operator combinations are supported:\n - name: `=`\n - parent: `=`, `:`\n - resource_name: `=`, `:`\n - state: `=`, `:`\n - category: `=`, `:`\n - external_uri: `=`, `:`\n - event_time: `=`, `\u003e`, `\u003c`, `\u003e=`, `\u003c=` Usage: This should be milliseconds since epoch or an RFC3339 string. Examples: `event_time = \"2019-06-10T16:07:18-07:00\"` `event_time = 1560208038000`\n - severity: `=`, `:`\n - security_marks.marks: `=`, `:`\n - resource:\n - resource.name: `=`, `:`\n - resource.parent_name: `=`, `:`\n - resource.parent_display_name: `=`, `:`\n - resource.project_name: `=`, `:`\n - resource.project_display_name: `=`, `:`\n - resource.type: `=`, `:`\n\n### getGroupBy\n\nRequired. Expression that defines what assets fields to use for grouping.\n\nThe string value should follow SQL syntax: comma separated list of fields.\nFor example: \"parent,resource_name\".\n\n### setGroupBy\n\nRequired. Expression that defines what assets fields to use for grouping.\n\nThe string value should follow SQL syntax: comma separated list of fields.\nFor example: \"parent,resource_name\".\n\n### getPageToken\n\nThe value returned by the last `GroupFindingsResponse`; indicates\nthat this is a continuation of a prior `GroupFindings` call, and\nthat the system should return the next page of data.\n\n### setPageToken\n\nThe value returned by the last `GroupFindingsResponse`; indicates\nthat this is a continuation of a prior `GroupFindings` call, and\nthat the system should return the next page of data.\n\n### getPageSize\n\nThe maximum number of results to return in a single response. Default is\n10, minimum is 1, maximum is 1000.\n\n### setPageSize\n\nThe maximum number of results to return in a single response. Default is\n10, minimum is 1, maximum is 1000.\n\n### static::build"]]
