Documentation

Google_Service_SecurityCommandCenter_Resource_OrganizationsSourcesFindings extends Google_Service_Resource
in package

Application

The "findings" collection of methods.

Typical usage is: $securitycenterService = new Google_Service_SecurityCommandCenter(...); $findings = $securitycenterService->findings;

$client : Google_Client
$methods : array<string|int, mixed>
$resourceName : string
$rootUrl : string
$serviceName : string
$servicePath : string
$stackParameters : mixed
__construct() : mixed
call() : Google_Http_Request|expectedClass: TODO: This function needs simplifying.
create() : Google_Service_SecurityCommandCenter_Finding: Creates a finding. The corresponding source must exist for finding creation to succeed. (findings.create)
createRequestUri() : string: Parse/expand request parameters and create a fully qualified request uri.
group() : Google_Service_SecurityCommandCenter_GroupFindingsResponse: Filters an organization or source's findings and groups them by their specified properties. To group across all sources provide a `-` as the source id. Example: /v1/organizations/{organization_id}/sources/-/findings (findings.group)
listOrganizationsSourcesFindings() : Google_Service_SecurityCommandCenter_ListFindingsResponse: Lists an organization or source's findings. To list across all sources provide a `-` as the source id. Example: /v1/organizations/{organization_id}/sources/-/findings (findings.listOrganizationsSourcesFindings)
patch() : Google_Service_SecurityCommandCenter_Finding: Creates or updates a finding. The corresponding source must exist for a finding creation to succeed. (findings.patch)
setState() : Google_Service_SecurityCommandCenter_Finding: Updates the state of a finding. (findings.setState)
updateSecurityMarks() : Google_Service_SecurityCommandCenter_SecurityMarks: Updates security marks. (findings.updateSecurityMarks)
convertToArrayAndStripNulls() : mixed

$client


    private
        Google_Client
    $client

$methods


    private
        array<string|int, mixed>
    $methods

$resourceName


    private
        string
    $resourceName

$rootUrl


    private
        string
    $rootUrl

$serviceName


    private
        string
    $serviceName

$servicePath


    private
        string
    $servicePath

$stackParameters


    private
        mixed
    $stackParameters
     = array('alt' => array('type' => 'string', 'location' => 'query'), 'fields' => array('type' => 'string', 'location' => 'query'), 'trace' => array('type' => 'string', 'location' => 'query'), 'userIp' => array('type' => 'string', 'location' => 'query'), 'quotaUser' => array('type' => 'string', 'location' => 'query'), 'data' => array('type' => 'string', 'location' => 'body'), 'mimeType' => array('type' => 'string', 'location' => 'header'), 'uploadType' => array('type' => 'string', 'location' => 'query'), 'mediaUpload' => array('type' => 'complex', 'location' => 'query'), 'prettyPrint' => array('type' => 'string', 'location' => 'query'))

__construct()


    public
                __construct(mixed $service, mixed $serviceName, mixed $resourceName, mixed $resource) : mixed

Parameters

$service : mixed
$serviceName : mixed
$resourceName : mixed
$resource : mixed

Return values

mixed —

call()

TODO: This function needs simplifying.


    public
                call( $name,  $arguments[,  $expectedClass = null ]) : Google_Http_Request|expectedClass

Parameters

$name :

$arguments :

$expectedClass : = null

optional, the expected class name

Return values

Google_Http_Request|expectedClass —

create()

Creates a finding. The corresponding source must exist for finding creation to succeed. (findings.create)


    public
                create(string $parent, Google_Service_SecurityCommandCenter_Finding $postBody[, array<string|int, mixed> $optParams = array() ]) : Google_Service_SecurityCommandCenter_Finding

Parameters

$parent : string: Required. Resource name of the new finding's parent. Its format should be "organizations/[organization_id]/sources/[source_id]".
$postBody : Google_Service_SecurityCommandCenter_Finding
$optParams : array<string|int, mixed> = array(): Optional parameters.

Return values

Google_Service_SecurityCommandCenter_Finding —

createRequestUri()

Parse/expand request parameters and create a fully qualified request uri.


    public
                createRequestUri(string $restPath, array<string|int, mixed> $params) : string

Parameters

$restPath : string
$params : array<string|int, mixed>

Return values

string —

$requestUrl

group()

Filters an organization or source's findings and groups them by their specified properties. To group across all sources provide a `-` as the source id. Example: /v1/organizations/{organization_id}/sources/-/findings (findings.group)


    public
                group(string $parent, Google_Service_SecurityCommandCenter_GroupFindingsRequest $postBody[, array<string|int, mixed> $optParams = array() ]) : Google_Service_SecurityCommandCenter_GroupFindingsResponse

Parameters

$parent : string: Required. Name of the source to groupBy. Its format is "organizations/[organization_id]/sources/[source_id]". To groupBy across all sources provide a source_id of -. For example: organizations/{organization_id}/sources/-
$postBody : Google_Service_SecurityCommandCenter_GroupFindingsRequest
$optParams : array<string|int, mixed> = array(): Optional parameters.

Return values

Google_Service_SecurityCommandCenter_GroupFindingsResponse —

listOrganizationsSourcesFindings()

Lists an organization or source's findings. To list across all sources provide a `-` as the source id. Example: /v1/organizations/{organization_id}/sources/-/findings (findings.listOrganizationsSourcesFindings)


    public
                listOrganizationsSourcesFindings(string $parent[, array<string|int, mixed> $optParams = array() ]) : Google_Service_SecurityCommandCenter_ListFindingsResponse

Parameters

$parent : string: Required. Name of the source the findings belong to. Its format is "organizations/[organization_id]/sources/[source_id]". To list across all sources provide a source_id of -. For example: organizations/{organization_id}/sources/-
$optParams : array<string|int, mixed> = array(): Optional parameters.

Tags

opt_param

string fieldMask A field mask to specify the Finding fields to be listed in the response. An empty field mask will list all fields.

opt_param

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

opt_param

string compareDuration When compare_duration is set, the ListFindingsResult'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 in any state 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.

opt_param

string orderBy 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,resource_properties.a_property". 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,source_properties.a_property". Redundant space characters in the syntax are insignificant. "name desc,source_properties.a_property" and " name desc , source_properties.a_property " are equivalent. The following fields are supported: name parent state category resource_name event_time source_properties security_marks.marks

opt_param

string readTime 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.

opt_param

string pageToken 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.

opt_param

string filter 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 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 : ""

Return values

Google_Service_SecurityCommandCenter_ListFindingsResponse —

patch()

Creates or updates a finding. The corresponding source must exist for a finding creation to succeed. (findings.patch)


    public
                patch(string $name, Google_Service_SecurityCommandCenter_Finding $postBody[, array<string|int, mixed> $optParams = array() ]) : Google_Service_SecurityCommandCenter_Finding

Parameters

$name : string: The relative resource name of this finding. See: https://cloud.google.com/apis/design/resource_names#relative_resource_name Example: "organizations/{organization_id}/sources/{source_id}/findings/{finding_id}"
$postBody : Google_Service_SecurityCommandCenter_Finding
$optParams : array<string|int, mixed> = array(): Optional parameters.

Return values

Google_Service_SecurityCommandCenter_Finding —

setState()

Updates the state of a finding. (findings.setState)


    public
                setState(string $name, Google_Service_SecurityCommandCenter_SetFindingStateRequest $postBody[, array<string|int, mixed> $optParams = array() ]) : Google_Service_SecurityCommandCenter_Finding

Parameters

$name : string: Required. The relative resource name of the finding. See: https://cloud.google.com/apis/design/resource_names#relative_resource_name Example: "organizations/{organization_id}/sources/{source_id}/finding/{finding_id}".
$postBody : Google_Service_SecurityCommandCenter_SetFindingStateRequest
$optParams : array<string|int, mixed> = array(): Optional parameters.

Return values

Google_Service_SecurityCommandCenter_Finding —

updateSecurityMarks()

Updates security marks. (findings.updateSecurityMarks)


    public
                updateSecurityMarks(string $name, Google_Service_SecurityCommandCenter_SecurityMarks $postBody[, array<string|int, mixed> $optParams = array() ]) : Google_Service_SecurityCommandCenter_SecurityMarks

Parameters

$name : string: The relative resource name of the SecurityMarks. See: https://cloud.google.com/apis/design/resource_names#relative_resource_name Examples: "organizations/{organization_id}/assets/{asset_id}/securityMarks" " organizations/{organization_id}/sources/{source_id}/findings/{finding_id}/sec urityMarks".
$postBody : Google_Service_SecurityCommandCenter_SecurityMarks
$optParams : array<string|int, mixed> = array(): Optional parameters.

Return values

Google_Service_SecurityCommandCenter_SecurityMarks —

convertToArrayAndStripNulls()


    protected
                convertToArrayAndStripNulls(mixed $o) : mixed

Parameters

$o : mixed

Return values

mixed —