Reference documentation and code samples for the Google Cloud Security Command Center V1 Client class SecurityCenterClient.
Service Description: V1 APIs for Security Center service.
This class provides the ability to make remote calls to the backing service through method calls that map to API methods.
Many parameters require resource names to be formatted in a particular way. To assist with these names, this class includes a format method for each type of name, and additionally a parseName method to extract the individual identifiers contained within formatted names that are returned by the API.
This class is currently experimental and may be subject to changes. See Google\Cloud\SecurityCenter\V1\SecurityCenterClient for the stable implementation
Namespace
Google \ Cloud \ SecurityCenter \ V1 \ ClientMethods
__construct
Constructor.
Parameters | |
---|---|
Name | Description |
options |
array
Optional. Options for configuring the service API wrapper. |
↳ apiEndpoint |
string
The address of the API remote host. May optionally include the port, formatted as "
|
↳ credentials |
string|array|FetchAuthTokenInterface|CredentialsWrapper
The credentials to be used by the client to authorize API calls. This option accepts either a path to a credentials file, or a decoded credentials file as a PHP array. Advanced usage: In addition, this option can also accept a pre-constructed Google\Auth\FetchAuthTokenInterface object or Google\ApiCore\CredentialsWrapper object. Note that when one of these objects are provided, any settings in $credentialsConfig will be ignored. |
↳ credentialsConfig |
array
Options used to configure credentials, including auth token caching, for the client. For a full list of supporting configuration options, see Google\ApiCore\CredentialsWrapper::build() . |
↳ disableRetries |
bool
Determines whether or not retries defined by the client configuration should be disabled. Defaults to |
↳ clientConfig |
string|array
Client method configuration, including retry settings. This option can be either a path to a JSON file, or a PHP array containing the decoded JSON data. By default this settings points to the default client config file, which is provided in the resources folder. |
↳ transport |
string|TransportInterface
The transport used for executing network requests. May be either the string |
↳ transportConfig |
array
Configuration options that will be used to construct the transport. Options for each supported transport type should be passed in a key for that transport. For example: $transportConfig = [ 'grpc' => [...], 'rest' => [...], ]; See the Google\ApiCore\Transport\GrpcTransport::build() and Google\ApiCore\Transport\RestTransport::build() methods for the supported options. |
↳ clientCertSource |
callable
A callable which returns the client cert as a string. This can be used to provide a certificate and private key to the transport layer for mTLS. |
bulkMuteFindings
Kicks off an LRO to bulk mute findings for a parent based on a filter. The parent can be either an organization, folder or project. The findings matched by the filter will be muted after the LRO is done.
The async variant is Google\Cloud\SecurityCenter\V1\Client\SecurityCenterClient::bulkMuteFindingsAsync() .
Parameters | |
---|---|
Name | Description |
request |
Google\Cloud\SecurityCenter\V1\BulkMuteFindingsRequest
A request to house fields associated with the call. |
callOptions |
array
Optional. |
↳ retrySettings |
RetrySettings|array
Retry settings to use for this call. Can be a Google\ApiCore\RetrySettings object, or an associative array of retry settings parameters. See the documentation on Google\ApiCore\RetrySettings for example usage. |
Returns | |
---|---|
Type | Description |
Google\ApiCore\OperationResponse |
createBigQueryExport
Creates a BigQuery export.
The async variant is Google\Cloud\SecurityCenter\V1\Client\SecurityCenterClient::createBigQueryExportAsync() .
Parameters | |
---|---|
Name | Description |
request |
Google\Cloud\SecurityCenter\V1\CreateBigQueryExportRequest
A request to house fields associated with the call. |
callOptions |
array
Optional. |
↳ retrySettings |
RetrySettings|array
Retry settings to use for this call. Can be a Google\ApiCore\RetrySettings object, or an associative array of retry settings parameters. See the documentation on Google\ApiCore\RetrySettings for example usage. |
Returns | |
---|---|
Type | Description |
Google\Cloud\SecurityCenter\V1\BigQueryExport |
createFinding
Creates a finding. The corresponding source must exist for finding creation to succeed.
The async variant is Google\Cloud\SecurityCenter\V1\Client\SecurityCenterClient::createFindingAsync() .
Parameters | |
---|---|
Name | Description |
request |
Google\Cloud\SecurityCenter\V1\CreateFindingRequest
A request to house fields associated with the call. |
callOptions |
array
Optional. |
↳ retrySettings |
RetrySettings|array
Retry settings to use for this call. Can be a Google\ApiCore\RetrySettings object, or an associative array of retry settings parameters. See the documentation on Google\ApiCore\RetrySettings for example usage. |
Returns | |
---|---|
Type | Description |
Google\Cloud\SecurityCenter\V1\Finding |
createMuteConfig
Creates a mute config.
The async variant is Google\Cloud\SecurityCenter\V1\Client\SecurityCenterClient::createMuteConfigAsync() .
Parameters | |
---|---|
Name | Description |
request |
Google\Cloud\SecurityCenter\V1\CreateMuteConfigRequest
A request to house fields associated with the call. |
callOptions |
array
Optional. |
↳ retrySettings |
RetrySettings|array
Retry settings to use for this call. Can be a Google\ApiCore\RetrySettings object, or an associative array of retry settings parameters. See the documentation on Google\ApiCore\RetrySettings for example usage. |
Returns | |
---|---|
Type | Description |
Google\Cloud\SecurityCenter\V1\MuteConfig |
createNotificationConfig
Creates a notification config.
The async variant is Google\Cloud\SecurityCenter\V1\Client\SecurityCenterClient::createNotificationConfigAsync() .
Parameters | |
---|---|
Name | Description |
request |
Google\Cloud\SecurityCenter\V1\CreateNotificationConfigRequest
A request to house fields associated with the call. |
callOptions |
array
Optional. |
↳ retrySettings |
RetrySettings|array
Retry settings to use for this call. Can be a Google\ApiCore\RetrySettings object, or an associative array of retry settings parameters. See the documentation on Google\ApiCore\RetrySettings for example usage. |
Returns | |
---|---|
Type | Description |
Google\Cloud\SecurityCenter\V1\NotificationConfig |
createSecurityHealthAnalyticsCustomModule
Creates a resident SecurityHealthAnalyticsCustomModule at the scope of the given CRM parent, and also creates inherited SecurityHealthAnalyticsCustomModules for all CRM descendants of the given parent. These modules are enabled by default.
The async variant is Google\Cloud\SecurityCenter\V1\Client\SecurityCenterClient::createSecurityHealthAnalyticsCustomModuleAsync() .
Parameters | |
---|---|
Name | Description |
request |
Google\Cloud\SecurityCenter\V1\CreateSecurityHealthAnalyticsCustomModuleRequest
A request to house fields associated with the call. |
callOptions |
array
Optional. |
↳ retrySettings |
RetrySettings|array
Retry settings to use for this call. Can be a Google\ApiCore\RetrySettings object, or an associative array of retry settings parameters. See the documentation on Google\ApiCore\RetrySettings for example usage. |
Returns | |
---|---|
Type | Description |
Google\Cloud\SecurityCenter\V1\SecurityHealthAnalyticsCustomModule |
createSource
Creates a source.
The async variant is Google\Cloud\SecurityCenter\V1\Client\SecurityCenterClient::createSourceAsync() .
Parameters | |
---|---|
Name | Description |
request |
Google\Cloud\SecurityCenter\V1\CreateSourceRequest
A request to house fields associated with the call. |
callOptions |
array
Optional. |
↳ retrySettings |
RetrySettings|array
Retry settings to use for this call. Can be a Google\ApiCore\RetrySettings object, or an associative array of retry settings parameters. See the documentation on Google\ApiCore\RetrySettings for example usage. |
Returns | |
---|---|
Type | Description |
Google\Cloud\SecurityCenter\V1\Source |
deleteBigQueryExport
Deletes an existing BigQuery export.
The async variant is Google\Cloud\SecurityCenter\V1\Client\SecurityCenterClient::deleteBigQueryExportAsync() .
Parameters | |
---|---|
Name | Description |
request |
Google\Cloud\SecurityCenter\V1\DeleteBigQueryExportRequest
A request to house fields associated with the call. |
callOptions |
array
Optional. |
↳ retrySettings |
RetrySettings|array
Retry settings to use for this call. Can be a Google\ApiCore\RetrySettings object, or an associative array of retry settings parameters. See the documentation on Google\ApiCore\RetrySettings for example usage. |
deleteMuteConfig
Deletes an existing mute config.
The async variant is Google\Cloud\SecurityCenter\V1\Client\SecurityCenterClient::deleteMuteConfigAsync() .
Parameters | |
---|---|
Name | Description |
request |
Google\Cloud\SecurityCenter\V1\DeleteMuteConfigRequest
A request to house fields associated with the call. |
callOptions |
array
Optional. |
↳ retrySettings |
RetrySettings|array
Retry settings to use for this call. Can be a Google\ApiCore\RetrySettings object, or an associative array of retry settings parameters. See the documentation on Google\ApiCore\RetrySettings for example usage. |
deleteNotificationConfig
Deletes a notification config.
The async variant is Google\Cloud\SecurityCenter\V1\Client\SecurityCenterClient::deleteNotificationConfigAsync() .
Parameters | |
---|---|
Name | Description |
request |
Google\Cloud\SecurityCenter\V1\DeleteNotificationConfigRequest
A request to house fields associated with the call. |
callOptions |
array
Optional. |
↳ retrySettings |
RetrySettings|array
Retry settings to use for this call. Can be a Google\ApiCore\RetrySettings object, or an associative array of retry settings parameters. See the documentation on Google\ApiCore\RetrySettings for example usage. |
deleteSecurityHealthAnalyticsCustomModule
Deletes the specified SecurityHealthAnalyticsCustomModule and all of its descendants in the CRM hierarchy. This method is only supported for resident custom modules.
The async variant is Google\Cloud\SecurityCenter\V1\Client\SecurityCenterClient::deleteSecurityHealthAnalyticsCustomModuleAsync() .
Parameters | |
---|---|
Name | Description |
request |
Google\Cloud\SecurityCenter\V1\DeleteSecurityHealthAnalyticsCustomModuleRequest
A request to house fields associated with the call. |
callOptions |
array
Optional. |
↳ retrySettings |
RetrySettings|array
Retry settings to use for this call. Can be a Google\ApiCore\RetrySettings object, or an associative array of retry settings parameters. See the documentation on Google\ApiCore\RetrySettings for example usage. |
getBigQueryExport
Gets a BigQuery export.
The async variant is Google\Cloud\SecurityCenter\V1\Client\SecurityCenterClient::getBigQueryExportAsync() .
Parameters | |
---|---|
Name | Description |
request |
Google\Cloud\SecurityCenter\V1\GetBigQueryExportRequest
A request to house fields associated with the call. |
callOptions |
array
Optional. |
↳ retrySettings |
RetrySettings|array
Retry settings to use for this call. Can be a Google\ApiCore\RetrySettings object, or an associative array of retry settings parameters. See the documentation on Google\ApiCore\RetrySettings for example usage. |
Returns | |
---|---|
Type | Description |
Google\Cloud\SecurityCenter\V1\BigQueryExport |
getEffectiveSecurityHealthAnalyticsCustomModule
Retrieves an EffectiveSecurityHealthAnalyticsCustomModule.
The async variant is Google\Cloud\SecurityCenter\V1\Client\SecurityCenterClient::getEffectiveSecurityHealthAnalyticsCustomModuleAsync() .
Parameters | |
---|---|
Name | Description |
request |
Google\Cloud\SecurityCenter\V1\GetEffectiveSecurityHealthAnalyticsCustomModuleRequest
A request to house fields associated with the call. |
callOptions |
array
Optional. |
↳ retrySettings |
RetrySettings|array
Retry settings to use for this call. Can be a Google\ApiCore\RetrySettings object, or an associative array of retry settings parameters. See the documentation on Google\ApiCore\RetrySettings for example usage. |
Returns | |
---|---|
Type | Description |
Google\Cloud\SecurityCenter\V1\EffectiveSecurityHealthAnalyticsCustomModule |
getIamPolicy
Gets the access control policy on the specified Source.
The async variant is Google\Cloud\SecurityCenter\V1\Client\SecurityCenterClient::getIamPolicyAsync() .
Parameters | |
---|---|
Name | Description |
request |
Google\Cloud\Iam\V1\GetIamPolicyRequest
A request to house fields associated with the call. |
callOptions |
array
Optional. |
↳ retrySettings |
RetrySettings|array
Retry settings to use for this call. Can be a Google\ApiCore\RetrySettings object, or an associative array of retry settings parameters. See the documentation on Google\ApiCore\RetrySettings for example usage. |
Returns | |
---|---|
Type | Description |
Google\Cloud\Iam\V1\Policy |
getMuteConfig
Gets a mute config.
The async variant is Google\Cloud\SecurityCenter\V1\Client\SecurityCenterClient::getMuteConfigAsync() .
Parameters | |
---|---|
Name | Description |
request |
Google\Cloud\SecurityCenter\V1\GetMuteConfigRequest
A request to house fields associated with the call. |
callOptions |
array
Optional. |
↳ retrySettings |
RetrySettings|array
Retry settings to use for this call. Can be a Google\ApiCore\RetrySettings object, or an associative array of retry settings parameters. See the documentation on Google\ApiCore\RetrySettings for example usage. |
Returns | |
---|---|
Type | Description |
Google\Cloud\SecurityCenter\V1\MuteConfig |
getNotificationConfig
Gets a notification config.
The async variant is Google\Cloud\SecurityCenter\V1\Client\SecurityCenterClient::getNotificationConfigAsync() .
Parameters | |
---|---|
Name | Description |
request |
Google\Cloud\SecurityCenter\V1\GetNotificationConfigRequest
A request to house fields associated with the call. |
callOptions |
array
Optional. |
↳ retrySettings |
RetrySettings|array
Retry settings to use for this call. Can be a Google\ApiCore\RetrySettings object, or an associative array of retry settings parameters. See the documentation on Google\ApiCore\RetrySettings for example usage. |
Returns | |
---|---|
Type | Description |
Google\Cloud\SecurityCenter\V1\NotificationConfig |
getOrganizationSettings
Gets the settings for an organization.
The async variant is Google\Cloud\SecurityCenter\V1\Client\SecurityCenterClient::getOrganizationSettingsAsync() .
Parameters | |
---|---|
Name | Description |
request |
Google\Cloud\SecurityCenter\V1\GetOrganizationSettingsRequest
A request to house fields associated with the call. |
callOptions |
array
Optional. |
↳ retrySettings |
RetrySettings|array
Retry settings to use for this call. Can be a Google\ApiCore\RetrySettings object, or an associative array of retry settings parameters. See the documentation on Google\ApiCore\RetrySettings for example usage. |
Returns | |
---|---|
Type | Description |
Google\Cloud\SecurityCenter\V1\OrganizationSettings |
getSecurityHealthAnalyticsCustomModule
Retrieves a SecurityHealthAnalyticsCustomModule.
The async variant is Google\Cloud\SecurityCenter\V1\Client\SecurityCenterClient::getSecurityHealthAnalyticsCustomModuleAsync() .
Parameters | |
---|---|
Name | Description |
request |
Google\Cloud\SecurityCenter\V1\GetSecurityHealthAnalyticsCustomModuleRequest
A request to house fields associated with the call. |
callOptions |
array
Optional. |
↳ retrySettings |
RetrySettings|array
Retry settings to use for this call. Can be a Google\ApiCore\RetrySettings object, or an associative array of retry settings parameters. See the documentation on Google\ApiCore\RetrySettings for example usage. |
Returns | |
---|---|
Type | Description |
Google\Cloud\SecurityCenter\V1\SecurityHealthAnalyticsCustomModule |
getSource
Gets a source.
The async variant is Google\Cloud\SecurityCenter\V1\Client\SecurityCenterClient::getSourceAsync() .
Parameters | |
---|---|
Name | Description |
request |
Google\Cloud\SecurityCenter\V1\GetSourceRequest
A request to house fields associated with the call. |
callOptions |
array
Optional. |
↳ retrySettings |
RetrySettings|array
Retry settings to use for this call. Can be a Google\ApiCore\RetrySettings object, or an associative array of retry settings parameters. See the documentation on Google\ApiCore\RetrySettings for example usage. |
Returns | |
---|---|
Type | Description |
Google\Cloud\SecurityCenter\V1\Source |
groupAssets
Filters an organization's assets and groups them by their specified properties.
The async variant is Google\Cloud\SecurityCenter\V1\Client\SecurityCenterClient::groupAssetsAsync() .
Parameters | |
---|---|
Name | Description |
request |
Google\Cloud\SecurityCenter\V1\GroupAssetsRequest
A request to house fields associated with the call. |
callOptions |
array
Optional. |
↳ retrySettings |
RetrySettings|array
Retry settings to use for this call. Can be a Google\ApiCore\RetrySettings object, or an associative array of retry settings parameters. See the documentation on Google\ApiCore\RetrySettings for example usage. |
Returns | |
---|---|
Type | Description |
Google\ApiCore\PagedListResponse |
groupFindings
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,
/v1/folders/{folder_id}/sources/-/findings,
/v1/projects/{project_id}/sources/-/findings
The async variant is Google\Cloud\SecurityCenter\V1\Client\SecurityCenterClient::groupFindingsAsync() .
Parameters | |
---|---|
Name | Description |
request |
Google\Cloud\SecurityCenter\V1\GroupFindingsRequest
A request to house fields associated with the call. |
callOptions |
array
Optional. |
↳ retrySettings |
RetrySettings|array
Retry settings to use for this call. Can be a Google\ApiCore\RetrySettings object, or an associative array of retry settings parameters. See the documentation on Google\ApiCore\RetrySettings for example usage. |
Returns | |
---|---|
Type | Description |
Google\ApiCore\PagedListResponse |
listAssets
Lists an organization's assets.
The async variant is Google\Cloud\SecurityCenter\V1\Client\SecurityCenterClient::listAssetsAsync() .
Parameters | |
---|---|
Name | Description |
request |
Google\Cloud\SecurityCenter\V1\ListAssetsRequest
A request to house fields associated with the call. |
callOptions |
array
Optional. |
↳ retrySettings |
RetrySettings|array
Retry settings to use for this call. Can be a Google\ApiCore\RetrySettings object, or an associative array of retry settings parameters. See the documentation on Google\ApiCore\RetrySettings for example usage. |
Returns | |
---|---|
Type | Description |
Google\ApiCore\PagedListResponse |
listBigQueryExports
Lists BigQuery exports. Note that when requesting BigQuery exports at a given level all exports under that level are also returned e.g. if requesting BigQuery exports under a folder, then all BigQuery exports immediately under the folder plus the ones created under the projects within the folder are returned.
The async variant is Google\Cloud\SecurityCenter\V1\Client\SecurityCenterClient::listBigQueryExportsAsync() .
Parameters | |
---|---|
Name | Description |
request |
Google\Cloud\SecurityCenter\V1\ListBigQueryExportsRequest
A request to house fields associated with the call. |
callOptions |
array
Optional. |
↳ retrySettings |
RetrySettings|array
Retry settings to use for this call. Can be a Google\ApiCore\RetrySettings object, or an associative array of retry settings parameters. See the documentation on Google\ApiCore\RetrySettings for example usage. |
Returns | |
---|---|
Type | Description |
Google\ApiCore\PagedListResponse |
listDescendantSecurityHealthAnalyticsCustomModules
Returns a list of all resident SecurityHealthAnalyticsCustomModules under the given CRM parent and all of the parent’s CRM descendants.
The async variant is Google\Cloud\SecurityCenter\V1\Client\SecurityCenterClient::listDescendantSecurityHealthAnalyticsCustomModulesAsync() .
Parameters | |
---|---|
Name | Description |
request |
Google\Cloud\SecurityCenter\V1\ListDescendantSecurityHealthAnalyticsCustomModulesRequest
A request to house fields associated with the call. |
callOptions |
array
Optional. |
↳ retrySettings |
RetrySettings|array
Retry settings to use for this call. Can be a Google\ApiCore\RetrySettings object, or an associative array of retry settings parameters. See the documentation on Google\ApiCore\RetrySettings for example usage. |
Returns | |
---|---|
Type | Description |
Google\ApiCore\PagedListResponse |
listEffectiveSecurityHealthAnalyticsCustomModules
Returns a list of all EffectiveSecurityHealthAnalyticsCustomModules for the given parent. This includes resident modules defined at the scope of the parent, and inherited modules, inherited from CRM ancestors.
The async variant is Google\Cloud\SecurityCenter\V1\Client\SecurityCenterClient::listEffectiveSecurityHealthAnalyticsCustomModulesAsync() .
Parameters | |
---|---|
Name | Description |
request |
Google\Cloud\SecurityCenter\V1\ListEffectiveSecurityHealthAnalyticsCustomModulesRequest
A request to house fields associated with the call. |
callOptions |
array
Optional. |
↳ retrySettings |
RetrySettings|array
Retry settings to use for this call. Can be a Google\ApiCore\RetrySettings object, or an associative array of retry settings parameters. See the documentation on Google\ApiCore\RetrySettings for example usage. |
Returns | |
---|---|
Type | Description |
Google\ApiCore\PagedListResponse |
listFindings
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
The async variant is Google\Cloud\SecurityCenter\V1\Client\SecurityCenterClient::listFindingsAsync() .
Parameters | |
---|---|
Name | Description |
request |
Google\Cloud\SecurityCenter\V1\ListFindingsRequest
A request to house fields associated with the call. |
callOptions |
array
Optional. |
↳ retrySettings |
RetrySettings|array
Retry settings to use for this call. Can be a Google\ApiCore\RetrySettings object, or an associative array of retry settings parameters. See the documentation on Google\ApiCore\RetrySettings for example usage. |
Returns | |
---|---|
Type | Description |
Google\ApiCore\PagedListResponse |
listMuteConfigs
Lists mute configs.
The async variant is Google\Cloud\SecurityCenter\V1\Client\SecurityCenterClient::listMuteConfigsAsync() .
Parameters | |
---|---|
Name | Description |
request |
Google\Cloud\SecurityCenter\V1\ListMuteConfigsRequest
A request to house fields associated with the call. |
callOptions |
array
Optional. |
↳ retrySettings |
RetrySettings|array
Retry settings to use for this call. Can be a Google\ApiCore\RetrySettings object, or an associative array of retry settings parameters. See the documentation on Google\ApiCore\RetrySettings for example usage. |
Returns | |
---|---|
Type | Description |
Google\ApiCore\PagedListResponse |
listNotificationConfigs
Lists notification configs.
The async variant is Google\Cloud\SecurityCenter\V1\Client\SecurityCenterClient::listNotificationConfigsAsync() .
Parameters | |
---|---|
Name | Description |
request |
Google\Cloud\SecurityCenter\V1\ListNotificationConfigsRequest
A request to house fields associated with the call. |
callOptions |
array
Optional. |
↳ retrySettings |
RetrySettings|array
Retry settings to use for this call. Can be a Google\ApiCore\RetrySettings object, or an associative array of retry settings parameters. See the documentation on Google\ApiCore\RetrySettings for example usage. |
Returns | |
---|---|
Type | Description |
Google\ApiCore\PagedListResponse |
listSecurityHealthAnalyticsCustomModules
Returns a list of all SecurityHealthAnalyticsCustomModules for the given parent. This includes resident modules defined at the scope of the parent, and inherited modules, inherited from CRM ancestors.
The async variant is Google\Cloud\SecurityCenter\V1\Client\SecurityCenterClient::listSecurityHealthAnalyticsCustomModulesAsync() .
Parameters | |
---|---|
Name | Description |
request |
Google\Cloud\SecurityCenter\V1\ListSecurityHealthAnalyticsCustomModulesRequest
A request to house fields associated with the call. |
callOptions |
array
Optional. |
↳ retrySettings |
RetrySettings|array
Retry settings to use for this call. Can be a Google\ApiCore\RetrySettings object, or an associative array of retry settings parameters. See the documentation on Google\ApiCore\RetrySettings for example usage. |
Returns | |
---|---|
Type | Description |
Google\ApiCore\PagedListResponse |
listSources
Lists all sources belonging to an organization.
The async variant is Google\Cloud\SecurityCenter\V1\Client\SecurityCenterClient::listSourcesAsync() .
Parameters | |
---|---|
Name | Description |
request |
Google\Cloud\SecurityCenter\V1\ListSourcesRequest
A request to house fields associated with the call. |
callOptions |
array
Optional. |
↳ retrySettings |
RetrySettings|array
Retry settings to use for this call. Can be a Google\ApiCore\RetrySettings object, or an associative array of retry settings parameters. See the documentation on Google\ApiCore\RetrySettings for example usage. |
Returns | |
---|---|
Type | Description |
Google\ApiCore\PagedListResponse |
runAssetDiscovery
Runs asset discovery. The discovery is tracked with a long-running 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.
The async variant is Google\Cloud\SecurityCenter\V1\Client\SecurityCenterClient::runAssetDiscoveryAsync() .
Parameters | |
---|---|
Name | Description |
request |
Google\Cloud\SecurityCenter\V1\RunAssetDiscoveryRequest
A request to house fields associated with the call. |
callOptions |
array
Optional. |
↳ retrySettings |
RetrySettings|array
Retry settings to use for this call. Can be a Google\ApiCore\RetrySettings object, or an associative array of retry settings parameters. See the documentation on Google\ApiCore\RetrySettings for example usage. |
Returns | |
---|---|
Type | Description |
Google\ApiCore\OperationResponse |
setFindingState
Updates the state of a finding.
The async variant is Google\Cloud\SecurityCenter\V1\Client\SecurityCenterClient::setFindingStateAsync() .
Parameters | |
---|---|
Name | Description |
request |
Google\Cloud\SecurityCenter\V1\SetFindingStateRequest
A request to house fields associated with the call. |
callOptions |
array
Optional. |
↳ retrySettings |
RetrySettings|array
Retry settings to use for this call. Can be a Google\ApiCore\RetrySettings object, or an associative array of retry settings parameters. See the documentation on Google\ApiCore\RetrySettings for example usage. |
Returns | |
---|---|
Type | Description |
Google\Cloud\SecurityCenter\V1\Finding |
setIamPolicy
Sets the access control policy on the specified Source.
The async variant is Google\Cloud\SecurityCenter\V1\Client\SecurityCenterClient::setIamPolicyAsync() .
Parameters | |
---|---|
Name | Description |
request |
Google\Cloud\Iam\V1\SetIamPolicyRequest
A request to house fields associated with the call. |
callOptions |
array
Optional. |
↳ retrySettings |
RetrySettings|array
Retry settings to use for this call. Can be a Google\ApiCore\RetrySettings object, or an associative array of retry settings parameters. See the documentation on Google\ApiCore\RetrySettings for example usage. |
Returns | |
---|---|
Type | Description |
Google\Cloud\Iam\V1\Policy |
setMute
Updates the mute state of a finding.
The async variant is Google\Cloud\SecurityCenter\V1\Client\SecurityCenterClient::setMuteAsync() .
Parameters | |
---|---|
Name | Description |
request |
Google\Cloud\SecurityCenter\V1\SetMuteRequest
A request to house fields associated with the call. |
callOptions |
array
Optional. |
↳ retrySettings |
RetrySettings|array
Retry settings to use for this call. Can be a Google\ApiCore\RetrySettings object, or an associative array of retry settings parameters. See the documentation on Google\ApiCore\RetrySettings for example usage. |
Returns | |
---|---|
Type | Description |
Google\Cloud\SecurityCenter\V1\Finding |
simulateSecurityHealthAnalyticsCustomModule
Simulates a given SecurityHealthAnalyticsCustomModule and Resource.
The async variant is Google\Cloud\SecurityCenter\V1\Client\SecurityCenterClient::simulateSecurityHealthAnalyticsCustomModuleAsync() .
Parameters | |
---|---|
Name | Description |
request |
Google\Cloud\SecurityCenter\V1\SimulateSecurityHealthAnalyticsCustomModuleRequest
A request to house fields associated with the call. |
callOptions |
array
Optional. |
↳ retrySettings |
RetrySettings|array
Retry settings to use for this call. Can be a Google\ApiCore\RetrySettings object, or an associative array of retry settings parameters. See the documentation on Google\ApiCore\RetrySettings for example usage. |
Returns | |
---|---|
Type | Description |
Google\Cloud\SecurityCenter\V1\SimulateSecurityHealthAnalyticsCustomModuleResponse |
testIamPermissions
Returns the permissions that a caller has on the specified source.
The async variant is Google\Cloud\SecurityCenter\V1\Client\SecurityCenterClient::testIamPermissionsAsync() .
Parameters | |
---|---|
Name | Description |
request |
Google\Cloud\Iam\V1\TestIamPermissionsRequest
A request to house fields associated with the call. |
callOptions |
array
Optional. |
↳ retrySettings |
RetrySettings|array
Retry settings to use for this call. Can be a Google\ApiCore\RetrySettings object, or an associative array of retry settings parameters. See the documentation on Google\ApiCore\RetrySettings for example usage. |
Returns | |
---|---|
Type | Description |
Google\Cloud\Iam\V1\TestIamPermissionsResponse |
updateBigQueryExport
Updates a BigQuery export.
The async variant is Google\Cloud\SecurityCenter\V1\Client\SecurityCenterClient::updateBigQueryExportAsync() .
Parameters | |
---|---|
Name | Description |
request |
Google\Cloud\SecurityCenter\V1\UpdateBigQueryExportRequest
A request to house fields associated with the call. |
callOptions |
array
Optional. |
↳ retrySettings |
RetrySettings|array
Retry settings to use for this call. Can be a Google\ApiCore\RetrySettings object, or an associative array of retry settings parameters. See the documentation on Google\ApiCore\RetrySettings for example usage. |
Returns | |
---|---|
Type | Description |
Google\Cloud\SecurityCenter\V1\BigQueryExport |
updateExternalSystem
Updates external system. This is for a given finding.
The async variant is Google\Cloud\SecurityCenter\V1\Client\SecurityCenterClient::updateExternalSystemAsync() .
Parameters | |
---|---|
Name | Description |
request |
Google\Cloud\SecurityCenter\V1\UpdateExternalSystemRequest
A request to house fields associated with the call. |
callOptions |
array
Optional. |
↳ retrySettings |
RetrySettings|array
Retry settings to use for this call. Can be a Google\ApiCore\RetrySettings object, or an associative array of retry settings parameters. See the documentation on Google\ApiCore\RetrySettings for example usage. |
Returns | |
---|---|
Type | Description |
Google\Cloud\SecurityCenter\V1\ExternalSystem |
updateFinding
Creates or updates a finding. The corresponding source must exist for a finding creation to succeed.
The async variant is Google\Cloud\SecurityCenter\V1\Client\SecurityCenterClient::updateFindingAsync() .
Parameters | |
---|---|
Name | Description |
request |
Google\Cloud\SecurityCenter\V1\UpdateFindingRequest
A request to house fields associated with the call. |
callOptions |
array
Optional. |
↳ retrySettings |
RetrySettings|array
Retry settings to use for this call. Can be a Google\ApiCore\RetrySettings object, or an associative array of retry settings parameters. See the documentation on Google\ApiCore\RetrySettings for example usage. |
Returns | |
---|---|
Type | Description |
Google\Cloud\SecurityCenter\V1\Finding |
updateMuteConfig
Updates a mute config.
The async variant is Google\Cloud\SecurityCenter\V1\Client\SecurityCenterClient::updateMuteConfigAsync() .
Parameters | |
---|---|
Name | Description |
request |
Google\Cloud\SecurityCenter\V1\UpdateMuteConfigRequest
A request to house fields associated with the call. |
callOptions |
array
Optional. |
↳ retrySettings |
RetrySettings|array
Retry settings to use for this call. Can be a Google\ApiCore\RetrySettings object, or an associative array of retry settings parameters. See the documentation on Google\ApiCore\RetrySettings for example usage. |
Returns | |
---|---|
Type | Description |
Google\Cloud\SecurityCenter\V1\MuteConfig |
updateNotificationConfig
Updates a notification config. The following update fields are allowed: description, pubsub_topic, streaming_config.filter
The async variant is Google\Cloud\SecurityCenter\V1\Client\SecurityCenterClient::updateNotificationConfigAsync() .
Parameters | |
---|---|
Name | Description |
request |
Google\Cloud\SecurityCenter\V1\UpdateNotificationConfigRequest
A request to house fields associated with the call. |
callOptions |
array
Optional. |
↳ retrySettings |
RetrySettings|array
Retry settings to use for this call. Can be a Google\ApiCore\RetrySettings object, or an associative array of retry settings parameters. See the documentation on Google\ApiCore\RetrySettings for example usage. |
Returns | |
---|---|
Type | Description |
Google\Cloud\SecurityCenter\V1\NotificationConfig |
updateOrganizationSettings
Updates an organization's settings.
The async variant is Google\Cloud\SecurityCenter\V1\Client\SecurityCenterClient::updateOrganizationSettingsAsync() .
Parameters | |
---|---|
Name | Description |
request |
Google\Cloud\SecurityCenter\V1\UpdateOrganizationSettingsRequest
A request to house fields associated with the call. |
callOptions |
array
Optional. |
↳ retrySettings |
RetrySettings|array
Retry settings to use for this call. Can be a Google\ApiCore\RetrySettings object, or an associative array of retry settings parameters. See the documentation on Google\ApiCore\RetrySettings for example usage. |
Returns | |
---|---|
Type | Description |
Google\Cloud\SecurityCenter\V1\OrganizationSettings |
updateSecurityHealthAnalyticsCustomModule
Updates the SecurityHealthAnalyticsCustomModule under the given name based on the given update mask. Updating the enablement state is supported on both resident and inherited modules (though resident modules cannot have an enablement state of "inherited"). Updating the display name and custom config of a module is supported on resident modules only.
The async variant is Google\Cloud\SecurityCenter\V1\Client\SecurityCenterClient::updateSecurityHealthAnalyticsCustomModuleAsync() .
Parameters | |
---|---|
Name | Description |
request |
Google\Cloud\SecurityCenter\V1\UpdateSecurityHealthAnalyticsCustomModuleRequest
A request to house fields associated with the call. |
callOptions |
array
Optional. |
↳ retrySettings |
RetrySettings|array
Retry settings to use for this call. Can be a Google\ApiCore\RetrySettings object, or an associative array of retry settings parameters. See the documentation on Google\ApiCore\RetrySettings for example usage. |
Returns | |
---|---|
Type | Description |
Google\Cloud\SecurityCenter\V1\SecurityHealthAnalyticsCustomModule |
updateSecurityMarks
Updates security marks.
The async variant is Google\Cloud\SecurityCenter\V1\Client\SecurityCenterClient::updateSecurityMarksAsync() .
Parameters | |
---|---|
Name | Description |
request |
Google\Cloud\SecurityCenter\V1\UpdateSecurityMarksRequest
A request to house fields associated with the call. |
callOptions |
array
Optional. |
↳ retrySettings |
RetrySettings|array
Retry settings to use for this call. Can be a Google\ApiCore\RetrySettings object, or an associative array of retry settings parameters. See the documentation on Google\ApiCore\RetrySettings for example usage. |
Returns | |
---|---|
Type | Description |
Google\Cloud\SecurityCenter\V1\SecurityMarks |
updateSource
Updates a source.
The async variant is Google\Cloud\SecurityCenter\V1\Client\SecurityCenterClient::updateSourceAsync() .
Parameters | |
---|---|
Name | Description |
request |
Google\Cloud\SecurityCenter\V1\UpdateSourceRequest
A request to house fields associated with the call. |
callOptions |
array
Optional. |
↳ retrySettings |
RetrySettings|array
Retry settings to use for this call. Can be a Google\ApiCore\RetrySettings object, or an associative array of retry settings parameters. See the documentation on Google\ApiCore\RetrySettings for example usage. |
Returns | |
---|---|
Type | Description |
Google\Cloud\SecurityCenter\V1\Source |
bulkMuteFindingsAsync
Parameters | |
---|---|
Name | Description |
request |
Google\Cloud\SecurityCenter\V1\BulkMuteFindingsRequest
|
optionalArgs = [] |
array
|
Returns | |
---|---|
Type | Description |
GuzzleHttp\Promise\PromiseInterface |
createBigQueryExportAsync
Parameters | |
---|---|
Name | Description |
request |
Google\Cloud\SecurityCenter\V1\CreateBigQueryExportRequest
|
optionalArgs = [] |
array
|
Returns | |
---|---|
Type | Description |
GuzzleHttp\Promise\PromiseInterface |
createFindingAsync
Parameters | |
---|---|
Name | Description |
request |
Google\Cloud\SecurityCenter\V1\CreateFindingRequest
|
optionalArgs = [] |
array
|
Returns | |
---|---|
Type | Description |
GuzzleHttp\Promise\PromiseInterface |
createMuteConfigAsync
Parameters | |
---|---|
Name | Description |
request |
Google\Cloud\SecurityCenter\V1\CreateMuteConfigRequest
|
optionalArgs = [] |
array
|
Returns | |
---|---|
Type | Description |
GuzzleHttp\Promise\PromiseInterface |
createNotificationConfigAsync
Parameters | |
---|---|
Name | Description |
request |
Google\Cloud\SecurityCenter\V1\CreateNotificationConfigRequest
|
optionalArgs = [] |
array
|
Returns | |
---|---|
Type | Description |
GuzzleHttp\Promise\PromiseInterface |
createSecurityHealthAnalyticsCustomModuleAsync
Parameters | |
---|---|
Name | Description |
request |
Google\Cloud\SecurityCenter\V1\CreateSecurityHealthAnalyticsCustomModuleRequest
|
optionalArgs = [] |
array
|
Returns | |
---|---|
Type | Description |
GuzzleHttp\Promise\PromiseInterface |
createSourceAsync
Parameters | |
---|---|
Name | Description |
request |
Google\Cloud\SecurityCenter\V1\CreateSourceRequest
|
optionalArgs = [] |
array
|
Returns | |
---|---|
Type | Description |
GuzzleHttp\Promise\PromiseInterface |
deleteBigQueryExportAsync
Parameters | |
---|---|
Name | Description |
request |
Google\Cloud\SecurityCenter\V1\DeleteBigQueryExportRequest
|
optionalArgs = [] |
array
|
Returns | |
---|---|
Type | Description |
GuzzleHttp\Promise\PromiseInterface |
deleteMuteConfigAsync
Parameters | |
---|---|
Name | Description |
request |
Google\Cloud\SecurityCenter\V1\DeleteMuteConfigRequest
|
optionalArgs = [] |
array
|
Returns | |
---|---|
Type | Description |
GuzzleHttp\Promise\PromiseInterface |
deleteNotificationConfigAsync
Parameters | |
---|---|
Name | Description |
request |
Google\Cloud\SecurityCenter\V1\DeleteNotificationConfigRequest
|
optionalArgs = [] |
array
|
Returns | |
---|---|
Type | Description |
GuzzleHttp\Promise\PromiseInterface |
deleteSecurityHealthAnalyticsCustomModuleAsync
Parameters | |
---|---|
Name | Description |
request |
Google\Cloud\SecurityCenter\V1\DeleteSecurityHealthAnalyticsCustomModuleRequest
|
optionalArgs = [] |
array
|
Returns | |
---|---|
Type | Description |
GuzzleHttp\Promise\PromiseInterface |
getBigQueryExportAsync
Parameters | |
---|---|
Name | Description |
request |
Google\Cloud\SecurityCenter\V1\GetBigQueryExportRequest
|
optionalArgs = [] |
array
|
Returns | |
---|---|
Type | Description |
GuzzleHttp\Promise\PromiseInterface |
getEffectiveSecurityHealthAnalyticsCustomModuleAsync
Parameters | |
---|---|
Name | Description |
request |
Google\Cloud\SecurityCenter\V1\GetEffectiveSecurityHealthAnalyticsCustomModuleRequest
|
optionalArgs = [] |
array
|
Returns | |
---|---|
Type | Description |
GuzzleHttp\Promise\PromiseInterface |
getIamPolicyAsync
Parameters | |
---|---|
Name | Description |
request |
Google\Cloud\Iam\V1\GetIamPolicyRequest
|
optionalArgs = [] |
array
|
Returns | |
---|---|
Type | Description |
GuzzleHttp\Promise\PromiseInterface |
getMuteConfigAsync
Parameters | |
---|---|
Name | Description |
request |
Google\Cloud\SecurityCenter\V1\GetMuteConfigRequest
|
optionalArgs = [] |
array
|
Returns | |
---|---|
Type | Description |
GuzzleHttp\Promise\PromiseInterface |
getNotificationConfigAsync
Parameters | |
---|---|
Name | Description |
request |
Google\Cloud\SecurityCenter\V1\GetNotificationConfigRequest
|
optionalArgs = [] |
array
|
Returns | |
---|---|
Type | Description |
GuzzleHttp\Promise\PromiseInterface |
getOrganizationSettingsAsync
Parameters | |
---|---|
Name | Description |
request |
Google\Cloud\SecurityCenter\V1\GetOrganizationSettingsRequest
|
optionalArgs = [] |
array
|
Returns | |
---|---|
Type | Description |
GuzzleHttp\Promise\PromiseInterface |
getSecurityHealthAnalyticsCustomModuleAsync
Parameters | |
---|---|
Name | Description |
request |
Google\Cloud\SecurityCenter\V1\GetSecurityHealthAnalyticsCustomModuleRequest
|
optionalArgs = [] |
array
|
Returns | |
---|---|
Type | Description |
GuzzleHttp\Promise\PromiseInterface |
getSourceAsync
Parameters | |
---|---|
Name | Description |
request |
Google\Cloud\SecurityCenter\V1\GetSourceRequest
|
optionalArgs = [] |
array
|
Returns | |
---|---|
Type | Description |
GuzzleHttp\Promise\PromiseInterface |
groupAssetsAsync
Parameters | |
---|---|
Name | Description |
request |
Google\Cloud\SecurityCenter\V1\GroupAssetsRequest
|
optionalArgs = [] |
array
|
Returns | |
---|---|
Type | Description |
GuzzleHttp\Promise\PromiseInterface |
groupFindingsAsync
Parameters | |
---|---|
Name | Description |
request |
Google\Cloud\SecurityCenter\V1\GroupFindingsRequest
|
optionalArgs = [] |
array
|
Returns | |
---|---|
Type | Description |
GuzzleHttp\Promise\PromiseInterface |
listAssetsAsync
Parameters | |
---|---|
Name | Description |
request |
Google\Cloud\SecurityCenter\V1\ListAssetsRequest
|
optionalArgs = [] |
array
|
Returns | |
---|---|
Type | Description |
GuzzleHttp\Promise\PromiseInterface |
listBigQueryExportsAsync
Parameters | |
---|---|
Name | Description |
request |
Google\Cloud\SecurityCenter\V1\ListBigQueryExportsRequest
|
optionalArgs = [] |
array
|
Returns | |
---|---|
Type | Description |
GuzzleHttp\Promise\PromiseInterface |
listDescendantSecurityHealthAnalyticsCustomModulesAsync
Parameters | |
---|---|
Name | Description |
request |
Google\Cloud\SecurityCenter\V1\ListDescendantSecurityHealthAnalyticsCustomModulesRequest
|
optionalArgs = [] |
array
|
Returns | |
---|---|
Type | Description |
GuzzleHttp\Promise\PromiseInterface |
listEffectiveSecurityHealthAnalyticsCustomModulesAsync
Parameters | |
---|---|
Name | Description |
request |
Google\Cloud\SecurityCenter\V1\ListEffectiveSecurityHealthAnalyticsCustomModulesRequest
|
optionalArgs = [] |
array
|
Returns | |
---|---|
Type | Description |
GuzzleHttp\Promise\PromiseInterface |
listFindingsAsync
Parameters | |
---|---|
Name | Description |
request |
Google\Cloud\SecurityCenter\V1\ListFindingsRequest
|
optionalArgs = [] |
array
|
Returns | |
---|---|
Type | Description |
GuzzleHttp\Promise\PromiseInterface |
listMuteConfigsAsync
Parameters | |
---|---|
Name | Description |
request |
Google\Cloud\SecurityCenter\V1\ListMuteConfigsRequest
|
optionalArgs = [] |
array
|
Returns | |
---|---|
Type | Description |
GuzzleHttp\Promise\PromiseInterface |
listNotificationConfigsAsync
Parameters | |
---|---|
Name | Description |
request |
Google\Cloud\SecurityCenter\V1\ListNotificationConfigsRequest
|
optionalArgs = [] |
array
|
Returns | |
---|---|
Type | Description |
GuzzleHttp\Promise\PromiseInterface |
listSecurityHealthAnalyticsCustomModulesAsync
Parameters | |
---|---|
Name | Description |
request |
Google\Cloud\SecurityCenter\V1\ListSecurityHealthAnalyticsCustomModulesRequest
|
optionalArgs = [] |
array
|
Returns | |
---|---|
Type | Description |
GuzzleHttp\Promise\PromiseInterface |
listSourcesAsync
Parameters | |
---|---|
Name | Description |
request |
Google\Cloud\SecurityCenter\V1\ListSourcesRequest
|
optionalArgs = [] |
array
|
Returns | |
---|---|
Type | Description |
GuzzleHttp\Promise\PromiseInterface |
runAssetDiscoveryAsync
Parameters | |
---|---|
Name | Description |
request |
Google\Cloud\SecurityCenter\V1\RunAssetDiscoveryRequest
|
optionalArgs = [] |
array
|
Returns | |
---|---|
Type | Description |
GuzzleHttp\Promise\PromiseInterface |
setFindingStateAsync
Parameters | |
---|---|
Name | Description |
request |
Google\Cloud\SecurityCenter\V1\SetFindingStateRequest
|
optionalArgs = [] |
array
|
Returns | |
---|---|
Type | Description |
GuzzleHttp\Promise\PromiseInterface |
setIamPolicyAsync
Parameters | |
---|---|
Name | Description |
request |
Google\Cloud\Iam\V1\SetIamPolicyRequest
|
optionalArgs = [] |
array
|
Returns | |
---|---|
Type | Description |
GuzzleHttp\Promise\PromiseInterface |
setMuteAsync
Parameters | |
---|---|
Name | Description |
request |
Google\Cloud\SecurityCenter\V1\SetMuteRequest
|
optionalArgs = [] |
array
|
Returns | |
---|---|
Type | Description |
GuzzleHttp\Promise\PromiseInterface |
simulateSecurityHealthAnalyticsCustomModuleAsync
Parameters | |
---|---|
Name | Description |
request |
Google\Cloud\SecurityCenter\V1\SimulateSecurityHealthAnalyticsCustomModuleRequest
|
optionalArgs = [] |
array
|
Returns | |
---|---|
Type | Description |
GuzzleHttp\Promise\PromiseInterface |
testIamPermissionsAsync
Parameters | |
---|---|
Name | Description |
request |
Google\Cloud\Iam\V1\TestIamPermissionsRequest
|
optionalArgs = [] |
array
|
Returns | |
---|---|
Type | Description |
GuzzleHttp\Promise\PromiseInterface |
updateBigQueryExportAsync
Parameters | |
---|---|
Name | Description |
request |
Google\Cloud\SecurityCenter\V1\UpdateBigQueryExportRequest
|
optionalArgs = [] |
array
|
Returns | |
---|---|
Type | Description |
GuzzleHttp\Promise\PromiseInterface |
updateExternalSystemAsync
Parameters | |
---|---|
Name | Description |
request |
Google\Cloud\SecurityCenter\V1\UpdateExternalSystemRequest
|
optionalArgs = [] |
array
|
Returns | |
---|---|
Type | Description |
GuzzleHttp\Promise\PromiseInterface |
updateFindingAsync
Parameters | |
---|---|
Name | Description |
request |
Google\Cloud\SecurityCenter\V1\UpdateFindingRequest
|
optionalArgs = [] |
array
|
Returns | |
---|---|
Type | Description |
GuzzleHttp\Promise\PromiseInterface |
updateMuteConfigAsync
Parameters | |
---|---|
Name | Description |
request |
Google\Cloud\SecurityCenter\V1\UpdateMuteConfigRequest
|
optionalArgs = [] |
array
|
Returns | |
---|---|
Type | Description |
GuzzleHttp\Promise\PromiseInterface |
updateNotificationConfigAsync
Parameters | |
---|---|
Name | Description |
request |
Google\Cloud\SecurityCenter\V1\UpdateNotificationConfigRequest
|
optionalArgs = [] |
array
|
Returns | |
---|---|
Type | Description |
GuzzleHttp\Promise\PromiseInterface |
updateOrganizationSettingsAsync
Parameters | |
---|---|
Name | Description |
request |
Google\Cloud\SecurityCenter\V1\UpdateOrganizationSettingsRequest
|
optionalArgs = [] |
array
|
Returns | |
---|---|
Type | Description |
GuzzleHttp\Promise\PromiseInterface |
updateSecurityHealthAnalyticsCustomModuleAsync
Parameters | |
---|---|
Name | Description |
request |
Google\Cloud\SecurityCenter\V1\UpdateSecurityHealthAnalyticsCustomModuleRequest
|
optionalArgs = [] |
array
|
Returns | |
---|---|
Type | Description |
GuzzleHttp\Promise\PromiseInterface |
updateSecurityMarksAsync
Parameters | |
---|---|
Name | Description |
request |
Google\Cloud\SecurityCenter\V1\UpdateSecurityMarksRequest
|
optionalArgs = [] |
array
|
Returns | |
---|---|
Type | Description |
GuzzleHttp\Promise\PromiseInterface |
updateSourceAsync
Parameters | |
---|---|
Name | Description |
request |
Google\Cloud\SecurityCenter\V1\UpdateSourceRequest
|
optionalArgs = [] |
array
|
Returns | |
---|---|
Type | Description |
GuzzleHttp\Promise\PromiseInterface |
getOperationsClient
Return an OperationsClient object with the same endpoint as $this.
Returns | |
---|---|
Type | Description |
Google\ApiCore\LongRunning\OperationsClient |
resumeOperation
Resume an existing long running operation that was previously started by a long running API method. If $methodName is not provided, or does not match a long running API method, then the operation can still be resumed, but the OperationResponse object will not deserialize the final response.
Parameters | |
---|---|
Name | Description |
operationName |
string
The name of the long running operation |
methodName |
string
The name of the method used to start the operation |
Returns | |
---|---|
Type | Description |
Google\ApiCore\OperationResponse |
static::bigQueryExportName
Formats a string containing the fully-qualified path to represent a big_query_export resource.
Parameters | |
---|---|
Name | Description |
organization |
string
|
export |
string
|
Returns | |
---|---|
Type | Description |
string | The formatted big_query_export resource. |
static::dlpJobName
Formats a string containing the fully-qualified path to represent a dlp_job resource.
Parameters | |
---|---|
Name | Description |
project |
string
|
dlpJob |
string
|
Returns | |
---|---|
Type | Description |
string | The formatted dlp_job resource. |
static::effectiveSecurityHealthAnalyticsCustomModuleName
Formats a string containing the fully-qualified path to represent a effective_security_health_analytics_custom_module resource.
Parameters | |
---|---|
Name | Description |
organization |
string
|
effectiveCustomModule |
string
|
Returns | |
---|---|
Type | Description |
string | The formatted effective_security_health_analytics_custom_module resource. |
static::externalSystemName
Formats a string containing the fully-qualified path to represent a external_system resource.
Parameters | |
---|---|
Name | Description |
organization |
string
|
source |
string
|
finding |
string
|
externalsystem |
string
|
Returns | |
---|---|
Type | Description |
string | The formatted external_system resource. |
static::findingName
Formats a string containing the fully-qualified path to represent a finding resource.
Parameters | |
---|---|
Name | Description |
organization |
string
|
source |
string
|
finding |
string
|
Returns | |
---|---|
Type | Description |
string | The formatted finding resource. |
static::folderName
Formats a string containing the fully-qualified path to represent a folder resource.
Parameter | |
---|---|
Name | Description |
folder |
string
|
Returns | |
---|---|
Type | Description |
string | The formatted folder resource. |
static::folderAssetSecurityMarksName
Formats a string containing the fully-qualified path to represent a folder_asset_securityMarks resource.
Parameters | |
---|---|
Name | Description |
folder |
string
|
asset |
string
|
Returns | |
---|---|
Type | Description |
string | The formatted folder_asset_securityMarks resource. |
static::folderCustomModuleName
Formats a string containing the fully-qualified path to represent a folder_custom_module resource.
Parameters | |
---|---|
Name | Description |
folder |
string
|
customModule |
string
|
Returns | |
---|---|
Type | Description |
string | The formatted folder_custom_module resource. |
static::folderEffectiveCustomModuleName
Formats a string containing the fully-qualified path to represent a folder_effective_custom_module resource.
Parameters | |
---|---|
Name | Description |
folder |
string
|
effectiveCustomModule |
string
|
Returns | |
---|---|
Type | Description |
string | The formatted folder_effective_custom_module resource. |
static::folderExportName
Formats a string containing the fully-qualified path to represent a folder_export resource.
Parameters | |
---|---|
Name | Description |
folder |
string
|
export |
string
|
Returns | |
---|---|
Type | Description |
string | The formatted folder_export resource. |
static::folderMuteConfigName
Formats a string containing the fully-qualified path to represent a folder_mute_config resource.
Parameters | |
---|---|
Name | Description |
folder |
string
|
muteConfig |
string
|
Returns | |
---|---|
Type | Description |
string | The formatted folder_mute_config resource. |
static::folderNotificationConfigName
Formats a string containing the fully-qualified path to represent a folder_notification_config resource.
Parameters | |
---|---|
Name | Description |
folder |
string
|
notificationConfig |
string
|
Returns | |
---|---|
Type | Description |
string | The formatted folder_notification_config resource. |
static::folderSecurityHealthAnalyticsSettingsName
Formats a string containing the fully-qualified path to represent a folder_securityHealthAnalyticsSettings resource.
Parameter | |
---|---|
Name | Description |
folder |
string
|
Returns | |
---|---|
Type | Description |
string | The formatted folder_securityHealthAnalyticsSettings resource. |
static::folderSourceName
Formats a string containing the fully-qualified path to represent a folder_source resource.
Parameters | |
---|---|
Name | Description |
folder |
string
|
source |
string
|
Returns | |
---|---|
Type | Description |
string | The formatted folder_source resource. |
static::folderSourceFindingName
Formats a string containing the fully-qualified path to represent a folder_source_finding resource.
Parameters | |
---|---|
Name | Description |
folder |
string
|
source |
string
|
finding |
string
|
Returns | |
---|---|
Type | Description |
string | The formatted folder_source_finding resource. |
static::folderSourceFindingExternalsystemName
Formats a string containing the fully-qualified path to represent a folder_source_finding_externalsystem resource.
Parameters | |
---|---|
Name | Description |
folder |
string
|
source |
string
|
finding |
string
|
externalsystem |
string
|
Returns | |
---|---|
Type | Description |
string | The formatted folder_source_finding_externalsystem resource. |
static::folderSourceFindingSecurityMarksName
Formats a string containing the fully-qualified path to represent a folder_source_finding_securityMarks resource.
Parameters | |
---|---|
Name | Description |
folder |
string
|
source |
string
|
finding |
string
|
Returns | |
---|---|
Type | Description |
string | The formatted folder_source_finding_securityMarks resource. |
static::muteConfigName
Formats a string containing the fully-qualified path to represent a mute_config resource.
Parameters | |
---|---|
Name | Description |
organization |
string
|
muteConfig |
string
|
Returns | |
---|---|
Type | Description |
string | The formatted mute_config resource. |
static::notificationConfigName
Formats a string containing the fully-qualified path to represent a notification_config resource.
Parameters | |
---|---|
Name | Description |
organization |
string
|
notificationConfig |
string
|
Returns | |
---|---|
Type | Description |
string | The formatted notification_config resource. |
static::organizationName
Formats a string containing the fully-qualified path to represent a organization resource.
Parameter | |
---|---|
Name | Description |
organization |
string
|
Returns | |
---|---|
Type | Description |
string | The formatted organization resource. |
static::organizationAssetSecurityMarksName
Formats a string containing the fully-qualified path to represent a organization_asset_securityMarks resource.
Parameters | |
---|---|
Name | Description |
organization |
string
|
asset |
string
|
Returns | |
---|---|
Type | Description |
string | The formatted organization_asset_securityMarks resource. |
static::organizationCustomModuleName
Formats a string containing the fully-qualified path to represent a organization_custom_module resource.
Parameters | |
---|---|
Name | Description |
organization |
string
|
customModule |
string
|
Returns | |
---|---|
Type | Description |
string | The formatted organization_custom_module resource. |
static::organizationEffectiveCustomModuleName
Formats a string containing the fully-qualified path to represent a organization_effective_custom_module resource.
Parameters | |
---|---|
Name | Description |
organization |
string
|
effectiveCustomModule |
string
|
Returns | |
---|---|
Type | Description |
string | The formatted organization_effective_custom_module resource. |
static::organizationExportName
Formats a string containing the fully-qualified path to represent a organization_export resource.
Parameters | |
---|---|
Name | Description |
organization |
string
|
export |
string
|
Returns | |
---|---|
Type | Description |
string | The formatted organization_export resource. |
static::organizationMuteConfigName
Formats a string containing the fully-qualified path to represent a organization_mute_config resource.
Parameters | |
---|---|
Name | Description |
organization |
string
|
muteConfig |
string
|
Returns | |
---|---|
Type | Description |
string | The formatted organization_mute_config resource. |
static::organizationNotificationConfigName
Formats a string containing the fully-qualified path to represent a organization_notification_config resource.
Parameters | |
---|---|
Name | Description |
organization |
string
|
notificationConfig |
string
|
Returns | |
---|---|
Type | Description |
string | The formatted organization_notification_config resource. |
static::organizationSecurityHealthAnalyticsSettingsName
Formats a string containing the fully-qualified path to represent a organization_securityHealthAnalyticsSettings resource.
Parameter | |
---|---|
Name | Description |
organization |
string
|
Returns | |
---|---|
Type | Description |
string | The formatted organization_securityHealthAnalyticsSettings resource. |
static::organizationSettingsName
Formats a string containing the fully-qualified path to represent a organization_settings resource.
Parameter | |
---|---|
Name | Description |
organization |
string
|
Returns | |
---|---|
Type | Description |
string | The formatted organization_settings resource. |
static::organizationSourceName
Formats a string containing the fully-qualified path to represent a organization_source resource.
Parameters | |
---|---|
Name | Description |
organization |
string
|
source |
string
|
Returns | |
---|---|
Type | Description |
string | The formatted organization_source resource. |
static::organizationSourceFindingName
Formats a string containing the fully-qualified path to represent a organization_source_finding resource.
Parameters | |
---|---|
Name | Description |
organization |
string
|
source |
string
|
finding |
string
|
Returns | |
---|---|
Type | Description |
string | The formatted organization_source_finding resource. |
static::organizationSourceFindingExternalsystemName
Formats a string containing the fully-qualified path to represent a organization_source_finding_externalsystem resource.
Parameters | |
---|---|
Name | Description |
organization |
string
|
source |
string
|
finding |
string
|
externalsystem |
string
|
Returns | |
---|---|
Type | Description |
string | The formatted organization_source_finding_externalsystem resource. |
static::organizationSourceFindingSecurityMarksName
Formats a string containing the fully-qualified path to represent a organization_source_finding_securityMarks resource.
Parameters | |
---|---|
Name | Description |
organization |
string
|
source |
string
|
finding |
string
|
Returns | |
---|---|
Type | Description |
string | The formatted organization_source_finding_securityMarks resource. |
static::projectName
Formats a string containing the fully-qualified path to represent a project resource.
Parameter | |
---|---|
Name | Description |
project |
string
|
Returns | |
---|---|
Type | Description |
string | The formatted project resource. |
static::projectAssetSecurityMarksName
Formats a string containing the fully-qualified path to represent a project_asset_securityMarks resource.
Parameters | |
---|---|
Name | Description |
project |
string
|
asset |
string
|
Returns | |
---|---|
Type | Description |
string | The formatted project_asset_securityMarks resource. |
static::projectCustomModuleName
Formats a string containing the fully-qualified path to represent a project_custom_module resource.
Parameters | |
---|---|
Name | Description |
project |
string
|
customModule |
string
|
Returns | |
---|---|
Type | Description |
string | The formatted project_custom_module resource. |
static::projectDlpJobName
Formats a string containing the fully-qualified path to represent a project_dlp_job resource.
Parameters | |
---|---|
Name | Description |
project |
string
|
dlpJob |
string
|
Returns | |
---|---|
Type | Description |
string | The formatted project_dlp_job resource. |
static::projectEffectiveCustomModuleName
Formats a string containing the fully-qualified path to represent a project_effective_custom_module resource.
Parameters | |
---|---|
Name | Description |
project |
string
|
effectiveCustomModule |
string
|
Returns | |
---|---|
Type | Description |
string | The formatted project_effective_custom_module resource. |
static::projectExportName
Formats a string containing the fully-qualified path to represent a project_export resource.
Parameters | |
---|---|
Name | Description |
project |
string
|
export |
string
|
Returns | |
---|---|
Type | Description |
string | The formatted project_export resource. |
static::projectLocationDlpJobName
Formats a string containing the fully-qualified path to represent a project_location_dlp_job resource.
Parameters | |
---|---|
Name | Description |
project |
string
|
location |
string
|
dlpJob |
string
|
Returns | |
---|---|
Type | Description |
string | The formatted project_location_dlp_job resource. |
static::projectLocationTableProfileName
Formats a string containing the fully-qualified path to represent a project_location_table_profile resource.
Parameters | |
---|---|
Name | Description |
project |
string
|
location |
string
|
tableProfile |
string
|
Returns | |
---|---|
Type | Description |
string | The formatted project_location_table_profile resource. |
static::projectMuteConfigName
Formats a string containing the fully-qualified path to represent a project_mute_config resource.
Parameters | |
---|---|
Name | Description |
project |
string
|
muteConfig |
string
|
Returns | |
---|---|
Type | Description |
string | The formatted project_mute_config resource. |
static::projectNotificationConfigName
Formats a string containing the fully-qualified path to represent a project_notification_config resource.
Parameters | |
---|---|
Name | Description |
project |
string
|
notificationConfig |
string
|
Returns | |
---|---|
Type | Description |
string | The formatted project_notification_config resource. |
static::projectSecurityHealthAnalyticsSettingsName
Formats a string containing the fully-qualified path to represent a project_securityHealthAnalyticsSettings resource.
Parameter | |
---|---|
Name | Description |
project |
string
|
Returns | |
---|---|
Type | Description |
string | The formatted project_securityHealthAnalyticsSettings resource. |
static::projectSourceName
Formats a string containing the fully-qualified path to represent a project_source resource.
Parameters | |
---|---|
Name | Description |
project |
string
|
source |
string
|
Returns | |
---|---|
Type | Description |
string | The formatted project_source resource. |
static::projectSourceFindingName
Formats a string containing the fully-qualified path to represent a project_source_finding resource.
Parameters | |
---|---|
Name | Description |
project |
string
|
source |
string
|
finding |
string
|
Returns | |
---|---|
Type | Description |
string | The formatted project_source_finding resource. |
static::projectSourceFindingExternalsystemName
Formats a string containing the fully-qualified path to represent a project_source_finding_externalsystem resource.
Parameters | |
---|---|
Name | Description |
project |
string
|
source |
string
|
finding |
string
|
externalsystem |
string
|
Returns | |
---|---|
Type | Description |
string | The formatted project_source_finding_externalsystem resource. |
static::projectSourceFindingSecurityMarksName
Formats a string containing the fully-qualified path to represent a project_source_finding_securityMarks resource.
Parameters | |
---|---|
Name | Description |
project |
string
|
source |
string
|
finding |
string
|
Returns | |
---|---|
Type | Description |
string | The formatted project_source_finding_securityMarks resource. |
static::projectTableProfileName
Formats a string containing the fully-qualified path to represent a project_table_profile resource.
Parameters | |
---|---|
Name | Description |
project |
string
|
tableProfile |
string
|
Returns | |
---|---|
Type | Description |
string | The formatted project_table_profile resource. |
static::securityHealthAnalyticsCustomModuleName
Formats a string containing the fully-qualified path to represent a security_health_analytics_custom_module resource.
Parameters | |
---|---|
Name | Description |
organization |
string
|
customModule |
string
|
Returns | |
---|---|
Type | Description |
string | The formatted security_health_analytics_custom_module resource. |
static::securityHealthAnalyticsSettingsName
Formats a string containing the fully-qualified path to represent a security_health_analytics_settings resource.
Parameter | |
---|---|
Name | Description |
organization |
string
|
Returns | |
---|---|
Type | Description |
string | The formatted security_health_analytics_settings resource. |
static::securityMarksName
Formats a string containing the fully-qualified path to represent a security_marks resource.
Parameters | |
---|---|
Name | Description |
organization |
string
|
asset |
string
|
Returns | |
---|---|
Type | Description |
string | The formatted security_marks resource. |
static::sourceName
Formats a string containing the fully-qualified path to represent a source resource.
Parameters | |
---|---|
Name | Description |
organization |
string
|
source |
string
|
Returns | |
---|---|
Type | Description |
string | The formatted source resource. |
static::tableDataProfileName
Formats a string containing the fully-qualified path to represent a table_data_profile resource.
Parameters | |
---|---|
Name | Description |
project |
string
|
tableProfile |
string
|
Returns | |
---|---|
Type | Description |
string | The formatted table_data_profile resource. |
static::topicName
Formats a string containing the fully-qualified path to represent a topic resource.
Parameters | |
---|---|
Name | Description |
project |
string
|
topic |
string
|
Returns | |
---|---|
Type | Description |
string | The formatted topic resource. |
static::parseName
Parses a formatted name string and returns an associative array of the components in the name.
The following name formats are supported: Template: Pattern
- bigQueryExport: organizations/{organization}/bigQueryExports/{export}
- dlpJob: projects/{project}/dlpJobs/{dlp_job}
- effectiveSecurityHealthAnalyticsCustomModule: organizations/{organization}/securityHealthAnalyticsSettings/effectiveCustomModules/{effective_custom_module}
- externalSystem: organizations/{organization}/sources/{source}/findings/{finding}/externalSystems/{externalsystem}
- finding: organizations/{organization}/sources/{source}/findings/{finding}
- folder: folders/{folder}
- folderAssetSecurityMarks: folders/{folder}/assets/{asset}/securityMarks
- folderCustomModule: folders/{folder}/securityHealthAnalyticsSettings/customModules/{custom_module}
- folderEffectiveCustomModule: folders/{folder}/securityHealthAnalyticsSettings/effectiveCustomModules/{effective_custom_module}
- folderExport: folders/{folder}/bigQueryExports/{export}
- folderMuteConfig: folders/{folder}/muteConfigs/{mute_config}
- folderNotificationConfig: folders/{folder}/notificationConfigs/{notification_config}
- folderSecurityHealthAnalyticsSettings: folders/{folder}/securityHealthAnalyticsSettings
- folderSource: folders/{folder}/sources/{source}
- folderSourceFinding: folders/{folder}/sources/{source}/findings/{finding}
- folderSourceFindingExternalsystem: folders/{folder}/sources/{source}/findings/{finding}/externalSystems/{externalsystem}
- folderSourceFindingSecurityMarks: folders/{folder}/sources/{source}/findings/{finding}/securityMarks
- muteConfig: organizations/{organization}/muteConfigs/{mute_config}
- notificationConfig: organizations/{organization}/notificationConfigs/{notification_config}
- organization: organizations/{organization}
- organizationAssetSecurityMarks: organizations/{organization}/assets/{asset}/securityMarks
- organizationCustomModule: organizations/{organization}/securityHealthAnalyticsSettings/customModules/{custom_module}
- organizationEffectiveCustomModule: organizations/{organization}/securityHealthAnalyticsSettings/effectiveCustomModules/{effective_custom_module}
- organizationExport: organizations/{organization}/bigQueryExports/{export}
- organizationMuteConfig: organizations/{organization}/muteConfigs/{mute_config}
- organizationNotificationConfig: organizations/{organization}/notificationConfigs/{notification_config}
- organizationSecurityHealthAnalyticsSettings: organizations/{organization}/securityHealthAnalyticsSettings
- organizationSettings: organizations/{organization}/organizationSettings
- organizationSource: organizations/{organization}/sources/{source}
- organizationSourceFinding: organizations/{organization}/sources/{source}/findings/{finding}
- organizationSourceFindingExternalsystem: organizations/{organization}/sources/{source}/findings/{finding}/externalSystems/{externalsystem}
- organizationSourceFindingSecurityMarks: organizations/{organization}/sources/{source}/findings/{finding}/securityMarks
- project: projects/{project}
- projectAssetSecurityMarks: projects/{project}/assets/{asset}/securityMarks
- projectCustomModule: projects/{project}/securityHealthAnalyticsSettings/customModules/{custom_module}
- projectDlpJob: projects/{project}/dlpJobs/{dlp_job}
- projectEffectiveCustomModule: projects/{project}/securityHealthAnalyticsSettings/effectiveCustomModules/{effective_custom_module}
- projectExport: projects/{project}/bigQueryExports/{export}
- projectLocationDlpJob: projects/{project}/locations/{location}/dlpJobs/{dlp_job}
- projectLocationTableProfile: projects/{project}/locations/{location}/tableProfiles/{table_profile}
- projectMuteConfig: projects/{project}/muteConfigs/{mute_config}
- projectNotificationConfig: projects/{project}/notificationConfigs/{notification_config}
- projectSecurityHealthAnalyticsSettings: projects/{project}/securityHealthAnalyticsSettings
- projectSource: projects/{project}/sources/{source}
- projectSourceFinding: projects/{project}/sources/{source}/findings/{finding}
- projectSourceFindingExternalsystem: projects/{project}/sources/{source}/findings/{finding}/externalSystems/{externalsystem}
- projectSourceFindingSecurityMarks: projects/{project}/sources/{source}/findings/{finding}/securityMarks
- projectTableProfile: projects/{project}/tableProfiles/{table_profile}
- securityHealthAnalyticsCustomModule: organizations/{organization}/securityHealthAnalyticsSettings/customModules/{custom_module}
- securityHealthAnalyticsSettings: organizations/{organization}/securityHealthAnalyticsSettings
- securityMarks: organizations/{organization}/assets/{asset}/securityMarks
- source: organizations/{organization}/sources/{source}
- tableDataProfile: projects/{project}/tableProfiles/{table_profile}
- topic: projects/{project}/topics/{topic}
The optional $template argument can be supplied to specify a particular pattern, and must match one of the templates listed above. If no $template argument is provided, or if the $template argument does not match one of the templates listed, then parseName will check each of the supported templates, and return the first match.
Parameters | |
---|---|
Name | Description |
formattedName |
string
The formatted name string |
template |
string
Optional name of template to match |
Returns | |
---|---|
Type | Description |
array | An associative array from name component IDs to component values. |