Documentation

Google_Service_SecurityCommandCenter_Resource_OrganizationsAssets extends Google_Service_Resource
in package

The "assets" collection of methods.

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

Table of Contents

$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.
createRequestUri()  : string
Parse/expand request parameters and create a fully qualified request uri.
group()  : Google_Service_SecurityCommandCenter_GroupAssetsResponse
Filters an organization's assets and groups them by their specified properties. (assets.group)
listOrganizationsAssets()  : Google_Service_SecurityCommandCenter_ListAssetsResponse
Lists an organization's assets. (assets.listOrganizationsAssets)
runDiscovery()  : Google_Service_SecurityCommandCenter_Operation
Runs asset discovery. The discovery is tracked with a long-running operation.
updateSecurityMarks()  : Google_Service_SecurityCommandCenter_SecurityMarks
Updates security marks. (assets.updateSecurityMarks)
convertToArrayAndStripNulls()  : mixed

Properties

$methods

private array<string|int, mixed> $methods

$resourceName

private string $resourceName

$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'))

Methods

__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
Tags
throws
Google_Exception
Return values
Google_Http_Request|expectedClass

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>
Tags
static
Return values
string

$requestUrl

group()

Filters an organization's assets and groups them by their specified properties. (assets.group)

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

Required. Name of the organization to groupBy. Its format is "organizations/[organization_id]".

$postBody : Google_Service_SecurityCommandCenter_GroupAssetsRequest
$optParams : array<string|int, mixed> = array()

Optional parameters.

Return values
Google_Service_SecurityCommandCenter_GroupAssetsResponse

listOrganizationsAssets()

Lists an organization's assets. (assets.listOrganizationsAssets)

public listOrganizationsAssets(string $parent[, array<string|int, mixed> $optParams = array() ]) : Google_Service_SecurityCommandCenter_ListAssetsResponse
Parameters
$parent : string

Required. Name of the organization assets should belong to. Its format is "organizations/[organization_id]".

$optParams : array<string|int, mixed> = array()

Optional parameters.

Tags
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,resource_properties.a_property". Redundant space characters in the syntax are insignificant. "name desc,resource_properties.a_property" and " name desc , resource_properties.a_property " are equivalent. The following fields are supported: name update_time resource_properties security_marks.marks security_center_properties.resource_name security_center_properties.resource_display_name security_center_properties.resource_parent security_center_properties.resource_parent_display_name security_center_properties.resource_project security_center_properties.resource_project_display_name security_center_properties.resource_type

opt_param

string readTime Time used as a reference point when filtering assets. The filter is limited to assets 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 compareDuration When compare_duration is set, the ListAssetsResult's "state_change" attribute is updated to indicate whether the asset was added, removed, or remained present 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 of the asset 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 asset is removed and re-created again. Possible "state_change" values when compare_duration is specified: * "ADDED": indicates that the asset was not present at the start of compare_duration, but present at read_time. * "REMOVED": indicates that the asset was present at the start of compare_duration, but not present at read_time. * "ACTIVE": indicates that the asset was present at both the start and the end of the time period defined by compare_duration and 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 assets present at read_time.

opt_param

string fieldMask A field mask to specify the ListAssetsResult 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 filter Expression that defines the filter to apply across assets. The expression is a list of zero 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. The fields map to those defined in the Asset resource. Examples include: * name * security_center_properties.resource_name * resource_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 are the allowed field and operator combinations: * name: = * update_time: =, >, <, >=, <= Usage: This should be milliseconds since epoch or an RFC3339 string. Examples: update_time = "2019-06-10T16:07:18-07:00" update_time = 1560208038000 * create_time: =, >, <, >=, <= Usage: This should be milliseconds since epoch or an RFC3339 string. Examples: create_time = "2019-06-10T16:07:18-07:00" create_time = 1560208038000 * iam_policy.policy_blob: =, : * resource_properties: =, :, >, <, >=, <= * security_marks.marks: =, : * security_center_properties.resource_name: =, : * security_center_properties.resource_display_name: =, : * security_center_properties.resource_type: =, : * security_center_properties.resource_parent: =, : * security_center_properties.resource_parent_display_name: =, : * security_center_properties.resource_project: =, : * security_center_properties.resource_project_display_name: =, : * security_center_properties.resource_owners: =, : For example, resource_properties.size = 100 is a valid filter string. Use a partial match on the empty string to filter based on a property existing: resource_properties.my_property : "" Use a negated partial match on the empty string to filter based on a property not existing: -resource_properties.my_property : ""

opt_param

string pageToken The value returned by the last ListAssetsResponse; indicates that this is a continuation of a prior ListAssets call, and that the system should return the next page of data.

Return values
Google_Service_SecurityCommandCenter_ListAssetsResponse

runDiscovery()

Runs asset discovery. The discovery is tracked with a long-running operation.

public runDiscovery(string $parent, Google_Service_SecurityCommandCenter_RunAssetDiscoveryRequest $postBody[, array<string|int, mixed> $optParams = array() ]) : Google_Service_SecurityCommandCenter_Operation

This API can only be called with limited frequency for an organization. If it is called too frequently the caller will receive a TOO_MANY_REQUESTS error. (assets.runDiscovery)

Parameters
$parent : string

Required. Name of the organization to run asset discovery for. Its format is "organizations/[organization_id]".

$postBody : Google_Service_SecurityCommandCenter_RunAssetDiscoveryRequest
$optParams : array<string|int, mixed> = array()

Optional parameters.

Return values
Google_Service_SecurityCommandCenter_Operation

updateSecurityMarks()

Updates security marks. (assets.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.

Tags
opt_param

string updateMask The FieldMask to use when updating the security marks resource. The field mask must not contain duplicate fields. If empty or set to "marks", all marks will be replaced. Individual marks can be updated using "marks.".

opt_param

string startTime The time at which the updated SecurityMarks take effect. If not set uses current server time. Updates will be applied to the SecurityMarks that are active immediately preceding this time.

Return values
Google_Service_SecurityCommandCenter_SecurityMarks

convertToArrayAndStripNulls()

protected convertToArrayAndStripNulls(mixed $o) : mixed
Parameters
$o : mixed
Return values
mixed

Search results