V1 APIs for Security Center service.
Equality
Instances of this class created via copy-construction or copy-assignment always compare equal. Instances created with equal std::shared_ptr<*Connection>
objects compare equal. Objects that compare equal share the same underlying resources.
Performance
Creating a new instance of this class is a relatively expensive operation, new objects establish new connections to the service. In contrast, copy-construction, move-construction, and the corresponding assignment operations are relatively efficient as the copies share all underlying resources.
Thread Safety
Concurrent access to different instances of this class, even if they compare equal, is guaranteed to work. Two or more threads operating on the same instance of this class is not guaranteed to work. Since copy-construction and move-construction is a relatively efficient operation, consider using such a copy when using this class from multiple threads.
Constructors
SecurityCenterClient(SecurityCenterClient const &)
Copy and move support
Parameter | |
---|---|
Name | Description |
|
SecurityCenterClient const &
|
SecurityCenterClient(SecurityCenterClient &&)
Copy and move support
Parameter | |
---|---|
Name | Description |
|
SecurityCenterClient &&
|
SecurityCenterClient(std::shared_ptr< SecurityCenterConnection >, Options)
Parameters | |
---|---|
Name | Description |
connection |
std::shared_ptr< SecurityCenterConnection >
|
opts |
Options
|
Operators
operator=(SecurityCenterClient const &)
Copy and move support
Parameter | |
---|---|
Name | Description |
|
SecurityCenterClient const &
|
Returns | |
---|---|
Type | Description |
SecurityCenterClient & |
operator=(SecurityCenterClient &&)
Copy and move support
Parameter | |
---|---|
Name | Description |
|
SecurityCenterClient &&
|
Returns | |
---|---|
Type | Description |
SecurityCenterClient & |
Functions
BulkMuteFindings(std::string const &, Options)
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.
Parameters | |
---|---|
Name | Description |
parent |
std::string const &
Required. The parent, at which bulk action needs to be applied. Its format is |
opts |
Options
Optional. Override the class-level options, such as retry and backoff policies. |
Returns | |
---|---|
Type | Description |
future< StatusOr< google::cloud::securitycenter::v1::BulkMuteFindingsResponse > > |
A |
BulkMuteFindings(NoAwaitTag, std::string const &, Options)
Kicks off an LRO to bulk mute findings for a parent based on a filter.
Specifying the NoAwaitTag
immediately returns the [google::longrunning::Operation
] that corresponds to the Long Running Operation that has been started. No polling for operation status occurs.
Parameters | |
---|---|
Name | Description |
|
NoAwaitTag
|
parent |
std::string const &
|
opts |
Options
|
Returns | |
---|---|
Type | Description |
StatusOr< google::longrunning::Operation > |
BulkMuteFindings(google::cloud::securitycenter::v1::BulkMuteFindingsRequest const &, Options)
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.
Parameters | |
---|---|
Name | Description |
request |
google::cloud::securitycenter::v1::BulkMuteFindingsRequest const &
Unary RPCs, such as the one wrapped by this function, receive a single |
opts |
Options
Optional. Override the class-level options, such as retry and backoff policies. |
Returns | |
---|---|
Type | Description |
future< StatusOr< google::cloud::securitycenter::v1::BulkMuteFindingsResponse > > |
A |
BulkMuteFindings(NoAwaitTag, google::cloud::securitycenter::v1::BulkMuteFindingsRequest const &, Options)
Kicks off an LRO to bulk mute findings for a parent based on a filter.
Specifying the NoAwaitTag
immediately returns the [google::longrunning::Operation
] that corresponds to the Long Running Operation that has been started. No polling for operation status occurs.
Parameters | |
---|---|
Name | Description |
|
NoAwaitTag
|
request |
google::cloud::securitycenter::v1::BulkMuteFindingsRequest const &
|
opts |
Options
|
Returns | |
---|---|
Type | Description |
StatusOr< google::longrunning::Operation > |
BulkMuteFindings(google::longrunning::Operation const &, Options)
Kicks off an LRO to bulk mute findings for a parent based on a filter.
This method accepts a google::longrunning::Operation
that corresponds to a previously started Long Running Operation (LRO) and polls the status of the LRO in the background.
Parameters | |
---|---|
Name | Description |
operation |
google::longrunning::Operation const &
|
opts |
Options
|
Returns | |
---|---|
Type | Description |
future< StatusOr< google::cloud::securitycenter::v1::BulkMuteFindingsResponse > > |
CreateSecurityHealthAnalyticsCustomModule(std::string const &, google::cloud::securitycenter::v1::SecurityHealthAnalyticsCustomModule const &, Options)
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.
Parameters | |
---|---|
Name | Description |
parent |
std::string const &
Required. Resource name of the new custom module's parent. Its format is |
security_health_analytics_custom_module |
google::cloud::securitycenter::v1::SecurityHealthAnalyticsCustomModule const &
Required. SecurityHealthAnalytics custom module to create. The provided name is ignored and reset with provided parent information and server-generated ID. |
opts |
Options
Optional. Override the class-level options, such as retry and backoff policies. |
Returns | |
---|---|
Type | Description |
StatusOr< google::cloud::securitycenter::v1::SecurityHealthAnalyticsCustomModule > |
the result of the RPC. The response message type (google.cloud.securitycenter.v1.SecurityHealthAnalyticsCustomModule) is mapped to a C++ class using the Protobuf mapping rules. If the request fails, the |
CreateSecurityHealthAnalyticsCustomModule(google::cloud::securitycenter::v1::CreateSecurityHealthAnalyticsCustomModuleRequest const &, Options)
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.
Parameters | |
---|---|
Name | Description |
request |
google::cloud::securitycenter::v1::CreateSecurityHealthAnalyticsCustomModuleRequest const &
Unary RPCs, such as the one wrapped by this function, receive a single |
opts |
Options
Optional. Override the class-level options, such as retry and backoff policies. |
Returns | |
---|---|
Type | Description |
StatusOr< google::cloud::securitycenter::v1::SecurityHealthAnalyticsCustomModule > |
the result of the RPC. The response message type (google.cloud.securitycenter.v1.SecurityHealthAnalyticsCustomModule) is mapped to a C++ class using the Protobuf mapping rules. If the request fails, the |
CreateSource(std::string const &, google::cloud::securitycenter::v1::Source const &, Options)
Creates a source.
Parameters | |
---|---|
Name | Description |
parent |
std::string const &
Required. Resource name of the new source's parent. Its format should be |
source |
google::cloud::securitycenter::v1::Source const &
Required. The Source being created, only the display_name and description will be used. All other fields will be ignored. |
opts |
Options
Optional. Override the class-level options, such as retry and backoff policies. |
Returns | |
---|---|
Type | Description |
StatusOr< google::cloud::securitycenter::v1::Source > |
the result of the RPC. The response message type (google.cloud.securitycenter.v1.Source) is mapped to a C++ class using the Protobuf mapping rules. If the request fails, the |
CreateSource(google::cloud::securitycenter::v1::CreateSourceRequest const &, Options)
Creates a source.
Parameters | |
---|---|
Name | Description |
request |
google::cloud::securitycenter::v1::CreateSourceRequest const &
Unary RPCs, such as the one wrapped by this function, receive a single |
opts |
Options
Optional. Override the class-level options, such as retry and backoff policies. |
Returns | |
---|---|
Type | Description |
StatusOr< google::cloud::securitycenter::v1::Source > |
the result of the RPC. The response message type (google.cloud.securitycenter.v1.Source) is mapped to a C++ class using the Protobuf mapping rules. If the request fails, the |
CreateFinding(std::string const &, std::string const &, google::cloud::securitycenter::v1::Finding const &, Options)
Creates a finding.
The corresponding source must exist for finding creation to succeed.
Parameters | |
---|---|
Name | Description |
parent |
std::string const &
Required. Resource name of the new finding's parent. Its format should be |
finding_id |
std::string const &
Required. Unique identifier provided by the client within the parent scope. It must be alphanumeric and less than or equal to 32 characters and greater than 0 characters in length. |
finding |
google::cloud::securitycenter::v1::Finding const &
Required. The Finding being created. The name and security_marks will be ignored as they are both output only fields on this resource. |
opts |
Options
Optional. Override the class-level options, such as retry and backoff policies. |
Returns | |
---|---|
Type | Description |
StatusOr< google::cloud::securitycenter::v1::Finding > |
the result of the RPC. The response message type (google.cloud.securitycenter.v1.Finding) is mapped to a C++ class using the Protobuf mapping rules. If the request fails, the |
CreateFinding(google::cloud::securitycenter::v1::CreateFindingRequest const &, Options)
Creates a finding.
The corresponding source must exist for finding creation to succeed.
Parameters | |
---|---|
Name | Description |
request |
google::cloud::securitycenter::v1::CreateFindingRequest const &
Unary RPCs, such as the one wrapped by this function, receive a single |
opts |
Options
Optional. Override the class-level options, such as retry and backoff policies. |
Returns | |
---|---|
Type | Description |
StatusOr< google::cloud::securitycenter::v1::Finding > |
the result of the RPC. The response message type (google.cloud.securitycenter.v1.Finding) is mapped to a C++ class using the Protobuf mapping rules. If the request fails, the |
CreateMuteConfig(std::string const &, google::cloud::securitycenter::v1::MuteConfig const &, Options)
Creates a mute config.
Parameters | |
---|---|
Name | Description |
parent |
std::string const &
Required. Resource name of the new mute configs's parent. Its format is |
mute_config |
google::cloud::securitycenter::v1::MuteConfig const &
Required. The mute config being created. |
opts |
Options
Optional. Override the class-level options, such as retry and backoff policies. |
Returns | |
---|---|
Type | Description |
StatusOr< google::cloud::securitycenter::v1::MuteConfig > |
the result of the RPC. The response message type (google.cloud.securitycenter.v1.MuteConfig) is mapped to a C++ class using the Protobuf mapping rules. If the request fails, the |
CreateMuteConfig(std::string const &, google::cloud::securitycenter::v1::MuteConfig const &, std::string const &, Options)
Creates a mute config.
Parameters | |
---|---|
Name | Description |
parent |
std::string const &
Required. Resource name of the new mute configs's parent. Its format is |
mute_config |
google::cloud::securitycenter::v1::MuteConfig const &
Required. The mute config being created. |
mute_config_id |
std::string const &
Required. Unique identifier provided by the client within the parent scope. It must consist of only lowercase letters, numbers, and hyphens, must start with a letter, must end with either a letter or a number, and must be 63 characters or less. |
opts |
Options
Optional. Override the class-level options, such as retry and backoff policies. |
Returns | |
---|---|
Type | Description |
StatusOr< google::cloud::securitycenter::v1::MuteConfig > |
the result of the RPC. The response message type (google.cloud.securitycenter.v1.MuteConfig) is mapped to a C++ class using the Protobuf mapping rules. If the request fails, the |
CreateMuteConfig(google::cloud::securitycenter::v1::CreateMuteConfigRequest const &, Options)
Creates a mute config.
Parameters | |
---|---|
Name | Description |
request |
google::cloud::securitycenter::v1::CreateMuteConfigRequest const &
Unary RPCs, such as the one wrapped by this function, receive a single |
opts |
Options
Optional. Override the class-level options, such as retry and backoff policies. |
Returns | |
---|---|
Type | Description |
StatusOr< google::cloud::securitycenter::v1::MuteConfig > |
the result of the RPC. The response message type (google.cloud.securitycenter.v1.MuteConfig) is mapped to a C++ class using the Protobuf mapping rules. If the request fails, the |
CreateNotificationConfig(std::string const &, std::string const &, google::cloud::securitycenter::v1::NotificationConfig const &, Options)
Creates a notification config.
Parameters | |
---|---|
Name | Description |
parent |
std::string const &
Required. Resource name of the new notification config's parent. Its format is |
config_id |
std::string const &
Required. Unique identifier provided by the client within the parent scope. It must be between 1 and 128 characters and contain alphanumeric characters, underscores, or hyphens only. |
notification_config |
google::cloud::securitycenter::v1::NotificationConfig const &
Required. The notification config being created. The name and the service account will be ignored as they are both output only fields on this resource. |
opts |
Options
Optional. Override the class-level options, such as retry and backoff policies. |
Returns | |
---|---|
Type | Description |
StatusOr< google::cloud::securitycenter::v1::NotificationConfig > |
the result of the RPC. The response message type (google.cloud.securitycenter.v1.NotificationConfig) is mapped to a C++ class using the Protobuf mapping rules. If the request fails, the |
CreateNotificationConfig(std::string const &, google::cloud::securitycenter::v1::NotificationConfig const &, Options)
Creates a notification config.
Parameters | |
---|---|
Name | Description |
parent |
std::string const &
Required. Resource name of the new notification config's parent. Its format is |
notification_config |
google::cloud::securitycenter::v1::NotificationConfig const &
Required. The notification config being created. The name and the service account will be ignored as they are both output only fields on this resource. |
opts |
Options
Optional. Override the class-level options, such as retry and backoff policies. |
Returns | |
---|---|
Type | Description |
StatusOr< google::cloud::securitycenter::v1::NotificationConfig > |
the result of the RPC. The response message type (google.cloud.securitycenter.v1.NotificationConfig) is mapped to a C++ class using the Protobuf mapping rules. If the request fails, the |
CreateNotificationConfig(google::cloud::securitycenter::v1::CreateNotificationConfigRequest const &, Options)
Creates a notification config.
Parameters | |
---|---|
Name | Description |
request |
google::cloud::securitycenter::v1::CreateNotificationConfigRequest const &
Unary RPCs, such as the one wrapped by this function, receive a single |
opts |
Options
Optional. Override the class-level options, such as retry and backoff policies. |
Returns | |
---|---|
Type | Description |
StatusOr< google::cloud::securitycenter::v1::NotificationConfig > |
the result of the RPC. The response message type (google.cloud.securitycenter.v1.NotificationConfig) is mapped to a C++ class using the Protobuf mapping rules. If the request fails, the |
DeleteMuteConfig(std::string const &, Options)
Deletes an existing mute config.
Parameters | |
---|---|
Name | Description |
name |
std::string const &
Required. Name of the mute config to delete. Its format is |
opts |
Options
Optional. Override the class-level options, such as retry and backoff policies. |
Returns | |
---|---|
Type | Description |
Status |
a |
DeleteMuteConfig(google::cloud::securitycenter::v1::DeleteMuteConfigRequest const &, Options)
Deletes an existing mute config.
Parameters | |
---|---|
Name | Description |
request |
google::cloud::securitycenter::v1::DeleteMuteConfigRequest const &
Unary RPCs, such as the one wrapped by this function, receive a single |
opts |
Options
Optional. Override the class-level options, such as retry and backoff policies. |
Returns | |
---|---|
Type | Description |
Status |
a |
DeleteNotificationConfig(std::string const &, Options)
Deletes a notification config.
Parameters | |
---|---|
Name | Description |
name |
std::string const &
Required. Name of the notification config to delete. Its format is |
opts |
Options
Optional. Override the class-level options, such as retry and backoff policies. |
Returns | |
---|---|
Type | Description |
Status |
a |
DeleteNotificationConfig(google::cloud::securitycenter::v1::DeleteNotificationConfigRequest const &, Options)
Deletes a notification config.
Parameters | |
---|---|
Name | Description |
request |
google::cloud::securitycenter::v1::DeleteNotificationConfigRequest const &
Unary RPCs, such as the one wrapped by this function, receive a single |
opts |
Options
Optional. Override the class-level options, such as retry and backoff policies. |
Returns | |
---|---|
Type | Description |
Status |
a |
DeleteSecurityHealthAnalyticsCustomModule(std::string const &, Options)
Deletes the specified SecurityHealthAnalyticsCustomModule and all of its descendants in the CRM hierarchy.
This method is only supported for resident custom modules.
Parameters | |
---|---|
Name | Description |
name |
std::string const &
Required. Name of the custom module to delete. Its format is |
opts |
Options
Optional. Override the class-level options, such as retry and backoff policies. |
Returns | |
---|---|
Type | Description |
Status |
a |
DeleteSecurityHealthAnalyticsCustomModule(google::cloud::securitycenter::v1::DeleteSecurityHealthAnalyticsCustomModuleRequest const &, Options)
Deletes the specified SecurityHealthAnalyticsCustomModule and all of its descendants in the CRM hierarchy.
This method is only supported for resident custom modules.
Parameters | |
---|---|
Name | Description |
request |
google::cloud::securitycenter::v1::DeleteSecurityHealthAnalyticsCustomModuleRequest const &
Unary RPCs, such as the one wrapped by this function, receive a single |
opts |
Options
Optional. Override the class-level options, such as retry and backoff policies. |
Returns | |
---|---|
Type | Description |
Status |
a |
GetSimulation(std::string const &, Options)
Get the simulation by name or the latest simulation for the given organization.
Parameters | |
---|---|
Name | Description |
name |
std::string const &
Required. The organization name or simulation name of this simulation |
opts |
Options
Optional. Override the class-level options, such as retry and backoff policies. |
Returns | |
---|---|
Type | Description |
StatusOr< google::cloud::securitycenter::v1::Simulation > |
the result of the RPC. The response message type (google.cloud.securitycenter.v1.Simulation) is mapped to a C++ class using the Protobuf mapping rules. If the request fails, the |
GetSimulation(google::cloud::securitycenter::v1::GetSimulationRequest const &, Options)
Get the simulation by name or the latest simulation for the given organization.
Parameters | |
---|---|
Name | Description |
request |
google::cloud::securitycenter::v1::GetSimulationRequest const &
Unary RPCs, such as the one wrapped by this function, receive a single |
opts |
Options
Optional. Override the class-level options, such as retry and backoff policies. |
Returns | |
---|---|
Type | Description |
StatusOr< google::cloud::securitycenter::v1::Simulation > |
the result of the RPC. The response message type (google.cloud.securitycenter.v1.Simulation) is mapped to a C++ class using the Protobuf mapping rules. If the request fails, the |
GetValuedResource(std::string const &, Options)
Get the valued resource by name.
Parameters | |
---|---|
Name | Description |
name |
std::string const &
Required. The name of this valued resource |
opts |
Options
Optional. Override the class-level options, such as retry and backoff policies. |
Returns | |
---|---|
Type | Description |
StatusOr< google::cloud::securitycenter::v1::ValuedResource > |
the result of the RPC. The response message type (google.cloud.securitycenter.v1.ValuedResource) is mapped to a C++ class using the Protobuf mapping rules. If the request fails, the |
GetValuedResource(google::cloud::securitycenter::v1::GetValuedResourceRequest const &, Options)
Get the valued resource by name.
Parameters | |
---|---|
Name | Description |
request |
google::cloud::securitycenter::v1::GetValuedResourceRequest const &
Unary RPCs, such as the one wrapped by this function, receive a single |
opts |
Options
Optional. Override the class-level options, such as retry and backoff policies. |
Returns | |
---|---|
Type | Description |
StatusOr< google::cloud::securitycenter::v1::ValuedResource > |
the result of the RPC. The response message type (google.cloud.securitycenter.v1.ValuedResource) is mapped to a C++ class using the Protobuf mapping rules. If the request fails, the |
GetBigQueryExport(std::string const &, Options)
Gets a BigQuery export.
Parameters | |
---|---|
Name | Description |
name |
std::string const &
Required. Name of the BigQuery export to retrieve. Its format is |
opts |
Options
Optional. Override the class-level options, such as retry and backoff policies. |
Returns | |
---|---|
Type | Description |
StatusOr< google::cloud::securitycenter::v1::BigQueryExport > |
the result of the RPC. The response message type (google.cloud.securitycenter.v1.BigQueryExport) is mapped to a C++ class using the Protobuf mapping rules. If the request fails, the |
GetBigQueryExport(google::cloud::securitycenter::v1::GetBigQueryExportRequest const &, Options)
Gets a BigQuery export.
Parameters | |
---|---|
Name | Description |
request |
google::cloud::securitycenter::v1::GetBigQueryExportRequest const &
Unary RPCs, such as the one wrapped by this function, receive a single |
opts |
Options
Optional. Override the class-level options, such as retry and backoff policies. |
Returns | |
---|---|
Type | Description |
StatusOr< google::cloud::securitycenter::v1::BigQueryExport > |
the result of the RPC. The response message type (google.cloud.securitycenter.v1.BigQueryExport) is mapped to a C++ class using the Protobuf mapping rules. If the request fails, the |
GetIamPolicy(std::string const &, Options)
Gets the access control policy on the specified Source.
Parameters | |
---|---|
Name | Description |
resource |
std::string const &
REQUIRED: The resource for which the policy is being requested. See the operation documentation for the appropriate value for this field. |
opts |
Options
Optional. Override the class-level options, such as retry and backoff policies. |
Returns | |
---|---|
Type | Description |
StatusOr< google::iam::v1::Policy > |
the result of the RPC. The response message type (google.iam.v1.Policy) is mapped to a C++ class using the Protobuf mapping rules. If the request fails, the |
GetIamPolicy(google::iam::v1::GetIamPolicyRequest const &, Options)
Gets the access control policy on the specified Source.
Parameters | |
---|---|
Name | Description |
request |
google::iam::v1::GetIamPolicyRequest const &
Unary RPCs, such as the one wrapped by this function, receive a single |
opts |
Options
Optional. Override the class-level options, such as retry and backoff policies. |
Returns | |
---|---|
Type | Description |
StatusOr< google::iam::v1::Policy > |
the result of the RPC. The response message type (google.iam.v1.Policy) is mapped to a C++ class using the Protobuf mapping rules. If the request fails, the |
GetMuteConfig(std::string const &, Options)
Gets a mute config.
Parameters | |
---|---|
Name | Description |
name |
std::string const &
Required. Name of the mute config to retrieve. Its format is |
opts |
Options
Optional. Override the class-level options, such as retry and backoff policies. |
Returns | |
---|---|
Type | Description |
StatusOr< google::cloud::securitycenter::v1::MuteConfig > |
the result of the RPC. The response message type (google.cloud.securitycenter.v1.MuteConfig) is mapped to a C++ class using the Protobuf mapping rules. If the request fails, the |
GetMuteConfig(google::cloud::securitycenter::v1::GetMuteConfigRequest const &, Options)
Gets a mute config.
Parameters | |
---|---|
Name | Description |
request |
google::cloud::securitycenter::v1::GetMuteConfigRequest const &
Unary RPCs, such as the one wrapped by this function, receive a single |
opts |
Options
Optional. Override the class-level options, such as retry and backoff policies. |
Returns | |
---|---|
Type | Description |
StatusOr< google::cloud::securitycenter::v1::MuteConfig > |
the result of the RPC. The response message type (google.cloud.securitycenter.v1.MuteConfig) is mapped to a C++ class using the Protobuf mapping rules. If the request fails, the |
GetNotificationConfig(std::string const &, Options)
Gets a notification config.
Parameters | |
---|---|
Name | Description |
name |
std::string const &
Required. Name of the notification config to get. Its format is |
opts |
Options
Optional. Override the class-level options, such as retry and backoff policies. |
Returns | |
---|---|
Type | Description |
StatusOr< google::cloud::securitycenter::v1::NotificationConfig > |
the result of the RPC. The response message type (google.cloud.securitycenter.v1.NotificationConfig) is mapped to a C++ class using the Protobuf mapping rules. If the request fails, the |
GetNotificationConfig(google::cloud::securitycenter::v1::GetNotificationConfigRequest const &, Options)
Gets a notification config.
Parameters | |
---|---|
Name | Description |
request |
google::cloud::securitycenter::v1::GetNotificationConfigRequest const &
Unary RPCs, such as the one wrapped by this function, receive a single |
opts |
Options
Optional. Override the class-level options, such as retry and backoff policies. |
Returns | |
---|---|
Type | Description |
StatusOr< google::cloud::securitycenter::v1::NotificationConfig > |
the result of the RPC. The response message type (google.cloud.securitycenter.v1.NotificationConfig) is mapped to a C++ class using the Protobuf mapping rules. If the request fails, the |
GetOrganizationSettings(std::string const &, Options)
Gets the settings for an organization.
Parameters | |
---|---|
Name | Description |
name |
std::string const &
Required. Name of the organization to get organization settings for. Its format is |
opts |
Options
Optional. Override the class-level options, such as retry and backoff policies. |
Returns | |
---|---|
Type | Description |
StatusOr< google::cloud::securitycenter::v1::OrganizationSettings > |
the result of the RPC. The response message type (google.cloud.securitycenter.v1.OrganizationSettings) is mapped to a C++ class using the Protobuf mapping rules. If the request fails, the |
GetOrganizationSettings(google::cloud::securitycenter::v1::GetOrganizationSettingsRequest const &, Options)
Gets the settings for an organization.
Parameters | |
---|---|
Name | Description |
request |
google::cloud::securitycenter::v1::GetOrganizationSettingsRequest const &
Unary RPCs, such as the one wrapped by this function, receive a single |
opts |
Options
Optional. Override the class-level options, such as retry and backoff policies. |
Returns | |
---|---|
Type | Description |
StatusOr< google::cloud::securitycenter::v1::OrganizationSettings > |
the result of the RPC. The response message type (google.cloud.securitycenter.v1.OrganizationSettings) is mapped to a C++ class using the Protobuf mapping rules. If the request fails, the |
GetEffectiveSecurityHealthAnalyticsCustomModule(std::string const &, Options)
Retrieves an EffectiveSecurityHealthAnalyticsCustomModule.
Parameters | |
---|---|
Name | Description |
name |
std::string const &
Required. Name of the effective custom module to get. Its format is |
opts |
Options
Optional. Override the class-level options, such as retry and backoff policies. |
Returns | |
---|---|
Type | Description |
StatusOr< google::cloud::securitycenter::v1::EffectiveSecurityHealthAnalyticsCustomModule > |
the result of the RPC. The response message type (google.cloud.securitycenter.v1.EffectiveSecurityHealthAnalyticsCustomModule) is mapped to a C++ class using the Protobuf mapping rules. If the request fails, the |
GetEffectiveSecurityHealthAnalyticsCustomModule(google::cloud::securitycenter::v1::GetEffectiveSecurityHealthAnalyticsCustomModuleRequest const &, Options)
Retrieves an EffectiveSecurityHealthAnalyticsCustomModule.
Parameters | |
---|---|
Name | Description |
request |
google::cloud::securitycenter::v1::GetEffectiveSecurityHealthAnalyticsCustomModuleRequest const &
Unary RPCs, such as the one wrapped by this function, receive a single |
opts |
Options
Optional. Override the class-level options, such as retry and backoff policies. |
Returns | |
---|---|
Type | Description |
StatusOr< google::cloud::securitycenter::v1::EffectiveSecurityHealthAnalyticsCustomModule > |
the result of the RPC. The response message type (google.cloud.securitycenter.v1.EffectiveSecurityHealthAnalyticsCustomModule) is mapped to a C++ class using the Protobuf mapping rules. If the request fails, the |
GetSecurityHealthAnalyticsCustomModule(std::string const &, Options)
Retrieves a SecurityHealthAnalyticsCustomModule.
Parameters | |
---|---|
Name | Description |
name |
std::string const &
Required. Name of the custom module to get. Its format is |
opts |
Options
Optional. Override the class-level options, such as retry and backoff policies. |
Returns | |
---|---|
Type | Description |
StatusOr< google::cloud::securitycenter::v1::SecurityHealthAnalyticsCustomModule > |
the result of the RPC. The response message type (google.cloud.securitycenter.v1.SecurityHealthAnalyticsCustomModule) is mapped to a C++ class using the Protobuf mapping rules. If the request fails, the |
GetSecurityHealthAnalyticsCustomModule(google::cloud::securitycenter::v1::GetSecurityHealthAnalyticsCustomModuleRequest const &, Options)
Retrieves a SecurityHealthAnalyticsCustomModule.
Parameters | |
---|---|
Name | Description |
request |
google::cloud::securitycenter::v1::GetSecurityHealthAnalyticsCustomModuleRequest const &
Unary RPCs, such as the one wrapped by this function, receive a single |
opts |
Options
Optional. Override the class-level options, such as retry and backoff policies. |
Returns | |
---|---|
Type | Description |
StatusOr< google::cloud::securitycenter::v1::SecurityHealthAnalyticsCustomModule > |
the result of the RPC. The response message type (google.cloud.securitycenter.v1.SecurityHealthAnalyticsCustomModule) is mapped to a C++ class using the Protobuf mapping rules. If the request fails, the |
GetSource(std::string const &, Options)
Gets a source.
Parameters | |
---|---|
Name | Description |
name |
std::string const &
Required. Relative resource name of the source. Its format is |
opts |
Options
Optional. Override the class-level options, such as retry and backoff policies. |
Returns | |
---|---|
Type | Description |
StatusOr< google::cloud::securitycenter::v1::Source > |
the result of the RPC. The response message type (google.cloud.securitycenter.v1.Source) is mapped to a C++ class using the Protobuf mapping rules. If the request fails, the |
GetSource(google::cloud::securitycenter::v1::GetSourceRequest const &, Options)
Gets a source.
Parameters | |
---|---|
Name | Description |
request |
google::cloud::securitycenter::v1::GetSourceRequest const &
Unary RPCs, such as the one wrapped by this function, receive a single |
opts |
Options
Optional. Override the class-level options, such as retry and backoff policies. |
Returns | |
---|---|
Type | Description |
StatusOr< google::cloud::securitycenter::v1::Source > |
the result of the RPC. The response message type (google.cloud.securitycenter.v1.Source) is mapped to a C++ class using the Protobuf mapping rules. If the request fails, the |
GroupAssets(google::cloud::securitycenter::v1::GroupAssetsRequest, Options)
Filters an organization's assets and groups them by their specified properties.
Parameters | |
---|---|
Name | Description |
request |
google::cloud::securitycenter::v1::GroupAssetsRequest
Unary RPCs, such as the one wrapped by this function, receive a single |
opts |
Options
Optional. Override the class-level options, such as retry and backoff policies. |
Returns | |
---|---|
Type | Description |
StreamRange< google::cloud::securitycenter::v1::GroupResult > |
a StreamRange to iterate of the results. See the documentation of this type for details. In brief, this class has |
GroupFindings(std::string const &, std::string const &, Options)
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
Parameters | |
---|---|
Name | Description |
parent |
std::string const &
Required. Name of the source to groupBy. Its format is |
group_by |
std::string const &
Required. Expression that defines what assets fields to use for grouping (including
|
opts |
Options
Optional. Override the class-level options, such as retry and backoff policies. |
Returns | |
---|---|
Type | Description |
StreamRange< google::cloud::securitycenter::v1::GroupResult > |
a StreamRange to iterate of the results. See the documentation of this type for details. In brief, this class has |
GroupFindings(google::cloud::securitycenter::v1::GroupFindingsRequest, Options)
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
Parameters | |
---|---|
Name | Description |
request |
google::cloud::securitycenter::v1::GroupFindingsRequest
Unary RPCs, such as the one wrapped by this function, receive a single |
opts |
Options
Optional. Override the class-level options, such as retry and backoff policies. |
Returns | |
---|---|
Type | Description |
StreamRange< google::cloud::securitycenter::v1::GroupResult > |
a StreamRange to iterate of the results. See the documentation of this type for details. In brief, this class has |
ListAssets(google::cloud::securitycenter::v1::ListAssetsRequest, Options)
Lists an organization's assets.
Parameters | |
---|---|
Name | Description |
request |
google::cloud::securitycenter::v1::ListAssetsRequest
Unary RPCs, such as the one wrapped by this function, receive a single |
opts |
Options
Optional. Override the class-level options, such as retry and backoff policies. |
Returns | |
---|---|
Type | Description |
StreamRange< google::cloud::securitycenter::v1::ListAssetsResponse::ListAssetsResult > |
a StreamRange to iterate of the results. See the documentation of this type for details. In brief, this class has |
ListDescendantSecurityHealthAnalyticsCustomModules(std::string const &, Options)
Returns a list of all resident SecurityHealthAnalyticsCustomModules under the given CRM parent and all of the parent’s CRM descendants.
Parameters | |
---|---|
Name | Description |
parent |
std::string const &
Required. Name of parent to list descendant custom modules. Its format is |
opts |
Options
Optional. Override the class-level options, such as retry and backoff policies. |
Returns | |
---|---|
Type | Description |
StreamRange< google::cloud::securitycenter::v1::SecurityHealthAnalyticsCustomModule > |
a StreamRange to iterate of the results. See the documentation of this type for details. In brief, this class has |
ListDescendantSecurityHealthAnalyticsCustomModules(google::cloud::securitycenter::v1::ListDescendantSecurityHealthAnalyticsCustomModulesRequest, Options)
Returns a list of all resident SecurityHealthAnalyticsCustomModules under the given CRM parent and all of the parent’s CRM descendants.
Parameters | |
---|---|
Name | Description |
request |
google::cloud::securitycenter::v1::ListDescendantSecurityHealthAnalyticsCustomModulesRequest
Unary RPCs, such as the one wrapped by this function, receive a single |
opts |
Options
Optional. Override the class-level options, such as retry and backoff policies. |
Returns | |
---|---|
Type | Description |
StreamRange< google::cloud::securitycenter::v1::SecurityHealthAnalyticsCustomModule > |
a StreamRange to iterate of the results. See the documentation of this type for details. In brief, this class has |
ListFindings(google::cloud::securitycenter::v1::ListFindingsRequest, Options)
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
Parameters | |
---|---|
Name | Description |
request |
google::cloud::securitycenter::v1::ListFindingsRequest
Unary RPCs, such as the one wrapped by this function, receive a single |
opts |
Options
Optional. Override the class-level options, such as retry and backoff policies. |
Returns | |
---|---|
Type | Description |
StreamRange< google::cloud::securitycenter::v1::ListFindingsResponse::ListFindingsResult > |
a StreamRange to iterate of the results. See the documentation of this type for details. In brief, this class has |
ListMuteConfigs(std::string const &, Options)
Lists mute configs.
Parameters | |
---|---|
Name | Description |
parent |
std::string const &
Required. The parent, which owns the collection of mute configs. Its format is |
opts |
Options
Optional. Override the class-level options, such as retry and backoff policies. |
Returns | |
---|---|
Type | Description |
StreamRange< google::cloud::securitycenter::v1::MuteConfig > |
a StreamRange to iterate of the results. See the documentation of this type for details. In brief, this class has |
ListMuteConfigs(google::cloud::securitycenter::v1::ListMuteConfigsRequest, Options)
Lists mute configs.
Parameters | |
---|---|
Name | Description |
request |
google::cloud::securitycenter::v1::ListMuteConfigsRequest
Unary RPCs, such as the one wrapped by this function, receive a single |
opts |
Options
Optional. Override the class-level options, such as retry and backoff policies. |
Returns | |
---|---|
Type | Description |
StreamRange< google::cloud::securitycenter::v1::MuteConfig > |
a StreamRange to iterate of the results. See the documentation of this type for details. In brief, this class has |
ListNotificationConfigs(std::string const &, Options)
Lists notification configs.
Parameters | |
---|---|
Name | Description |
parent |
std::string const &
Required. The name of the parent in which to list the notification configurations. Its format is "organizations/[organization_id]", "folders/[folder_id]", or "projects/[project_id]". |
opts |
Options
Optional. Override the class-level options, such as retry and backoff policies. |
Returns | |
---|---|
Type | Description |
StreamRange< google::cloud::securitycenter::v1::NotificationConfig > |
a StreamRange to iterate of the results. See the documentation of this type for details. In brief, this class has |
ListNotificationConfigs(google::cloud::securitycenter::v1::ListNotificationConfigsRequest, Options)
Lists notification configs.
Parameters | |
---|---|
Name | Description |
request |
google::cloud::securitycenter::v1::ListNotificationConfigsRequest
Unary RPCs, such as the one wrapped by this function, receive a single |
opts |
Options
Optional. Override the class-level options, such as retry and backoff policies. |
Returns | |
---|---|
Type | Description |
StreamRange< google::cloud::securitycenter::v1::NotificationConfig > |
a StreamRange to iterate of the results. See the documentation of this type for details. In brief, this class has |
ListEffectiveSecurityHealthAnalyticsCustomModules(std::string const &, Options)
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.
Parameters | |
---|---|
Name | Description |
parent |
std::string const &
Required. Name of parent to list effective custom modules. Its format is |
opts |
Options
Optional. Override the class-level options, such as retry and backoff policies. |
Returns | |
---|---|
Type | Description |
StreamRange< google::cloud::securitycenter::v1::EffectiveSecurityHealthAnalyticsCustomModule > |
a StreamRange to iterate of the results. See the documentation of this type for details. In brief, this class has |
ListEffectiveSecurityHealthAnalyticsCustomModules(google::cloud::securitycenter::v1::ListEffectiveSecurityHealthAnalyticsCustomModulesRequest, Options)
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.
Parameters | |
---|---|
Name | Description |
request |
google::cloud::securitycenter::v1::ListEffectiveSecurityHealthAnalyticsCustomModulesRequest
Unary RPCs, such as the one wrapped by this function, receive a single |
opts |
Options
Optional. Override the class-level options, such as retry and backoff policies. |
Returns | |
---|---|
Type | Description |
StreamRange< google::cloud::securitycenter::v1::EffectiveSecurityHealthAnalyticsCustomModule > |
a StreamRange to iterate of the results. See the documentation of this type for details. In brief, this class has |
ListSecurityHealthAnalyticsCustomModules(std::string const &, Options)
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.
Parameters | |
---|---|
Name | Description |
parent |
std::string const &
Required. Name of parent to list custom modules. Its format is |
opts |
Options
Optional. Override the class-level options, such as retry and backoff policies. |
Returns | |
---|---|
Type | Description |
StreamRange< google::cloud::securitycenter::v1::SecurityHealthAnalyticsCustomModule > |
a StreamRange to iterate of the results. See the documentation of this type for details. In brief, this class has |
ListSecurityHealthAnalyticsCustomModules(google::cloud::securitycenter::v1::ListSecurityHealthAnalyticsCustomModulesRequest, Options)
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.
Parameters | |
---|---|
Name | Description |
request |
google::cloud::securitycenter::v1::ListSecurityHealthAnalyticsCustomModulesRequest
Unary RPCs, such as the one wrapped by this function, receive a single |
opts |
Options
Optional. Override the class-level options, such as retry and backoff policies. |
Returns | |
---|---|
Type | Description |
StreamRange< google::cloud::securitycenter::v1::SecurityHealthAnalyticsCustomModule > |
a StreamRange to iterate of the results. See the documentation of this type for details. In brief, this class has |
ListSources(std::string const &, Options)
Lists all sources belonging to an organization.
Parameters | |
---|---|
Name | Description |
parent |
std::string const &
Required. Resource name of the parent of sources to list. Its format should be |
opts |
Options
Optional. Override the class-level options, such as retry and backoff policies. |
Returns | |
---|---|
Type | Description |
StreamRange< google::cloud::securitycenter::v1::Source > |
a StreamRange to iterate of the results. See the documentation of this type for details. In brief, this class has |
ListSources(google::cloud::securitycenter::v1::ListSourcesRequest, Options)
Lists all sources belonging to an organization.
Parameters | |
---|---|
Name | Description |
request |
google::cloud::securitycenter::v1::ListSourcesRequest
Unary RPCs, such as the one wrapped by this function, receive a single |
opts |
Options
Optional. Override the class-level options, such as retry and backoff policies. |
Returns | |
---|---|
Type | Description |
StreamRange< google::cloud::securitycenter::v1::Source > |
a StreamRange to iterate of the results. See the documentation of this type for details. In brief, this class has |
RunAssetDiscovery(std::string const &, Options)
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.
Parameters | |
---|---|
Name | Description |
parent |
std::string const &
Required. Name of the organization to run asset discovery for. Its format is |
opts |
Options
Optional. Override the class-level options, such as retry and backoff policies. |
Returns | |
---|---|
Type | Description |
future< StatusOr< google::cloud::securitycenter::v1::RunAssetDiscoveryResponse > > |
A |
RunAssetDiscovery(NoAwaitTag, std::string const &, Options)
Specifying the NoAwaitTag
immediately returns the [google::longrunning::Operation
] that corresponds to the Long Running Operation that has been started. No polling for operation status occurs.
Parameters | |
---|---|
Name | Description |
|
NoAwaitTag
|
parent |
std::string const &
|
opts |
Options
|
Returns | |
---|---|
Type | Description |
StatusOr< google::longrunning::Operation > |
RunAssetDiscovery(google::cloud::securitycenter::v1::RunAssetDiscoveryRequest const &, Options)
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.
Parameters | |
---|---|
Name | Description |
request |
google::cloud::securitycenter::v1::RunAssetDiscoveryRequest const &
Unary RPCs, such as the one wrapped by this function, receive a single |
opts |
Options
Optional. Override the class-level options, such as retry and backoff policies. |
Returns | |
---|---|
Type | Description |
future< StatusOr< google::cloud::securitycenter::v1::RunAssetDiscoveryResponse > > |
A |
RunAssetDiscovery(NoAwaitTag, google::cloud::securitycenter::v1::RunAssetDiscoveryRequest const &, Options)
Specifying the NoAwaitTag
immediately returns the [google::longrunning::Operation
] that corresponds to the Long Running Operation that has been started. No polling for operation status occurs.
Parameters | |
---|---|
Name | Description |
|
NoAwaitTag
|
request |
google::cloud::securitycenter::v1::RunAssetDiscoveryRequest const &
|
opts |
Options
|
Returns | |
---|---|
Type | Description |
StatusOr< google::longrunning::Operation > |
RunAssetDiscovery(google::longrunning::Operation const &, Options)
This method accepts a google::longrunning::Operation
that corresponds to a previously started Long Running Operation (LRO) and polls the status of the LRO in the background.
Parameters | |
---|---|
Name | Description |
operation |
google::longrunning::Operation const &
|
opts |
Options
|
Returns | |
---|---|
Type | Description |
future< StatusOr< google::cloud::securitycenter::v1::RunAssetDiscoveryResponse > > |
SetFindingState(std::string const &, google::cloud::securitycenter::v1::Finding::State, google::protobuf::Timestamp const &, Options)
Updates the state of a finding.
Parameters | |
---|---|
Name | Description |
name |
std::string const &
Required. The relative resource name of the finding. Example: |
state |
google::cloud::securitycenter::v1::Finding::State
Required. The desired State of the finding. |
start_time |
google::protobuf::Timestamp const &
Required. The time at which the updated state takes effect. |
opts |
Options
Optional. Override the class-level options, such as retry and backoff policies. |
Returns | |
---|---|
Type | Description |
StatusOr< google::cloud::securitycenter::v1::Finding > |
the result of the RPC. The response message type (google.cloud.securitycenter.v1.Finding) is mapped to a C++ class using the Protobuf mapping rules. If the request fails, the |
SetFindingState(google::cloud::securitycenter::v1::SetFindingStateRequest const &, Options)
Updates the state of a finding.
Parameters | |
---|---|
Name | Description |
request |
google::cloud::securitycenter::v1::SetFindingStateRequest const &
Unary RPCs, such as the one wrapped by this function, receive a single |
opts |
Options
Optional. Override the class-level options, such as retry and backoff policies. |
Returns | |
---|---|
Type | Description |
StatusOr< google::cloud::securitycenter::v1::Finding > |
the result of the RPC. The response message type (google.cloud.securitycenter.v1.Finding) is mapped to a C++ class using the Protobuf mapping rules. If the request fails, the |
SetMute(std::string const &, google::cloud::securitycenter::v1::Finding::Mute, Options)
Updates the mute state of a finding.
Parameters | |
---|---|
Name | Description |
name |
std::string const &
Required. The relative resource name of the finding. Example: |
mute |
google::cloud::securitycenter::v1::Finding::Mute
Required. The desired state of the Mute. |
opts |
Options
Optional. Override the class-level options, such as retry and backoff policies. |
Returns | |
---|---|
Type | Description |
StatusOr< google::cloud::securitycenter::v1::Finding > |
the result of the RPC. The response message type (google.cloud.securitycenter.v1.Finding) is mapped to a C++ class using the Protobuf mapping rules. If the request fails, the |
SetMute(google::cloud::securitycenter::v1::SetMuteRequest const &, Options)
Updates the mute state of a finding.