Class SecurityCenterClient (2.29.0)

V2 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

BatchCreateResourceValueConfigs(std::string const &, std::vector< google::cloud::securitycenter::v2::CreateResourceValueConfigRequest > const &, Options)

Creates a ResourceValueConfig for an organization.

Maps user's tags to difference resource values for use by the attack path simulation.

Parameters
Name Description
parent std::string const &

Required. Resource name of the new ResourceValueConfig's parent. The parent field in the CreateResourceValueConfigRequest messages must either be empty or match this field.

requests std::vector< google::cloud::securitycenter::v2::CreateResourceValueConfigRequest > const &

Required. The resource value configs to be created.

opts Options

Optional. Override the class-level options, such as retry and backoff policies.

Returns
Type Description
StatusOr< google::cloud::securitycenter::v2::BatchCreateResourceValueConfigsResponse >

the result of the RPC. The response message type (google.cloud.securitycenter.v2.BatchCreateResourceValueConfigsResponse) is mapped to a C++ class using the Protobuf mapping rules. If the request fails, the StatusOr contains the error details.

BatchCreateResourceValueConfigs(google::cloud::securitycenter::v2::BatchCreateResourceValueConfigsRequest const &, Options)

Creates a ResourceValueConfig for an organization.

Maps user's tags to difference resource values for use by the attack path simulation.

Parameters
Name Description
request google::cloud::securitycenter::v2::BatchCreateResourceValueConfigsRequest const &

Unary RPCs, such as the one wrapped by this function, receive a single request proto message which includes all the inputs for the RPC. In this case, the proto message is a google.cloud.securitycenter.v2.BatchCreateResourceValueConfigsRequest. Proto messages are converted to C++ classes by Protobuf, using the Protobuf mapping rules.

opts Options

Optional. Override the class-level options, such as retry and backoff policies.

Returns
Type Description
StatusOr< google::cloud::securitycenter::v2::BatchCreateResourceValueConfigsResponse >

the result of the RPC. The response message type (google.cloud.securitycenter.v2.BatchCreateResourceValueConfigsResponse) is mapped to a C++ class using the Protobuf mapping rules. If the request fails, the StatusOr contains the error details.

BulkMuteFindings(std::string const &, Options)

Kicks off an LRO to bulk mute findings for a parent based on a filter.

If no location is specified, findings are muted in global. 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. If no location is specified, findings are updated in global. The following list shows some examples:

  • organizations/[organization_id]
  • organizations/[organization_id]/locations/[location_id]
  • folders/[folder_id]
  • folders/[folder_id]/locations/[location_id]
  • projects/[project_id]
  • projects/[project_id]/locations/[location_id]
opts Options

Optional. Override the class-level options, such as retry and backoff policies.

Returns
Type Description
future< StatusOr< google::cloud::securitycenter::v2::BulkMuteFindingsResponse > >

A future that becomes satisfied when the LRO (Long Running Operation) completes or the polling policy in effect for this call is exhausted. The future is satisfied with an error if the LRO completes with an error or the polling policy is exhausted. In this case the StatusOr returned by the future contains the error. If the LRO completes successfully the value of the future contains the LRO's result. For this RPC the result is a google.cloud.securitycenter.v2.BulkMuteFindingsResponse proto message. The C++ class representing this message is created by Protobuf, using the Protobuf mapping rules.

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::v2::BulkMuteFindingsRequest const &, Options)

Kicks off an LRO to bulk mute findings for a parent based on a filter.

If no location is specified, findings are muted in global. 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::v2::BulkMuteFindingsRequest const &

Unary RPCs, such as the one wrapped by this function, receive a single request proto message which includes all the inputs for the RPC. In this case, the proto message is a google.cloud.securitycenter.v2.BulkMuteFindingsRequest. Proto messages are converted to C++ classes by Protobuf, using the Protobuf mapping rules.

opts Options

Optional. Override the class-level options, such as retry and backoff policies.

Returns
Type Description
future< StatusOr< google::cloud::securitycenter::v2::BulkMuteFindingsResponse > >

A future that becomes satisfied when the LRO (Long Running Operation) completes or the polling policy in effect for this call is exhausted. The future is satisfied with an error if the LRO completes with an error or the polling policy is exhausted. In this case the StatusOr returned by the future contains the error. If the LRO completes successfully the value of the future contains the LRO's result. For this RPC the result is a google.cloud.securitycenter.v2.BulkMuteFindingsResponse proto message. The C++ class representing this message is created by Protobuf, using the Protobuf mapping rules.

BulkMuteFindings(NoAwaitTag, google::cloud::securitycenter::v2::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::v2::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::v2::BulkMuteFindingsResponse > >

CreateBigQueryExport(std::string const &, google::cloud::securitycenter::v2::BigQueryExport const &, std::string const &, Options)

Creates a BigQuery export.

Parameters
Name Description
parent std::string const &

Required. The name of the parent resource of the new BigQuery export. Its format is organizations/[organization_id]/locations/[location_id], folders/[folder_id]/locations/[location_id], or projects/[project_id]/locations/[location_id].

big_query_export google::cloud::securitycenter::v2::BigQueryExport const &

Required. The BigQuery export being created.

big_query_export_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::v2::BigQueryExport >

the result of the RPC. The response message type (google.cloud.securitycenter.v2.BigQueryExport) is mapped to a C++ class using the Protobuf mapping rules. If the request fails, the StatusOr contains the error details.

CreateBigQueryExport(google::cloud::securitycenter::v2::CreateBigQueryExportRequest const &, Options)

Creates a BigQuery export.

Parameters
Name Description
request google::cloud::securitycenter::v2::CreateBigQueryExportRequest const &

Unary RPCs, such as the one wrapped by this function, receive a single request proto message which includes all the inputs for the RPC. In this case, the proto message is a google.cloud.securitycenter.v2.CreateBigQueryExportRequest. Proto messages are converted to C++ classes by Protobuf, using the Protobuf mapping rules.

opts Options

Optional. Override the class-level options, such as retry and backoff policies.

Returns
Type Description
StatusOr< google::cloud::securitycenter::v2::BigQueryExport >

the result of the RPC. The response message type (google.cloud.securitycenter.v2.BigQueryExport) is mapped to a C++ class using the Protobuf mapping rules. If the request fails, the StatusOr contains the error details.

CreateFinding(std::string const &, google::cloud::securitycenter::v2::Finding const &, std::string const &, Options)

Creates a finding in a location.

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. The following list shows some examples of the format:

  • organizations/[organization_id]/sources/[source_id]
  • organizations/[organization_id]/sources/[source_id]/locations/[location_id]
finding google::cloud::securitycenter::v2::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.

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.

opts Options

Optional. Override the class-level options, such as retry and backoff policies.

Returns
Type Description
StatusOr< google::cloud::securitycenter::v2::Finding >

the result of the RPC. The response message type (google.cloud.securitycenter.v2.Finding) is mapped to a C++ class using the Protobuf mapping rules. If the request fails, the StatusOr contains the error details.

CreateFinding(google::cloud::securitycenter::v2::CreateFindingRequest const &, Options)

Creates a finding in a location.

The corresponding source must exist for finding creation to succeed.

Parameters
Name Description
request google::cloud::securitycenter::v2::CreateFindingRequest const &

Unary RPCs, such as the one wrapped by this function, receive a single request proto message which includes all the inputs for the RPC. In this case, the proto message is a google.cloud.securitycenter.v2.CreateFindingRequest. Proto messages are converted to C++ classes by Protobuf, using the Protobuf mapping rules.

opts Options

Optional. Override the class-level options, such as retry and backoff policies.

Returns
Type Description
StatusOr< google::cloud::securitycenter::v2::Finding >

the result of the RPC. The response message type (google.cloud.securitycenter.v2.Finding) is mapped to a C++ class using the Protobuf mapping rules. If the request fails, the StatusOr contains the error details.

CreateMuteConfig(std::string const &, google::cloud::securitycenter::v2::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 organizations/[organization_id]/locations/[location_id], folders/[folder_id]/locations/[location_id], or projects/[project_id]/locations/[location_id].

mute_config google::cloud::securitycenter::v2::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::v2::MuteConfig >

the result of the RPC. The response message type (google.cloud.securitycenter.v2.MuteConfig) is mapped to a C++ class using the Protobuf mapping rules. If the request fails, the StatusOr contains the error details.

CreateMuteConfig(google::cloud::securitycenter::v2::CreateMuteConfigRequest const &, Options)

Creates a mute config.

Parameters
Name Description
request google::cloud::securitycenter::v2::CreateMuteConfigRequest const &

Unary RPCs, such as the one wrapped by this function, receive a single request proto message which includes all the inputs for the RPC. In this case, the proto message is a google.cloud.securitycenter.v2.CreateMuteConfigRequest. Proto messages are converted to C++ classes by Protobuf, using the Protobuf mapping rules.

opts Options

Optional. Override the class-level options, such as retry and backoff policies.

Returns
Type Description
StatusOr< google::cloud::securitycenter::v2::MuteConfig >

the result of the RPC. The response message type (google.cloud.securitycenter.v2.MuteConfig) is mapped to a C++ class using the Protobuf mapping rules. If the request fails, the StatusOr contains the error details.

CreateNotificationConfig(std::string const &, google::cloud::securitycenter::v2::NotificationConfig const &, std::string 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 organizations/[organization_id]/locations/[location_id], folders/[folder_id]/locations/[location_id], or projects/[project_id]/locations/[location_id].

notification_config google::cloud::securitycenter::v2::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.

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.

opts Options

Optional. Override the class-level options, such as retry and backoff policies.

Returns
Type Description
StatusOr< google::cloud::securitycenter::v2::NotificationConfig >

the result of the RPC. The response message type (google.cloud.securitycenter.v2.NotificationConfig) is mapped to a C++ class using the Protobuf mapping rules. If the request fails, the StatusOr contains the error details.

CreateNotificationConfig(google::cloud::securitycenter::v2::CreateNotificationConfigRequest const &, Options)

Creates a notification config.

Parameters
Name Description
request google::cloud::securitycenter::v2::CreateNotificationConfigRequest const &

Unary RPCs, such as the one wrapped by this function, receive a single request proto message which includes all the inputs for the RPC. In this case, the proto message is a google.cloud.securitycenter.v2.CreateNotificationConfigRequest. Proto messages are converted to C++ classes by Protobuf, using the Protobuf mapping rules.

opts Options

Optional. Override the class-level options, such as retry and backoff policies.

Returns
Type Description
StatusOr< google::cloud::securitycenter::v2::NotificationConfig >

the result of the RPC. The response message type (google.cloud.securitycenter.v2.NotificationConfig) is mapped to a C++ class using the Protobuf mapping rules. If the request fails, the StatusOr contains the error details.

CreateSource(std::string const &, google::cloud::securitycenter::v2::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 organizations/[organization_id].

source google::cloud::securitycenter::v2::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::v2::Source >

the result of the RPC. The response message type (google.cloud.securitycenter.v2.Source) is mapped to a C++ class using the Protobuf mapping rules. If the request fails, the StatusOr contains the error details.

CreateSource(google::cloud::securitycenter::v2::CreateSourceRequest const &, Options)

Creates a source.

Parameters
Name Description
request google::cloud::securitycenter::v2::CreateSourceRequest const &

Unary RPCs, such as the one wrapped by this function, receive a single request proto message which includes all the inputs for the RPC. In this case, the proto message is a google.cloud.securitycenter.v2.CreateSourceRequest. Proto messages are converted to C++ classes by Protobuf, using the Protobuf mapping rules.

opts Options

Optional. Override the class-level options, such as retry and backoff policies.

Returns
Type Description
StatusOr< google::cloud::securitycenter::v2::Source >

the result of the RPC. The response message type (google.cloud.securitycenter.v2.Source) is mapped to a C++ class using the Protobuf mapping rules. If the request fails, the StatusOr contains the error details.

DeleteBigQueryExport(std::string const &, Options)

Deletes an existing BigQuery export.

Parameters
Name Description
name std::string const &

Required. The name of the BigQuery export to delete. The following list shows some examples of the format:

  • organizations/{organization}/locations/{location}/bigQueryExports/{export_id}
  • folders/{folder}/locations/{location}/bigQueryExports/{export_id}
  • projects/{project}/locations/{location}/bigQueryExports/{export_id}
opts Options

Optional. Override the class-level options, such as retry and backoff policies.

Returns
Type Description
Status

a Status object. If the request failed, the status contains the details of the failure.

DeleteBigQueryExport(google::cloud::securitycenter::v2::DeleteBigQueryExportRequest const &, Options)

Deletes an existing BigQuery export.

Parameters
Name Description
request google::cloud::securitycenter::v2::DeleteBigQueryExportRequest const &

Unary RPCs, such as the one wrapped by this function, receive a single request proto message which includes all the inputs for the RPC. In this case, the proto message is a google.cloud.securitycenter.v2.DeleteBigQueryExportRequest. Proto messages are converted to C++ classes by Protobuf, using the Protobuf mapping rules.

opts Options

Optional. Override the class-level options, such as retry and backoff policies.

Returns
Type Description
Status

a Status object. If the request failed, the status contains the details of the failure.

DeleteMuteConfig(std::string const &, Options)

Deletes an existing mute config.

If no location is specified, default is global.

Parameters
Name Description
name std::string const &

Required. Name of the mute config to delete. The following list shows some examples of the format:

  • organizations/{organization}/muteConfigs/{config_id}
  • organizations/{organization}/locations/{location}/muteConfigs/{config_id}
  • folders/{folder}/muteConfigs/{config_id}
  • folders/{folder}/locations/{location}/muteConfigs/{config_id}
  • projects/{project}/muteConfigs/{config_id}
  • projects/{project}/locations/{location}/muteConfigs/{config_id}
opts Options

Optional. Override the class-level options, such as retry and backoff policies.

Returns
Type Description
Status

a Status object. If the request failed, the status contains the details of the failure.

DeleteMuteConfig(google::cloud::securitycenter::v2::DeleteMuteConfigRequest const &, Options)

Deletes an existing mute config.

If no location is specified, default is global.

Parameters
Name Description
request google::cloud::securitycenter::v2::DeleteMuteConfigRequest const &

Unary RPCs, such as the one wrapped by this function, receive a single request proto message which includes all the inputs for the RPC. In this case, the proto message is a google.cloud.securitycenter.v2.DeleteMuteConfigRequest. Proto messages are converted to C++ classes by Protobuf, using the Protobuf mapping rules.

opts Options

Optional. Override the class-level options, such as retry and backoff policies.

Returns
Type Description
Status

a Status object. If the request failed, the status contains the details of the failure.

DeleteNotificationConfig(std::string const &, Options)

Deletes a notification config.

Parameters
Name Description
name std::string const &

Required. Name of the notification config to delete. The following list shows some examples of the format:

  • organizations/[organization_id]/locations/[location_id]/notificationConfigs/[config_id]
  • folders/[folder_id]/locations/[location_id]notificationConfigs/[config_id]
  • projects/[project_id]/locations/[location_id]notificationConfigs/[config_id]
opts Options

Optional. Override the class-level options, such as retry and backoff policies.

Returns
Type Description
Status

a Status object. If the request failed, the status contains the details of the failure.

DeleteNotificationConfig(google::cloud::securitycenter::v2::DeleteNotificationConfigRequest const &, Options)

Deletes a notification config.

Parameters
Name Description
request google::cloud::securitycenter::v2::DeleteNotificationConfigRequest const &

Unary RPCs, such as the one wrapped by this function, receive a single request proto message which includes all the inputs for the RPC. In this case, the proto message is a google.cloud.securitycenter.v2.DeleteNotificationConfigRequest. Proto messages are converted to C++ classes by Protobuf, using the Protobuf mapping rules.

opts Options

Optional. Override the class-level options, such as retry and backoff policies.

Returns
Type Description
Status

a Status object. If the request failed, the status contains the details of the failure.

DeleteResourceValueConfig(std::string const &, Options)

Deletes a ResourceValueConfig.

Parameters
Name Description
name std::string const &

Required. Name of the ResourceValueConfig to delete

opts Options

Optional. Override the class-level options, such as retry and backoff policies.

Returns
Type Description
Status

a Status object. If the request failed, the status contains the details of the failure.

DeleteResourceValueConfig(google::cloud::securitycenter::v2::DeleteResourceValueConfigRequest const &, Options)

Deletes a ResourceValueConfig.

Parameters
Name Description
request google::cloud::securitycenter::v2::DeleteResourceValueConfigRequest const &

Unary RPCs, such as the one wrapped by this function, receive a single request proto message which includes all the inputs for the RPC. In this case, the proto message is a google.cloud.securitycenter.v2.DeleteResourceValueConfigRequest. Proto messages are converted to C++ classes by Protobuf, using the Protobuf mapping rules.

opts Options

Optional. Override the class-level options, such as retry and backoff policies.

Returns
Type Description
Status

a Status object. If the request failed, the status contains the details of the failure.

GetBigQueryExport(std::string const &, Options)

Gets a BigQuery export.

Parameters
Name Description
name std::string const &

Required. Name of the BigQuery export to retrieve. The following list shows some examples of the format:

  • organizations/{organization}/locations/{location}/bigQueryExports/{export_id}
  • folders/{folder}/locations/{location}/bigQueryExports/{export_id}
  • projects/{project}locations/{location}//bigQueryExports/{export_id}
opts Options

Optional. Override the class-level options, such as retry and backoff policies.

Returns
Type Description
StatusOr< google::cloud::securitycenter::v2::BigQueryExport >

the result of the RPC. The response message type (google.cloud.securitycenter.v2.BigQueryExport) is mapped to a C++ class using the Protobuf mapping rules. If the request fails, the StatusOr contains the error details.

GetBigQueryExport(google::cloud::securitycenter::v2::GetBigQueryExportRequest const &, Options)

Gets a BigQuery export.

Parameters
Name Description
request google::cloud::securitycenter::v2::GetBigQueryExportRequest const &

Unary RPCs, such as the one wrapped by this function, receive a single request proto message which includes all the inputs for the RPC. In this case, the proto message is a google.cloud.securitycenter.v2.GetBigQueryExportRequest. Proto messages are converted to C++ classes by Protobuf, using the Protobuf mapping rules.

opts Options

Optional. Override the class-level options, such as retry and backoff policies.

Returns
Type Description
StatusOr< google::cloud::securitycenter::v2::BigQueryExport >

the result of the RPC. The response message type (google.cloud.securitycenter.v2.BigQueryExport) is mapped to a C++ class using the Protobuf mapping rules. If the request fails, the StatusOr contains the error details.

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
Valid format: organizations/{organization}/simulations/latest``organizations/{organization}/simulations/{simulation}

opts Options

Optional. Override the class-level options, such as retry and backoff policies.

Returns
Type Description
StatusOr< google::cloud::securitycenter::v2::Simulation >

the result of the RPC. The response message type (google.cloud.securitycenter.v2.Simulation) is mapped to a C++ class using the Protobuf mapping rules. If the request fails, the StatusOr contains the error details.

GetSimulation(google::cloud::securitycenter::v2::GetSimulationRequest const &, Options)

Get the simulation by name or the latest simulation for the given organization.

Parameters
Name Description
request google::cloud::securitycenter::v2::GetSimulationRequest const &

Unary RPCs, such as the one wrapped by this function, receive a single request proto message which includes all the inputs for the RPC. In this case, the proto message is a google.cloud.securitycenter.v2.GetSimulationRequest. Proto messages are converted to C++ classes by Protobuf, using the Protobuf mapping rules.

opts Options

Optional. Override the class-level options, such as retry and backoff policies.

Returns
Type Description
StatusOr< google::cloud::securitycenter::v2::Simulation >

the result of the RPC. The response message type (google.cloud.securitycenter.v2.Simulation) is mapped to a C++ class using the Protobuf mapping rules. If the request fails, the StatusOr contains the error details.

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
Valid format: organizations/{organization}/simulations/{simulation}/valuedResources/{valued_resource}

opts Options

Optional. Override the class-level options, such as retry and backoff policies.

Returns
Type Description
StatusOr< google::cloud::securitycenter::v2::ValuedResource >

the result of the RPC. The response message type (google.cloud.securitycenter.v2.ValuedResource) is mapped to a C++ class using the Protobuf mapping rules. If the request fails, the StatusOr contains the error details.

GetValuedResource(google::cloud::securitycenter::v2::GetValuedResourceRequest const &, Options)

Get the valued resource by name.

Parameters
Name Description
request google::cloud::securitycenter::v2::GetValuedResourceRequest const &

Unary RPCs, such as the one wrapped by this function, receive a single request proto message which includes all the inputs for the RPC. In this case, the proto message is a google.cloud.securitycenter.v2.GetValuedResourceRequest. Proto messages are converted to C++ classes by Protobuf, using the Protobuf mapping rules.

opts Options

Optional. Override the class-level options, such as retry and backoff policies.

Returns
Type Description
StatusOr< google::cloud::securitycenter::v2::ValuedResource >

the result of the RPC. The response message type (google.cloud.securitycenter.v2.ValuedResource) is mapped to a C++ class using the Protobuf mapping rules. If the request fails, the StatusOr contains the error details.

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 StatusOr contains the error details.

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 request proto message which includes all the inputs for the RPC. In this case, the proto message is a google.iam.v1.GetIamPolicyRequest. Proto messages are converted to C++ classes by Protobuf, using the Protobuf mapping rules.

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 StatusOr contains the error details.

GetMuteConfig(std::string const &, Options)

Gets a mute config.

If no location is specified, default is global.

Parameters
Name Description
name std::string const &

Required. Name of the mute config to retrieve. The following list shows some examples of the format:

  • organizations/{organization}/muteConfigs/{config_id}
  • organizations/{organization}/locations/{location}/muteConfigs/{config_id}
  • folders/{folder}/muteConfigs/{config_id}
  • folders/{folder}/locations/{location}/muteConfigs/{config_id}
  • projects/{project}/muteConfigs/{config_id}
  • projects/{project}/locations/{location}/muteConfigs/{config_id}
opts Options

Optional. Override the class-level options, such as retry and backoff policies.

Returns
Type Description
StatusOr< google::cloud::securitycenter::v2::MuteConfig >

the result of the RPC. The response message type (google.cloud.securitycenter.v2.MuteConfig) is mapped to a C++ class using the Protobuf mapping rules. If the request fails, the StatusOr contains the error details.

GetMuteConfig(google::cloud::securitycenter::v2::GetMuteConfigRequest const &, Options)

Gets a mute config.

If no location is specified, default is global.

Parameters
Name Description
request google::cloud::securitycenter::v2::GetMuteConfigRequest const &

Unary RPCs, such as the one wrapped by this function, receive a single request proto message which includes all the inputs for the RPC. In this case, the proto message is a google.cloud.securitycenter.v2.GetMuteConfigRequest. Proto messages are converted to C++ classes by Protobuf, using the Protobuf mapping rules.

opts Options

Optional. Override the class-level options, such as retry and backoff policies.

Returns
Type Description
StatusOr< google::cloud::securitycenter::v2::MuteConfig >

the result of the RPC. The response message type (google.cloud.securitycenter.v2.MuteConfig) is mapped to a C++ class using the Protobuf mapping rules. If the request fails, the StatusOr contains the error details.

GetNotificationConfig(std::string const &, Options)

Gets a notification config.

Parameters
Name Description
name std::string const &

Required. Name of the notification config to get. The following list shows some examples of the format:

  • organizations/[organization_id]/locations/[location_id]/notificationConfigs/[config_id]
  • folders/[folder_id]/locations/[location_id]/notificationConfigs/[config_id]
  • projects/[project_id]/locations/[location_id]/notificationConfigs/[config_id]
opts Options

Optional. Override the class-level options, such as retry and backoff policies.

Returns
Type Description
StatusOr< google::cloud::securitycenter::v2::NotificationConfig >

the result of the RPC. The response message type (google.cloud.securitycenter.v2.NotificationConfig) is mapped to a C++ class using the Protobuf mapping rules. If the request fails, the StatusOr contains the error details.

GetNotificationConfig(google::cloud::securitycenter::v2::GetNotificationConfigRequest const &, Options)

Gets a notification config.

Parameters
Name Description
request google::cloud::securitycenter::v2::GetNotificationConfigRequest const &

Unary RPCs, such as the one wrapped by this function, receive a single request proto message which includes all the inputs for the RPC. In this case, the proto message is a google.cloud.securitycenter.v2.GetNotificationConfigRequest. Proto messages are converted to C++ classes by Protobuf, using the Protobuf mapping rules.

opts Options

Optional. Override the class-level options, such as retry and backoff policies.

Returns
Type Description
StatusOr< google::cloud::securitycenter::v2::NotificationConfig >

the result of the RPC. The response message type (google.cloud.securitycenter.v2.NotificationConfig) is mapped to a C++ class using the Protobuf mapping rules. If the request fails, the StatusOr contains the error details.

GetResourceValueConfig(std::string const &, Options)

Gets a ResourceValueConfig.

Parameters
Name Description
name std::string const &

Required. Name of the resource value config to retrieve. Its format is organizations/{organization}/resourceValueConfigs/{config_id}.

opts Options

Optional. Override the class-level options, such as retry and backoff policies.

Returns
Type Description
StatusOr< google::cloud::securitycenter::v2::ResourceValueConfig >

the result of the RPC. The response message type (google.cloud.securitycenter.v2.ResourceValueConfig) is mapped to a C++ class using the Protobuf mapping rules. If the request fails, the StatusOr contains the error details.

GetResourceValueConfig(google::cloud::securitycenter::v2::GetResourceValueConfigRequest const &, Options)

Gets a ResourceValueConfig.

Parameters
Name Description
request google::cloud::securitycenter::v2::GetResourceValueConfigRequest const &

Unary RPCs, such as the one wrapped by this function, receive a single request proto message which includes all the inputs for the RPC. In this case, the proto message is a google.cloud.securitycenter.v2.GetResourceValueConfigRequest. Proto messages are converted to C++ classes by Protobuf, using the Protobuf mapping rules.

opts Options

Optional. Override the class-level options, such as retry and backoff policies.

Returns
Type Description
StatusOr< google::cloud::securitycenter::v2::ResourceValueConfig >

the result of the RPC. The response message type (google.cloud.securitycenter.v2.ResourceValueConfig) is mapped to a C++ class using the Protobuf mapping rules. If the request fails, the StatusOr contains the error details.

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 organizations/[organization_id]/source/[source_id].

opts Options

Optional. Override the class-level options, such as retry and backoff policies.

Returns
Type Description
StatusOr< google::cloud::securitycenter::v2::Source >

the result of the RPC. The response message type (google.cloud.securitycenter.v2.Source) is mapped to a C++ class using the Protobuf mapping rules. If the request fails, the StatusOr contains the error details.

GetSource(google::cloud::securitycenter::v2::GetSourceRequest const &, Options)

Gets a source.

Parameters
Name Description
request google::cloud::securitycenter::v2::GetSourceRequest const &

Unary RPCs, such as the one wrapped by this function, receive a single request proto message which includes all the inputs for the RPC. In this case, the proto message is a google.cloud.securitycenter.v2.GetSourceRequest. Proto messages are converted to C++ classes by Protobuf, using the Protobuf mapping rules.

opts Options

Optional. Override the class-level options, such as retry and backoff policies.

Returns
Type Description
StatusOr< google::cloud::securitycenter::v2::Source >

the result of the RPC. The response message type (google.cloud.securitycenter.v2.Source) is mapped to a C++ class using the Protobuf mapping rules. If the request fails, the StatusOr contains the error details.

GroupFindings(std::string const &, std::string const &, Options)

Filters an organization or source's findings and groups them by their specified properties in a location.

If no location is specified, findings are assumed to be in global

To group across all sources provide a - as the source id. The following list shows some examples:

  • /v2/organizations/{organization_id}/sources/-/findings
  • /v2/organizations/{organization_id}/sources/-/locations/{location_id}/findings
  • /v2/folders/{folder_id}/sources/-/findings
  • /v2/folders/{folder_id}/sources/-/locations/{location_id}/findings
  • /v2/projects/{project_id}/sources/-/findings
  • /v2/projects/{project_id}/sources/-/locations/{location_id}/findings
Parameters
Name Description
parent std::string const &

Required. Name of the source to groupBy. If no location is specified, finding is assumed to be in global. The following list shows some examples:

  • organizations/[organization_id]/sources/[source_id]
  • organizations/[organization_id]/sources/[source_id]/locations/[location_id]
  • folders/[folder_id]/sources/[source_id]
  • folders/[folder_id]/sources/[source_id]/locations/[location_id]
  • projects/[project_id]/sources/[source_id]
  • projects/[project_id]/sources/[source_id]/locations/[location_id]
    To groupBy across all sources provide a source_id of -. The following list shows some examples:
  • organizations/{organization_id}/sources/-
  • organizations/{organization_id}/sources/-/locations/[location_id]
  • folders/{folder_id}/sources/-
  • folders/{folder_id}/sources/-/locations/[location_id]
  • projects/{project_id}/sources/-
  • projects/{project_id}/sources/-/locations/[location_id]
group_by std::string const &

Required. Expression that defines what assets fields to use for grouping. The string value should follow SQL syntax: comma separated list of fields. For example: "parent,resource_name".

opts Options

Optional. Override the class-level options, such as retry and backoff policies.

Returns
Type Description
StreamRange< google::cloud::securitycenter::v2::GroupResult >

a StreamRange to iterate of the results. See the documentation of this type for details. In brief, this class has begin() and end() member functions returning a iterator class meeting the input iterator requirements. The value type for this iterator is a StatusOr as the iteration may fail even after some values are retrieved successfully, for example, if there is a network disconnect. An empty set of results does not indicate an error, it indicates that there are no resources meeting the request criteria. On a successful iteration the StatusOr<T> contains elements of type google.cloud.securitycenter.v2.GroupResult, or rather, the C++ class generated by Protobuf from that type. Please consult the Protobuf documentation for details on the Protobuf mapping rules.

GroupFindings(google::cloud::securitycenter::v2::GroupFindingsRequest, Options)

Filters an organization or source's findings and groups them by their specified properties in a location.

If no location is specified, findings are assumed to be in global

To group across all sources provide a - as the source id. The following list shows some examples:

  • /v2/organizations/{organization_id}/sources/-/findings
  • /v2/organizations/{organization_id}/sources/-/locations/{location_id}/findings
  • /v2/folders/{folder_id}/sources/-/findings
  • /v2/folders/{folder_id}/sources/-/locations/{location_id}/findings
  • /v2/projects/{project_id}/sources/-/findings
  • /v2/projects/{project_id}/sources/-/locations/{location_id}/findings
Parameters
Name Description
request google::cloud::securitycenter::v2::GroupFindingsRequest

Unary RPCs, such as the one wrapped by this function, receive a single request proto message which includes all the inputs for the RPC. In this case, the proto message is a google.cloud.securitycenter.v2.GroupFindingsRequest. Proto messages are converted to C++ classes by Protobuf, using the Protobuf mapping rules.

opts Options

Optional. Override the class-level options, such as retry and backoff policies.

Returns
Type Description
StreamRange< google::cloud::securitycenter::v2::GroupResult >

a StreamRange to iterate of the results. See the documentation of this type for details. In brief, this class has begin() and end() member functions returning a iterator class meeting the input iterator requirements. The value type for this iterator is a StatusOr as the iteration may fail even after some values are retrieved successfully, for example, if there is a network disconnect. An empty set of results does not indicate an error, it indicates that there are no resources meeting the request criteria. On a successful iteration the StatusOr<T> contains elements of type google.cloud.securitycenter.v2.GroupResult, or rather, the C++ class generated by Protobuf from that type. Please consult the Protobuf documentation for details on the Protobuf mapping rules.

ListAttackPaths(std::string const &, Options)

Lists the attack paths for a set of simulation results or valued resources and filter.

Parameters
Name Description
parent std::string const &

Required. Name of parent to list attack paths.
Valid formats: organizations/{organization}, organizations/{organization}/simulations/{simulation}``organizations/{organization}/simulations/{simulation}/attackExposureResults/{attack_exposure_result_v2}``organizations/{organization}/simulations/{simulation}/valuedResources/{valued_resource}

opts Options

Optional. Override the class-level options, such as retry and backoff policies.

Returns
Type Description
StreamRange< google::cloud::securitycenter::v2::AttackPath >

a StreamRange to iterate of the results. See the documentation of this type for details. In brief, this class has begin() and end() member functions returning a iterator class meeting the input iterator requirements. The value type for this iterator is a StatusOr as the iteration may fail even after some values are retrieved successfully, for example, if there is a network disconnect. An empty set of results does not indicate an error, it indicates that there are no resources meeting the request criteria. On a successful iteration the StatusOr<T> contains elements of type google.cloud.securitycenter.v2.AttackPath, or rather, the C++ class generated by Protobuf from that type. Please consult the Protobuf documentation for details on the Protobuf mapping rules.

ListAttackPaths(google::cloud::securitycenter::v2::ListAttackPathsRequest, Options)

Lists the attack paths for a set of simulation results or valued resources and filter.

Parameters
Name Description
request google::cloud::securitycenter::v2::ListAttackPathsRequest

Unary RPCs, such as the one wrapped by this function, receive a single request proto message which includes all the inputs for the RPC. In this case, the proto message is a google.cloud.securitycenter.v2.ListAttackPathsRequest. Proto messages are converted to C++ classes by Protobuf, using the Protobuf mapping rules.

opts Options

Optional. Override the class-level options, such as retry and backoff policies.

Returns
Type Description
StreamRange< google::cloud::securitycenter::v2::AttackPath >

a StreamRange to iterate of the results. See the documentation of this type for details. In brief, this class has begin() and end() member functions returning a iterator class meeting the input iterator requirements. The value type for this iterator is a StatusOr as the iteration may fail even after some values are retrieved successfully, for example, if there is a network disconnect. An empty set of results does not indicate an error, it indicates that there are no resources meeting the request criteria. On a successful iteration the StatusOr<T> contains elements of type google.cloud.securitycenter.v2.AttackPath, or rather, the C++ class generated by Protobuf from that type. Please consult the Protobuf documentation for details on the Protobuf mapping rules.

ListBigQueryExports(std::string const &, Options)

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.

Parameters
Name Description
parent std::string const &

Required. The parent, which owns the collection of BigQuery exports. Its format is organizations/[organization_id]/locations/[location_id], folders/[folder_id]/locations/[location_id], or projects/[project_id]/locations/[location_id].

opts Options

Optional. Override the class-level options, such as retry and backoff policies.

Returns
Type Description
StreamRange< google::cloud::securitycenter::v2::BigQueryExport >

a StreamRange to iterate of the results. See the documentation of this type for details. In brief, this class has begin() and end() member functions returning a iterator class meeting the input iterator requirements. The value type for this iterator is a StatusOr as the iteration may fail even after some values are retrieved successfully, for example, if there is a network disconnect. An empty set of results does not indicate an error, it indicates that there are no resources meeting the request criteria. On a successful iteration the StatusOr<T> contains elements of type google.cloud.securitycenter.v2.BigQueryExport, or rather, the C++ class generated by Protobuf from that type. Please consult the Protobuf documentation for details on the Protobuf mapping rules.

ListBigQueryExports(google::cloud::securitycenter::v2::ListBigQueryExportsRequest, Options)

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.

Parameters
Name Description
request google::cloud::securitycenter::v2::ListBigQueryExportsRequest

Unary RPCs, such as the one wrapped by this function, receive a single request proto message which includes all the inputs for the RPC. In this case, the proto message is a google.cloud.securitycenter.v2.ListBigQueryExportsRequest. Proto messages are converted to C++ classes by Protobuf, using the Protobuf mapping rules.

opts Options

Optional. Override the class-level options, such as retry and backoff policies.

Returns
Type Description
StreamRange< google::cloud::securitycenter::v2::BigQueryExport >

a StreamRange to iterate of the results. See the documentation of this type for details. In brief, this class has begin() and end() member functions returning a iterator class meeting the input iterator requirements. The value type for this iterator is a StatusOr as the iteration may fail even after some values are retrieved successfully, for example, if there is a network disconnect. An empty set of results does not indicate an error, it indicates that there are no resources meeting the request criteria. On a successful iteration the StatusOr<T> contains elements of type google.cloud.securitycenter.v2.BigQueryExport, or rather, the C++ class generated by Protobuf from that type. Please consult the Protobuf documentation for details on the Protobuf mapping rules.

ListFindings(std::string const &, Options)

Lists an organization or source's findings.

To list across all sources for a given location provide a - as the source id. If no location is specified, finding are assumed to be in global. The following list shows some examples:

  • /v2/organizations/{organization_id}/sources/-/findings
  • /v2/organizations/{organization_id}/sources/-/locations/{location_id}/findings
Parameters
Name Description
parent std::string const &

Required. Name of the source the findings belong to. If no location is specified, the default is global. The following list shows some examples:

  • organizations/[organization_id]/sources/[source_id]
  • organizations/[organization_id]/sources/[source_id]/locations/[location_id]
  • folders/[folder_id]/sources/[source_id]
  • folders/[folder_id]/sources/[source_id]/locations/[location_id]
  • projects/[project_id]/sources/[source_id]
  • projects/[project_id]/sources/[source_id]/locations/[location_id]
    To list across all sources provide a source_id of -. The following list shows some examples:
  • organizations/{organization_id}/sources/-
  • organizations/{organization_id}/sources/-/locations/{location_id}
  • folders/{folder_id}/sources/-
  • folders/{folder_id}/sources/-locations/{location_id}
  • projects/{projects_id}/sources/-
  • projects/{projects_id}/sources/-/locations/{location_id}
opts Options

Optional. Override the class-level options, such as retry and backoff policies.

Returns
Type Description
StreamRange< google::cloud::securitycenter::v2::ListFindingsResponse::ListFindingsResult >

a StreamRange to iterate of the results. See the documentation of this type for details. In brief, this class has begin() and end() member functions returning a iterator class meeting the input iterator requirements. The value type for this iterator is a StatusOr as the iteration may fail even after some values are retrieved successfully, for example, if there is a network disconnect. An empty set of results does not indicate an error, it indicates that there are no resources meeting the request criteria. On a successful iteration the StatusOr<T> contains elements of type google.cloud.securitycenter.v2.ListFindingsResponse.ListFindingsResult, or rather, the C++ class generated by Protobuf from that type. Please consult the Protobuf documentation for details on the Protobuf mapping rules.

ListFindings(google::cloud::securitycenter::v2::ListFindingsRequest, Options)

Lists an organization or source's findings.

To list across all sources for a given location provide a - as the source id. If no location is specified, finding are assumed to be in global. The following list shows some examples:

  • /v2/organizations/{organization_id}/sources/-/findings
  • /v2/organizations/{organization_id}/sources/-/locations/{location_id}/findings
Parameters
Name Description
request google::cloud::securitycenter::v2::ListFindingsRequest

Unary RPCs, such as the one wrapped by this function, receive a single request proto message which includes all the inputs for the RPC. In this case, the proto message is a google.cloud.securitycenter.v2.ListFindingsRequest. Proto messages are converted to C++ classes by Protobuf, using the Protobuf mapping rules.

opts Options

Optional. Override the class-level options, such as retry and backoff policies.

Returns
Type Description
StreamRange< google::cloud::securitycenter::v2::ListFindingsResponse::ListFindingsResult >

a StreamRange to iterate of the results. See the documentation of this type for details. In brief, this class has begin() and end() member functions returning a iterator class meeting the input iterator requirements. The value type for this iterator is a StatusOr as the iteration may fail even after some values are retrieved successfully, for example, if there is a network disconnect. An empty set of results does not indicate an error, it indicates that there are no resources meeting the request criteria. On a successful iteration the StatusOr<T> contains elements of type google.cloud.securitycenter.v2.ListFindingsResponse.ListFindingsResult, or rather, the C++ class generated by Protobuf from that type. Please consult the Protobuf documentation for details on the Protobuf mapping rules.

ListMuteConfigs(std::string const &, Options)

Lists mute configs.

If no location is specified, default is global.

Parameters
Name Description
parent std::string const &

Required. The parent, which owns the collection of mute configs. Its format is organizations/[organization_id]", "folders/[folder_id], projects/[project_id], organizations/[organization_id]/locations/[location_id], folders/[folder_id]/locations/[location_id], projects/[project_id]/locations/[location_id].

opts Options

Optional. Override the class-level options, such as retry and backoff policies.

Returns
Type Description
StreamRange< google::cloud::securitycenter::v2::MuteConfig >

a StreamRange to iterate of the results. See the documentation of this type for details. In brief, this class has begin() and end() member functions returning a iterator class meeting the input iterator requirements. The value type for this iterator is a StatusOr as the iteration may fail even after some values are retrieved successfully, for example, if there is a network disconnect. An empty set of results does not indicate an error, it indicates that there are no resources meeting the request criteria. On a successful iteration the StatusOr<T> contains elements of type google.cloud.securitycenter.v2.MuteConfig, or rather, the C++ class generated by Protobuf from that type. Please consult the Protobuf documentation for details on the Protobuf mapping rules.

ListMuteConfigs(google::cloud::securitycenter::v2::ListMuteConfigsRequest, Options)

Lists mute configs.

If no location is specified, default is global.

Parameters
Name Description
request google::cloud::securitycenter::v2::ListMuteConfigsRequest

Unary RPCs, such as the one wrapped by this function, receive a single request proto message which includes all the inputs for the RPC. In this case, the proto message is a google.cloud.securitycenter.v2.ListMuteConfigsRequest. Proto messages are converted to C++ classes by Protobuf, using the Protobuf mapping rules.

opts Options

Optional. Override the class-level options, such as retry and backoff policies.

Returns
Type Description
StreamRange< google::cloud::securitycenter::v2::MuteConfig >

a StreamRange to iterate of the results. See the documentation of this type for details. In brief, this class has begin() and end() member functions returning a iterator class meeting the input iterator requirements. The value type for this iterator is a StatusOr as the iteration may fail even after some values are retrieved successfully, for example, if there is a network disconnect. An empty set of results does not indicate an error, it indicates that there are no resources meeting the request criteria. On a successful iteration the StatusOr<T> contains elements of type google.cloud.securitycenter.v2.MuteConfig, or rather, the C++ class generated by Protobuf from that type. Please consult the Protobuf documentation for details on the Protobuf mapping rules.

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]/locations/[location_id]", "folders/[folder_id]/locations/[location_id]", or "projects/[project_id]/locations/[location_id]".

opts Options

Optional. Override the class-level options, such as retry and backoff policies.

Returns
Type Description
StreamRange< google::cloud::securitycenter::v2::NotificationConfig >

a StreamRange to iterate of the results. See the documentation of this type for details. In brief, this class has begin() and end() member functions returning a iterator class meeting the input iterator requirements. The value type for this iterator is a StatusOr as the iteration may fail even after some values are retrieved successfully, for example, if there is a network disconnect. An empty set of results does not indicate an error, it indicates that there are no resources meeting the request criteria. On a successful iteration the StatusOr<T> contains elements of type google.cloud.securitycenter.v2.NotificationConfig, or rather, the C++ class generated by Protobuf from that type. Please consult the Protobuf documentation for details on the Protobuf mapping rules.

ListNotificationConfigs(google::cloud::securitycenter::v2::ListNotificationConfigsRequest, Options)

Lists notification configs.

Parameters
Name Description
request google::cloud::securitycenter::v2::ListNotificationConfigsRequest

Unary RPCs, such as the one wrapped by this function, receive a single request proto message which includes all the inputs for the RPC. In this case, the proto message is a google.cloud.securitycenter.v2.ListNotificationConfigsRequest. Proto messages are converted to C++ classes by Protobuf, using the Protobuf mapping rules.

opts Options

Optional. Override the class-level options, such as retry and backoff policies.

Returns
Type Description
StreamRange< google::cloud::securitycenter::v2::NotificationConfig >

a StreamRange to iterate of the results. See the documentation of this type for details. In brief, this class has begin() and end() member functions returning a iterator class meeting the input iterator requirements. The value type for this iterator is a StatusOr as the iteration may fail even after some values are retrieved successfully, for example, if there is a network disconnect. An empty set of results does not indicate an error, it indicates that there are no resources meeting the request criteria. On a successful iteration the StatusOr<T> contains elements of type google.cloud.securitycenter.v2.NotificationConfig, or rather, the C++ class generated by Protobuf from that type. Please consult the Protobuf documentation for details on the Protobuf mapping rules.

ListResourceValueConfigs(std::string const &, Options)

Lists all ResourceValueConfigs.

Parameters
Name Description
parent std::string const &

Required. The parent, which owns the collection of resource value configs. Its format is organizations/[organization_id]

opts Options

Optional. Override the class-level options, such as retry and backoff policies.

Returns
Type Description
StreamRange< google::cloud::securitycenter::v2::ResourceValueConfig >

a StreamRange to iterate of the results. See the documentation of this type for details. In brief, this class has begin() and end() member functions returning a iterator class meeting the input iterator requirements. The value type for this iterator is a StatusOr as the iteration may fail even after some values are retrieved successfully, for example, if there is a network disconnect. An empty set of results does not indicate an error, it indicates that there are no resources meeting the request criteria. On a successful iteration the StatusOr<T> contains elements of type google.cloud.securitycenter.v2.ResourceValueConfig, or rather, the C++ class generated by Protobuf from that type. Please consult the Protobuf documentation for details on the Protobuf mapping rules.

ListResourceValueConfigs(google::cloud::securitycenter::v2::ListResourceValueConfigsRequest, Options)

Lists all ResourceValueConfigs.

Parameters
Name Description
request google::cloud::securitycenter::v2::ListResourceValueConfigsRequest

Unary RPCs, such as the one wrapped by this function, receive a single request proto message which includes all the inputs for the RPC. In this case, the proto message is a google.cloud.securitycenter.v2.ListResourceValueConfigsRequest. Proto messages are converted to C++ classes by Protobuf, using the Protobuf mapping rules.

opts Options

Optional. Override the class-level options, such as retry and backoff policies.

Returns
Type Description
StreamRange< google::cloud::securitycenter::v2::ResourceValueConfig >

a StreamRange to iterate of the results. See the documentation of this type for details. In brief, this class has begin() and end() member functions returning a iterator class meeting the input iterator requirements. The value type for this iterator is a StatusOr as the iteration may fail even after some values are retrieved successfully, for example, if there is a network disconnect. An empty set of results does not indicate an error, it indicates that there are no resources meeting the request criteria. On a successful iteration the StatusOr<T> contains elements of type google.cloud.securitycenter.v2.ResourceValueConfig, or rather, the C++ class generated by Protobuf from that type. Please consult the Protobuf documentation for details on the Protobuf mapping rules.

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 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::v2::Source >

a StreamRange to iterate of the results. See the documentation of this type for details. In brief, this class has begin() and end() member functions returning a iterator class meeting the input iterator requirements. The value type for this iterator is a StatusOr as the iteration may fail even after some values are retrieved successfully, for example, if there is a network disconnect. An empty set of results does not indicate an error, it indicates that there are no resources meeting the request criteria. On a successful iteration the StatusOr<T> contains elements of type google.cloud.securitycenter.v2.Source, or rather, the C++ class generated by Protobuf from that type. Please consult the Protobuf documentation for details on the Protobuf mapping rules.

ListSources(google::cloud::securitycenter::v2::ListSourcesRequest, Options)

Lists all sources belonging to an organization.

Parameters
Name Description
request google::cloud::securitycenter::v2::ListSourcesRequest

Unary RPCs, such as the one wrapped by this function, receive a single request proto message which includes all the inputs for the RPC. In this case, the proto message is a google.cloud.securitycenter.v2.ListSourcesRequest. Proto messages are converted to C++ classes by Protobuf, using the Protobuf mapping rules.

opts Options

Optional. Override the class-level options, such as retry and backoff policies.

Returns
Type Description
StreamRange< google::cloud::securitycenter::v2::Source >

a StreamRange to iterate of the results. See the documentation of this type for details. In brief, this class has begin() and end() member functions returning a iterator class meeting the input iterator requirements. The value type for this iterator is a StatusOr as the iteration may fail even after some values are retrieved successfully, for example, if there is a network disconnect. An empty set of results does not indicate an error, it indicates that there are no resources meeting the request criteria. On a successful iteration the StatusOr<T> contains elements of type google.cloud.securitycenter.v2.Source, or rather, the C++ class generated by Protobuf from that type. Please consult the Protobuf documentation for details on the Protobuf mapping rules.

ListValuedResources(std::string const &, Options)

Lists the valued resources for a set of simulation results and filter.

Parameters
Name Description
parent std::string const &

Required. Name of parent to list exposed resources.
Valid formats: organizations/{organization}, organizations/{organization}/simulations/{simulation}``organizations/{organization}/simulations/{simulation}/attackExposureResults/{attack_exposure_result_v2}

opts Options

Optional. Override the class-level options, such as retry and backoff policies.

Returns
Type Description
StreamRange< google::cloud::securitycenter::v2::ValuedResource >

a StreamRange to iterate of the results. See the documentation of this type for details. In brief, this class has begin() and end() member functions returning a iterator class meeting the input iterator requirements. The value type for this iterator is a StatusOr as the iteration may fail even after some values are retrieved successfully, for example, if there is a network disconnect. An empty set of results does not indicate an error, it indicates that there are no resources meeting the request criteria. On a successful iteration the StatusOr<T> contains elements of type google.cloud.securitycenter.v2.ValuedResource, or rather, the C++ class generated by Protobuf from that type. Please consult the Protobuf documentation for details on the Protobuf mapping rules.

ListValuedResources(google::cloud::securitycenter::v2::ListValuedResourcesRequest, Options)

Lists the valued resources for a set of simulation results and filter.

Parameters
Name Description
request google::cloud::securitycenter::v2::ListValuedResourcesRequest

Unary RPCs, such as the one wrapped by this function, receive a single request proto message which includes all the inputs for the RPC. In this case, the proto message is a google.cloud.securitycenter.v2.ListValuedResourcesRequest. Proto messages are converted to C++ classes by Protobuf, using the Protobuf mapping rules.

opts Options

Optional. Override the class-level options, such as retry and backoff policies.

Returns
Type Description
StreamRange< google::cloud::securitycenter::v2::ValuedResource >

a StreamRange to iterate of the results. See the documentation of this type for details. In brief, this class has begin() and end() member functions returning a iterator class meeting the input iterator requirements. The value type for this iterator is a StatusOr as the iteration may fail even after some values are retrieved successfully, for example, if there is a network disconnect. An empty set of results does not indicate an error, it indicates that there are no resources meeting the request criteria. On a successful iteration the StatusOr<T> contains elements of type google.cloud.securitycenter.v2.ValuedResource, or rather, the C++ class generated by Protobuf from that type. Please consult the Protobuf documentation for details on the Protobuf mapping rules.

SetFindingState(std::string const &, google::cloud::securitycenter::v2::Finding::State, Options)

Updates the state of a finding.

If no location is specified, finding is assumed to be in global

Parameters
Name Description
name std::string const &

Required. The relative resource name of the finding. If no location is specified, finding is assumed to be in global. The following list shows some examples:

  • organizations/{organization_id}/sources/{source_id}/findings/{finding_id}
  • organizations/{organization_id}/sources/{source_id}/locations/{location_id}/findings/{finding_id}
  • folders/{folder_id}/sources/{source_id}/findings/{finding_id}
  • folders/{folder_id}/sources/{source_id}/locations/{location_id}/findings/{finding_id}
  • projects/{project_id}/sources/{source_id}/findings/{finding_id}
  • projects/{project_id}/sources/{source_id}/locations/{location_id}/findings/{finding_id}
state google::cloud::securitycenter::v2::Finding::State

Required. The desired State of the finding.

opts Options

Optional. Override the class-level options, such as retry and backoff policies.

Returns
Type Description
StatusOr< google::cloud::securitycenter::v2::Finding >

the result of the RPC. The response message type (google.cloud.securitycenter.v2.Finding) is mapped to a C++ class using the Protobuf mapping rules. If the request fails, the StatusOr contains the error details.

SetFindingState(google::cloud::securitycenter::v2::SetFindingStateRequest const &, Options)

Updates the state of a finding.

If no location is specified, finding is assumed to be in global

Parameters
Name Description
request google::cloud::securitycenter::v2::SetFindingStateRequest const &

Unary RPCs, such as the one wrapped by this function, receive a single request proto message which includes all the inputs for the RPC. In this case, the proto message is a google.cloud.securitycenter.v2.SetFindingStateRequest. Proto messages are converted to C++ classes by Protobuf, using the Protobuf mapping rules.

opts Options

Optional. Override the class-level options, such as retry and backoff policies.

Returns
Type Description
StatusOr< google::cloud::securitycenter::v2::Finding >

the result of the RPC. The response message type (google.cloud.securitycenter.v2.Finding) is mapped to a C++ class using the Protobuf mapping rules. If the request fails, the StatusOr contains the error details.

SetIamPolicy(std::string const &, google::iam::v1::Policy const &, Options)

Sets the access control policy on the specified Source.

Parameters
Name Description
resource std::string const &

REQUIRED: The resource for which the policy is being specified. See the operation documentation for the appropriate value for this field.

policy google::iam::v1::Policy const &

REQUIRED: The complete policy to be applied to the resource. The size of the policy is limited to a few 10s of KB. An empty policy is a valid policy but certain Cloud Platform services (such as Projects) might reject them.

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 StatusOr contains the error details.

SetIamPolicy(std::string const &, IamUpdater const &, Options)

Updates the IAM policy for resource using an optimistic concurrency control loop.

The loop fetches the current policy for resource, and passes it to updater, which should return the new policy. This new policy should use the current etag so that the read-modify-write cycle can detect races and rerun the update when there is a mismatch. If the new policy does not have an etag, the existing policy will be blindly overwritten. If updater does not yield a policy, the control loop is terminated and kCancelled is returned.

Parameters
Name Description
resource std::string const &

Required. The resource for which the policy is being specified. See the operation documentation for the appropriate value for this field.

updater IamUpdater const &

Required. Functor to map the current policy to a new one.

opts Options

Optional. Override the class-level options, such as retry and backoff policies.

Returns
Type Description
StatusOr< google::iam::v1::Policy >

google::iam::v1::Policy

SetIamPolicy(google::iam::v1::SetIamPolicyRequest const &, Options)

Sets the access control policy on the specified Source.

Parameters
Name Description
request google::iam::v1::SetIamPolicyRequest const &

Unary RPCs, such as the one wrapped by this function, receive a single request proto message which includes all the inputs for the RPC. In this case, the proto message is a google.iam.v1.SetIamPolicyRequest. Proto messages are converted to C++ classes by Protobuf, using the Protobuf mapping rules.

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 StatusOr contains the error details.

SetMute(std::string const &, google::cloud::securitycenter::v2::Finding::Mute, Options)

Updates the mute state of a finding.

If no location is specified, finding is assumed to be in global

Parameters
Name Description
name std::string const &

Required. The relative resource name of the finding. If no location is specified, finding is assumed to be in global. The following list shows some examples:

  • organizations/{organization_id}/sources/{source_id}/findings/{finding_id}
  • organizations/{organization_id}/sources/{source_id}/locations/{location_id}/findings/{finding_id}
  • folders/{folder_id}/sources/{source_id}/findings/{finding_id}
  • folders/{folder_id}/sources/{source_id}/locations/{location_id}/findings/{finding_id}
  • projects/{project_id}/sources/{source_id}/findings/{finding_id}
  • projects/{project_id}/sources/{source_id}/locations/{location_id}/findings/{finding_id}
mute google::cloud::securitycenter::v2::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::v2::Finding >

the result of the RPC. The response message type (google.cloud.securitycenter.v2.Finding) is mapped to a C++ class using the Protobuf mapping rules. If the request fails, the StatusOr contains the error details.

SetMute(google::cloud::securitycenter::v2::SetMuteRequest const &, Options)

Updates the mute state of a finding.

If no location is specified, finding is assumed to be in global

Parameters
Name Description
request google::cloud::securitycenter::v2::SetMuteRequest const &

Unary RPCs, such as the one wrapped by this function, receive a single request proto message which includes all the inputs for the RPC. In this case, the proto message is a google.cloud.securitycenter.v2.SetMuteRequest. Proto messages are converted to C++ classes by Protobuf, using the Protobuf mapping rules.

opts Options

Optional. Override the class-level options, such as retry and backoff policies.

Returns
Type Description
StatusOr< google::cloud::securitycenter::v2::Finding >

the result of the RPC. The response message type (google.cloud.securitycenter.v2.Finding) is mapped to a C++ class using the Protobuf mapping rules. If the request fails, the StatusOr contains the error details.

TestIamPermissions(std::string const &, std::vector< std::string > const &, Options)

Returns the permissions that a caller has on the specified source.

Parameters
Name Description
resource std::string const &

REQUIRED: The resource for which the policy detail is being requested. See the operation documentation for the appropriate value for this field.

permissions std::vector< std::string > const &

The set of permissions to check for the resource. Permissions with wildcards (such as '' or 'storage.') are not allowed. For more information see IAM Overview.

opts Options

Optional. Override the class-level options, such as retry and backoff policies.

Returns
Type Description
StatusOr< google::iam::v1::TestIamPermissionsResponse >

the