Reference documentation and code samples for the Google Cloud Security Command Center V2 Client class ListFindingsRequest.
Request message for listing findings.
Generated from protobuf message google.cloud.securitycenter.v2.ListFindingsRequest
Namespace
Google \ Cloud \ SecurityCenter \ V2Methods
__construct
Constructor.
Parameters | |
---|---|
Name | Description |
data |
array
Optional. Data for populating the Message object. |
↳ parent |
string
Required. Name of the source the findings belong to. If no location is specified, the default is global. The following list shows some examples: + |
↳ 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 |
↳ order_by |
string
Expression that defines what fields and order to use for sorting. The string value should follow SQL syntax: comma separated list of fields. For example: "name,parent". The default sorting order is ascending. To specify descending order for a field, a suffix " desc" should be appended to the field name. For example: "name desc,parent". Redundant space characters in the syntax are insignificant. "name desc,parent" and " name desc , parent " are equivalent. The following fields are supported: name parent state category resource_name event_time security_marks.marks |
↳ field_mask |
Google\Protobuf\FieldMask
A field mask to specify the Finding fields to be listed in the response. An empty field mask will list all fields. |
↳ page_token |
string
The value returned by the last |
↳ 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 the findings belong to. If no location is specified, the default is 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 list 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/{projects_id}/sources/-
projects/{projects_id}/sources/-/locations/{location_id}
Returns | |
---|---|
Type | Description |
string |
setParent
Required. Name of the source the findings belong to. If no location is specified, the default is 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 list 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/{projects_id}/sources/-
projects/{projects_id}/sources/-/locations/{location_id}
Parameter | |
---|---|
Name | Description |
var |
string
|
Returns | |
---|---|
Type | Description |
$this |
getFilter
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
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:
=
,:
- security_marks.marks:
=
,:
- resource:
- resource.name:
=
,:
- resource.parent_name:
=
,:
- resource.parent_display_name:
=
,:
- resource.project_name:
=
,:
- resource.project_display_name:
=
,:
- resource.type:
=
,:
- resource.folders.resource_folder:
=
,:
- resource.display_name:
=
,:
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
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:
=
,:
- security_marks.marks:
=
,:
- resource:
- resource.name:
=
,:
- resource.parent_name:
=
,:
- resource.parent_display_name:
=
,:
- resource.project_name:
=
,:
- resource.project_display_name:
=
,:
- resource.type:
=
,:
- resource.folders.resource_folder:
=
,:
- resource.display_name:
=
,:
Parameter | |
---|---|
Name | Description |
var |
string
|
Returns | |
---|---|
Type | Description |
$this |
getOrderBy
Expression that defines what fields and order to use for sorting. The string value should follow SQL syntax: comma separated list of fields. For example: "name,parent". The default sorting order is ascending. To specify descending order for a field, a suffix " desc" should be appended to the field name. For example: "name desc,parent". Redundant space characters in the syntax are insignificant. "name desc,parent" and " name desc , parent " are equivalent.
The following fields are supported: name parent state category resource_name event_time security_marks.marks
Returns | |
---|---|
Type | Description |
string |
setOrderBy
Expression that defines what fields and order to use for sorting. The string value should follow SQL syntax: comma separated list of fields. For example: "name,parent". The default sorting order is ascending. To specify descending order for a field, a suffix " desc" should be appended to the field name. For example: "name desc,parent". Redundant space characters in the syntax are insignificant. "name desc,parent" and " name desc , parent " are equivalent.
The following fields are supported: name parent state category resource_name event_time security_marks.marks
Parameter | |
---|---|
Name | Description |
var |
string
|
Returns | |
---|---|
Type | Description |
$this |
getFieldMask
A field mask to specify the Finding fields to be listed in the response.
An empty field mask will list all fields.
Returns | |
---|---|
Type | Description |
Google\Protobuf\FieldMask|null |
hasFieldMask
clearFieldMask
setFieldMask
A field mask to specify the Finding fields to be listed in the response.
An empty field mask will list all fields.
Parameter | |
---|---|
Name | Description |
var |
Google\Protobuf\FieldMask
|
Returns | |
---|---|
Type | Description |
$this |
getPageToken
The value returned by the last ListFindingsResponse
; indicates
that this is a continuation of a prior ListFindings
call, and
that the system should return the next page of data.
Returns | |
---|---|
Type | Description |
string |
setPageToken
The value returned by the last ListFindingsResponse
; indicates
that this is a continuation of a prior ListFindings
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
Parameter | |
---|---|
Name | Description |
parent |
string
Required. Name of the source the findings belong to. If no location is specified, the default is global. The following list shows some examples:
To list across all sources provide a source_id of
|
Returns | |
---|---|
Type | Description |
Google\Cloud\SecurityCenter\V2\ListFindingsRequest |