Class SecurityCenterManagementClient (2.22.0)

Service describing handlers for resources.

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

SecurityCenterManagementClient(SecurityCenterManagementClient const &)

Copy and move support

Parameter
Name	Description
	`SecurityCenterManagementClient const &`

SecurityCenterManagementClient(SecurityCenterManagementClient &&)

Copy and move support

Parameter
Name	Description
	`SecurityCenterManagementClient &&`

SecurityCenterManagementClient(std::shared_ptr< SecurityCenterManagementConnection >, Options)

Parameters
Name	Description
`connection`	`std::shared_ptr< SecurityCenterManagementConnection >`
`opts`	`Options`

Operators

operator=(SecurityCenterManagementClient const &)

Copy and move support

Parameter
Name	Description
	`SecurityCenterManagementClient const &`

Returns
Type	Description
`SecurityCenterManagementClient &`

operator=(SecurityCenterManagementClient &&)

Copy and move support

Parameter
Name	Description
	`SecurityCenterManagementClient &&`

Returns
Type	Description
`SecurityCenterManagementClient &`

Functions

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 (no descendants).

Parameters
Name	Description
`parent`	`std::string const &` Required. Name of parent to list effective custom modules. Its format is "organizations/{organization}/locations/{location}", "folders/{folder}/locations/{location}", or "projects/{project}/locations/{location}"
`opts`	`Options` Optional. Override the class-level options, such as retry and backoff policies.

Returns

Type Description

StreamRange< google::cloud::securitycentermanagement::v1::EffectiveSecurityHealthAnalyticsCustomModule >

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.securitycentermanagement.v1.EffectiveSecurityHealthAnalyticsCustomModule, or rather, the C++ class generated by Protobuf from that type. Please consult the Protobuf documentation for details on the Protobuf mapping rules.

ListEffectiveSecurityHealthAnalyticsCustomModules(google::cloud::securitycentermanagement::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 (no descendants).

Parameters
Name	Description
`request`	`google::cloud::securitycentermanagement::v1::ListEffectiveSecurityHealthAnalyticsCustomModulesRequest` 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.securitycentermanagement.v1.ListEffectiveSecurityHealthAnalyticsCustomModulesRequest. 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::securitycentermanagement::v1::EffectiveSecurityHealthAnalyticsCustomModule >

GetEffectiveSecurityHealthAnalyticsCustomModule(std::string const &, Options)

Gets details of a single EffectiveSecurityHealthAnalyticsCustomModule.

Parameters

Name Description

name

std::string const &

Required. The resource name of the SHA custom module.
Its format is:

"organizations/{organization}/locations/{location}/effectiveSecurityHealthAnalyticsCustomModules/{module_id}".
"folders/{folder}/locations/{location}/effectiveSecurityHealthAnalyticsCustomModules/{module_id}".
"projects/{project}/locations/{location}/effectiveSecurityHealthAnalyticsCustomModules/{module_id}".

opts

Options

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

Returns
Type	Description
`StatusOr< google::cloud::securitycentermanagement::v1::EffectiveSecurityHealthAnalyticsCustomModule >`	the result of the RPC. The response message type (google.cloud.securitycentermanagement.v1.EffectiveSecurityHealthAnalyticsCustomModule) is mapped to a C++ class using the Protobuf mapping rules. If the request fails, the `StatusOr` contains the error details.

GetEffectiveSecurityHealthAnalyticsCustomModule(google::cloud::securitycentermanagement::v1::GetEffectiveSecurityHealthAnalyticsCustomModuleRequest const &, Options)

Gets details of a single EffectiveSecurityHealthAnalyticsCustomModule.

Parameters
Name	Description
`request`	`google::cloud::securitycentermanagement::v1::GetEffectiveSecurityHealthAnalyticsCustomModuleRequest 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.securitycentermanagement.v1.GetEffectiveSecurityHealthAnalyticsCustomModuleRequest. 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::securitycentermanagement::v1::EffectiveSecurityHealthAnalyticsCustomModule >`	the result of the RPC. The response message type (google.cloud.securitycentermanagement.v1.EffectiveSecurityHealthAnalyticsCustomModule) is mapped to a C++ class using the Protobuf mapping rules. If the request fails, the `StatusOr` contains the error details.

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 (no descendants).

Parameters
Name	Description
`parent`	`std::string const &` Required. Name of parent to list custom modules. Its format is "organizations/{organization}/locations/{location}", "folders/{folder}/locations/{location}", or "projects/{project}/locations/{location}"
`opts`	`Options` Optional. Override the class-level options, such as retry and backoff policies.

Returns

Type Description

StreamRange< google::cloud::securitycentermanagement::v1::SecurityHealthAnalyticsCustomModule >

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.securitycentermanagement.v1.SecurityHealthAnalyticsCustomModule, or rather, the C++ class generated by Protobuf from that type. Please consult the Protobuf documentation for details on the Protobuf mapping rules.

ListSecurityHealthAnalyticsCustomModules(google::cloud::securitycentermanagement::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 (no descendants).

Parameters
Name	Description
`request`	`google::cloud::securitycentermanagement::v1::ListSecurityHealthAnalyticsCustomModulesRequest` 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.securitycentermanagement.v1.ListSecurityHealthAnalyticsCustomModulesRequest. 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::securitycentermanagement::v1::SecurityHealthAnalyticsCustomModule >

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.securitycentermanagement.v1.SecurityHealthAnalyticsCustomModule, or rather, the C++ class generated by Protobuf from that type. Please consult the Protobuf documentation for details on the Protobuf mapping rules.

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 custom modules. Its format is "organizations/{organization}/locations/{location}", "folders/{folder}/locations/{location}", or "projects/{project}/locations/{location}"
`opts`	`Options` Optional. Override the class-level options, such as retry and backoff policies.

Returns

Type Description

StreamRange< google::cloud::securitycentermanagement::v1::SecurityHealthAnalyticsCustomModule >

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.securitycentermanagement.v1.SecurityHealthAnalyticsCustomModule, or rather, the C++ class generated by Protobuf from that type. Please consult the Protobuf documentation for details on the Protobuf mapping rules.

ListDescendantSecurityHealthAnalyticsCustomModules(google::cloud::securitycentermanagement::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::securitycentermanagement::v1::ListDescendantSecurityHealthAnalyticsCustomModulesRequest` 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.securitycentermanagement.v1.ListDescendantSecurityHealthAnalyticsCustomModulesRequest. 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::securitycentermanagement::v1::SecurityHealthAnalyticsCustomModule >

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.securitycentermanagement.v1.SecurityHealthAnalyticsCustomModule, or rather, the C++ class generated by Protobuf from that type. Please consult the Protobuf documentation for details on the Protobuf mapping rules.

GetSecurityHealthAnalyticsCustomModule(std::string const &, Options)

Retrieves a SecurityHealthAnalyticsCustomModule.

Parameters
Name	Description
`name`	`std::string const &` Required. Name of the resource
`opts`	`Options` Optional. Override the class-level options, such as retry and backoff policies.

Returns
Type	Description
`StatusOr< google::cloud::securitycentermanagement::v1::SecurityHealthAnalyticsCustomModule >`	the result of the RPC. The response message type (google.cloud.securitycentermanagement.v1.SecurityHealthAnalyticsCustomModule) is mapped to a C++ class using the Protobuf mapping rules. If the request fails, the `StatusOr` contains the error details.

GetSecurityHealthAnalyticsCustomModule(google::cloud::securitycentermanagement::v1::GetSecurityHealthAnalyticsCustomModuleRequest const &, Options)

Retrieves a SecurityHealthAnalyticsCustomModule.

Parameters
Name	Description
`request`	`google::cloud::securitycentermanagement::v1::GetSecurityHealthAnalyticsCustomModuleRequest 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.securitycentermanagement.v1.GetSecurityHealthAnalyticsCustomModuleRequest. 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::securitycentermanagement::v1::SecurityHealthAnalyticsCustomModule >`	the result of the RPC. The response message type (google.cloud.securitycentermanagement.v1.SecurityHealthAnalyticsCustomModule) is mapped to a C++ class using the Protobuf mapping rules. If the request fails, the `StatusOr` contains the error details.

CreateSecurityHealthAnalyticsCustomModule(std::string const &, google::cloud::securitycentermanagement::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. Name of the parent for the module. Its format is "organizations/{organization}/locations/{location}", "folders/{folder}/locations/{location}", or "projects/{project}/locations/{location}"
`security_health_analytics_custom_module`	`google::cloud::securitycentermanagement::v1::SecurityHealthAnalyticsCustomModule const &` Required. The resource being created
`opts`	`Options` Optional. Override the class-level options, such as retry and backoff policies.

Returns
Type	Description
`StatusOr< google::cloud::securitycentermanagement::v1::SecurityHealthAnalyticsCustomModule >`	the result of the RPC. The response message type (google.cloud.securitycentermanagement.v1.SecurityHealthAnalyticsCustomModule) is mapped to a C++ class using the Protobuf mapping rules. If the request fails, the `StatusOr` contains the error details.

CreateSecurityHealthAnalyticsCustomModule(google::cloud::securitycentermanagement::v1::CreateSecurityHealthAnalyticsCustomModuleRequest const &, Options)

These modules are enabled by default.

Parameters
Name	Description
`request`	`google::cloud::securitycentermanagement::v1::CreateSecurityHealthAnalyticsCustomModuleRequest 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.securitycentermanagement.v1.CreateSecurityHealthAnalyticsCustomModuleRequest. 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::securitycentermanagement::v1::SecurityHealthAnalyticsCustomModule >`	the result of the RPC. The response message type (google.cloud.securitycentermanagement.v1.SecurityHealthAnalyticsCustomModule) is mapped to a C++ class using the Protobuf mapping rules. If the request fails, the `StatusOr` contains the error details.

UpdateSecurityHealthAnalyticsCustomModule(google::cloud::securitycentermanagement::v1::SecurityHealthAnalyticsCustomModule const &, google::protobuf::FieldMask const &, Options)

Updates the SecurityHealthAnalyticsCustomModule under the given name based on the given update mask.

Updating the enablement state is supported on both resident and inherited modules (though resident modules cannot have an enablement state of "inherited"). Updating the display name and custom config of a module is supported on resident modules only.

Parameters
Name	Description
`security_health_analytics_custom_module`	`google::cloud::securitycentermanagement::v1::SecurityHealthAnalyticsCustomModule const &` Required. The resource being updated
`update_mask`	`google::protobuf::FieldMask const &` Required. The list of fields to be updated. The only fields that can be updated are `enablement_state` and `custom_config`. If empty or set to the wildcard value `*`, both `enablement_state` and `custom_config` are updated.
`opts`	`Options` Optional. Override the class-level options, such as retry and backoff policies.

Returns
Type	Description
`StatusOr< google::cloud::securitycentermanagement::v1::SecurityHealthAnalyticsCustomModule >`	the result of the RPC. The response message type (google.cloud.securitycentermanagement.v1.SecurityHealthAnalyticsCustomModule) is mapped to a C++ class using the Protobuf mapping rules. If the request fails, the `StatusOr` contains the error details.

UpdateSecurityHealthAnalyticsCustomModule(google::cloud::securitycentermanagement::v1::UpdateSecurityHealthAnalyticsCustomModuleRequest const &, Options)

Updates the SecurityHealthAnalyticsCustomModule under the given name based on the given update mask.

Parameters
Name	Description
`request`	`google::cloud::securitycentermanagement::v1::UpdateSecurityHealthAnalyticsCustomModuleRequest 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.securitycentermanagement.v1.UpdateSecurityHealthAnalyticsCustomModuleRequest. 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::securitycentermanagement::v1::SecurityHealthAnalyticsCustomModule >`	the result of the RPC. The response message type (google.cloud.securitycentermanagement.v1.SecurityHealthAnalyticsCustomModule) is mapped to a C++ class using the Protobuf mapping rules. If the request fails, the `StatusOr` contains the error details.

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. The resource name of the SHA custom module.
Its format is:

"organizations/{organization}/locations/{location}/securityHealthAnalyticsCustomModules/{security_health_analytics_custom_module}".
"folders/{folder}/locations/{location}/securityHealthAnalyticsCustomModules/{security_health_analytics_custom_module}".
"projects/{project}/locations/{location}/securityHealthAnalyticsCustomModules/{security_health_analytics_custom_module}".

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.

DeleteSecurityHealthAnalyticsCustomModule(google::cloud::securitycentermanagement::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::securitycentermanagement::v1::DeleteSecurityHealthAnalyticsCustomModuleRequest 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.securitycentermanagement.v1.DeleteSecurityHealthAnalyticsCustomModuleRequest. 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.

SimulateSecurityHealthAnalyticsCustomModule(std::string const &, google::cloud::securitycentermanagement::v1::CustomConfig const &, google::cloud::securitycentermanagement::v1::SimulateSecurityHealthAnalyticsCustomModuleRequest::SimulatedResource const &, Options)

Simulates a given SecurityHealthAnalyticsCustomModule and Resource.

Parameters
Name	Description
`parent`	`std::string const &` Required. The relative resource name of the organization, project, or folder. For more information about relative resource names, see Relative Resource Name Example: `organizations/{organization_id}`.
`custom_config`	`google::cloud::securitycentermanagement::v1::CustomConfig const &` Required. The custom configuration that you need to test.
`resource`	`google::cloud::securitycentermanagement::v1::SimulateSecurityHealthAnalyticsCustomModuleRequest::SimulatedResource const &` Required. Resource data to simulate custom module against.
`opts`	`Options` Optional. Override the class-level options, such as retry and backoff policies.

Returns
Type	Description
`StatusOr< google::cloud::securitycentermanagement::v1::SimulateSecurityHealthAnalyticsCustomModuleResponse >`	the result of the RPC. The response message type (google.cloud.securitycentermanagement.v1.SimulateSecurityHealthAnalyticsCustomModuleResponse) is mapped to a C++ class using the Protobuf mapping rules. If the request fails, the `StatusOr` contains the error details.

SimulateSecurityHealthAnalyticsCustomModule(google::cloud::securitycentermanagement::v1::SimulateSecurityHealthAnalyticsCustomModuleRequest const &, Options)

Simulates a given SecurityHealthAnalyticsCustomModule and Resource.

Parameters
Name	Description
`request`	`google::cloud::securitycentermanagement::v1::SimulateSecurityHealthAnalyticsCustomModuleRequest 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.securitycentermanagement.v1.SimulateSecurityHealthAnalyticsCustomModuleRequest. 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::securitycentermanagement::v1::SimulateSecurityHealthAnalyticsCustomModuleResponse >`	the result of the RPC. The response message type (google.cloud.securitycentermanagement.v1.SimulateSecurityHealthAnalyticsCustomModuleResponse) is mapped to a C++ class using the Protobuf mapping rules. If the request fails, the `StatusOr` contains the error details.

ListEffectiveEventThreatDetectionCustomModules(std::string const &, Options)

Lists all effective Event Threat Detection custom modules for the given parent.

This includes resident modules defined at the scope of the parent along with modules inherited from its ancestors.

Parameters
Name	Description
`parent`	`std::string const &` Required. Name of parent to list effective custom modules. Its format is "organizations/{organization}/locations/{location}", "folders/{folder}/locations/{location}", or "projects/{project}/locations/{location}"
`opts`	`Options` Optional. Override the class-level options, such as retry and backoff policies.

Returns

Type Description

StreamRange< google::cloud::securitycentermanagement::v1::EffectiveEventThreatDetectionCustomModule >

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.securitycentermanagement.v1.EffectiveEventThreatDetectionCustomModule, or rather, the C++ class generated by Protobuf from that type. Please consult the Protobuf documentation for details on the Protobuf mapping rules.

ListEffectiveEventThreatDetectionCustomModules(google::cloud::securitycentermanagement::v1::ListEffectiveEventThreatDetectionCustomModulesRequest, Options)

Lists all effective Event Threat Detection custom modules for the given parent.

This includes resident modules defined at the scope of the parent along with modules inherited from its ancestors.

Parameters
Name	Description
`request`	`google::cloud::securitycentermanagement::v1::ListEffectiveEventThreatDetectionCustomModulesRequest` 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.securitycentermanagement.v1.ListEffectiveEventThreatDetectionCustomModulesRequest. 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::securitycentermanagement::v1::EffectiveEventThreatDetectionCustomModule >

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.securitycentermanagement.v1.EffectiveEventThreatDetectionCustomModule, or rather, the C++ class generated by Protobuf from that type. Please consult the Protobuf documentation for details on the Protobuf mapping rules.

GetEffectiveEventThreatDetectionCustomModule(std::string const &, Options)

Gets an effective ETD custom module.

Retrieves the effective module at the given level. The difference between an EffectiveCustomModule and a CustomModule is that the fields for an EffectiveCustomModule are computed from ancestors if needed. For example, the enablement_state for a CustomModule can be either ENABLED, DISABLED, or INHERITED. Where as the enablement_state for an EffectiveCustomModule is always computed to ENABLED or DISABLED (the effective enablement_state).

Parameters

Name Description

name

std::string const &

Required. The resource name of the ETD custom module.
Its format is:

"organizations/{organization}/locations/{location}/effectiveEventThreatDetectionCustomModules/{effective_event_threat_detection_custom_module}".
"folders/{folder}/locations/{location}/effectiveEventThreatDetectionCustomModules/{effective_event_threat_detection_custom_module}".
"projects/{project}/locations/{location}/effectiveEventThreatDetectionCustomModules/{effective_event_threat_detection_custom_module}".

opts

Options

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

Returns
Type	Description
`StatusOr< google::cloud::securitycentermanagement::v1::EffectiveEventThreatDetectionCustomModule >`	the result of the RPC. The response message type (google.cloud.securitycentermanagement.v1.EffectiveEventThreatDetectionCustomModule) is mapped to a C++ class using the Protobuf mapping rules. If the request fails, the `StatusOr` contains the error details.

GetEffectiveEventThreatDetectionCustomModule(google::cloud::securitycentermanagement::v1::GetEffectiveEventThreatDetectionCustomModuleRequest const &, Options)

Gets an effective ETD custom module.

Parameters
Name	Description
`request`	`google::cloud::securitycentermanagement::v1::GetEffectiveEventThreatDetectionCustomModuleRequest 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.securitycentermanagement.v1.GetEffectiveEventThreatDetectionCustomModuleRequest. 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::securitycentermanagement::v1::EffectiveEventThreatDetectionCustomModule >`	the result of the RPC. The response message type (google.cloud.securitycentermanagement.v1.EffectiveEventThreatDetectionCustomModule) is mapped to a C++ class using the Protobuf mapping rules. If the request fails, the `StatusOr` contains the error details.

ListEventThreatDetectionCustomModules(std::string const &, Options)

Lists all Event Threat Detection custom modules for the given Resource Manager parent.

This includes resident modules defined at the scope of the parent along with modules inherited from ancestors.

Parameters
Name	Description
`parent`	`std::string const &` Required. Name of parent to list custom modules. Its format is "organizations/{organization}/locations/{location}", "folders/{folder}/locations/{location}", or "projects/{project}/locations/{location}"
`opts`	`Options` Optional. Override the class-level options, such as retry and backoff policies.

Returns

Type Description

StreamRange< google::cloud::securitycentermanagement::v1::EventThreatDetectionCustomModule >

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.securitycentermanagement.v1.EventThreatDetectionCustomModule, or rather, the C++ class generated by Protobuf from that type. Please consult the Protobuf documentation for details on the Protobuf mapping rules.

ListEventThreatDetectionCustomModules(google::cloud::securitycentermanagement::v1::ListEventThreatDetectionCustomModulesRequest, Options)

Lists all Event Threat Detection custom modules for the given Resource Manager parent.

This includes resident modules defined at the scope of the parent along with modules inherited from ancestors.

Parameters
Name	Description
`request`	`google::cloud::securitycentermanagement::v1::ListEventThreatDetectionCustomModulesRequest` 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.securitycentermanagement.v1.ListEventThreatDetectionCustomModulesRequest. 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::securitycentermanagement::v1::EventThreatDetectionCustomModule >

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.securitycentermanagement.v1.EventThreatDetectionCustomModule, or rather, the C++ class generated by Protobuf from that type. Please consult the Protobuf documentation for details on the Protobuf mapping rules.

ListDescendantEventThreatDetectionCustomModules(std::string const &, Options)

Lists all resident Event Threat Detection custom modules under the given Resource Manager parent and its descendants.

Parameters
Name	Description
`parent`	`std::string const &` Required. Name of parent to list custom modules. Its format is "organizations/{organization}/locations/{location}", "folders/{folder}/locations/{location}", or "projects/{project}/locations/{location}"
`opts`	`Options` Optional. Override the class-level options, such as retry and backoff policies.

Returns

Type Description

StreamRange< google::cloud::securitycentermanagement::v1::EventThreatDetectionCustomModule >

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.securitycentermanagement.v1.EventThreatDetectionCustomModule, or rather, the C++ class generated by Protobuf from that type. Please consult the Protobuf documentation for details on the Protobuf mapping rules.

ListDescendantEventThreatDetectionCustomModules(google::cloud::securitycentermanagement::v1::ListDescendantEventThreatDetectionCustomModulesRequest, Options)

Lists all resident Event Threat Detection custom modules under the given Resource Manager parent and its descendants.

Parameters
Name	Description
`request`	`google::cloud::securitycentermanagement::v1::ListDescendantEventThreatDetectionCustomModulesRequest` 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.securitycentermanagement.v1.ListDescendantEventThreatDetectionCustomModulesRequest. 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::securitycentermanagement::v1::EventThreatDetectionCustomModule >

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.securitycentermanagement.v1.EventThreatDetectionCustomModule, or rather, the C++ class generated by Protobuf from that type. Please consult the Protobuf documentation for details on the Protobuf mapping rules.

GetEventThreatDetectionCustomModule(std::string const &, Options)

Gets an Event Threat Detection custom module.

Parameters

Name Description

name

std::string const &

Required. The resource name of the ETD custom module.
Its format is:

"organizations/{organization}/locations/{location}/eventThreatDetectionCustomModules/{event_threat_detection_custom_module}".
"folders/{folder}/locations/{location}/eventThreatDetectionCustomModules/{event_threat_detection_custom_module}".
"projects/{project}/locations/{location}/eventThreatDetectionCustomModules/{event_threat_detection_custom_module}".

opts

Options

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

Returns
Type	Description
`StatusOr< google::cloud::securitycentermanagement::v1::EventThreatDetectionCustomModule >`	the result of the RPC. The response message type (google.cloud.securitycentermanagement.v1.EventThreatDetectionCustomModule) is mapped to a C++ class using the Protobuf mapping rules. If the request fails, the `StatusOr` contains the error details.

GetEventThreatDetectionCustomModule(google::cloud::securitycentermanagement::v1::GetEventThreatDetectionCustomModuleRequest const &, Options)

Gets an Event Threat Detection custom module.

Parameters
Name	Description
`request`	`google::cloud::securitycentermanagement::v1::GetEventThreatDetectionCustomModuleRequest 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.securitycentermanagement.v1.GetEventThreatDetectionCustomModuleRequest. 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::securitycentermanagement::v1::EventThreatDetectionCustomModule >`	the result of the RPC. The response message type (google.cloud.securitycentermanagement.v1.EventThreatDetectionCustomModule) is mapped to a C++ class using the Protobuf mapping rules. If the request fails, the `StatusOr` contains the error details.

CreateEventThreatDetectionCustomModule(std::string const &, google::cloud::securitycentermanagement::v1::EventThreatDetectionCustomModule const &, Options)

Creates a resident Event Threat Detection custom module at the scope of the given Resource Manager parent, and also creates inherited custom modules for all descendants of the given parent.

These modules are enabled by default.

Parameters
Name	Description
`parent`	`std::string const &` Required. Name of parent for the module. Its format is "organizations/{organization}/locations/{location}", "folders/{folder}/locations/{location}", or "projects/{project}/locations/{location}"
`event_threat_detection_custom_module`	`google::cloud::securitycentermanagement::v1::EventThreatDetectionCustomModule const &` Required. The module to create. The event_threat_detection_custom_module.name will be ignored and server generated.
`opts`	`Options` Optional. Override the class-level options, such as retry and backoff policies.

Returns
Type	Description
`StatusOr< google::cloud::securitycentermanagement::v1::EventThreatDetectionCustomModule >`	the result of the RPC. The response message type (google.cloud.securitycentermanagement.v1.EventThreatDetectionCustomModule) is mapped to a C++ class using the Protobuf mapping rules. If the request fails, the `StatusOr` contains the error details.

CreateEventThreatDetectionCustomModule(google::cloud::securitycentermanagement::v1::CreateEventThreatDetectionCustomModuleRequest const &, Options)

Creates a resident Event Threat Detection custom module at the scope of the given Resource Manager parent, and also creates inherited custom modules for all descendants of the given parent.

These modules are enabled by default.

Parameters
Name	Description
`request`	`google::cloud::securitycentermanagement::v1::CreateEventThreatDetectionCustomModuleRequest 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.securitycentermanagement.v1.CreateEventThreatDetectionCustomModuleRequest. 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::securitycentermanagement::v1::EventThreatDetectionCustomModule >`	the result of the RPC. The response message type (google.cloud.securitycentermanagement.v1.EventThreatDetectionCustomModule) is mapped to a C++ class using the Protobuf mapping rules. If the request fails, the `StatusOr` contains the error details.

UpdateEventThreatDetectionCustomModule(google::cloud::securitycentermanagement::v1::EventThreatDetectionCustomModule const &, google::protobuf::FieldMask const &, Options)

Updates the Event Threat Detection custom module with the given name based on the given update mask.

Updating the enablement state is supported for both resident and inherited modules (though resident modules cannot have an enablement state of "inherited"). Updating the display name or configuration of a module is supported for resident modules only. The type of a module cannot be changed.

Parameters
Name	Description
`event_threat_detection_custom_module`	`google::cloud::securitycentermanagement::v1::EventThreatDetectionCustomModule const &` Required. The module being updated
`update_mask`	`google::protobuf::FieldMask const &` Required. Field mask is used to specify the fields to be overwritten in the EventThreatDetectionCustomModule resource by the update. The fields specified in the update_mask are relative to the resource, not the full request. A field will be overwritten if it is in the mask. If the user does not provide a mask then all fields will be overwritten.
`opts`	`Options` Optional. Override the class-level options, such as retry and backoff policies.

Returns
Type	Description
`StatusOr< google::cloud::securitycentermanagement::v1::EventThreatDetectionCustomModule >`	the result of the RPC. The response message type (google.cloud.securitycentermanagement.v1.EventThreatDetectionCustomModule) is mapped to a C++ class using the Protobuf mapping rules. If the request fails, the `StatusOr` contains the error details.

UpdateEventThreatDetectionCustomModule(google::cloud::securitycentermanagement::v1::UpdateEventThreatDetectionCustomModuleRequest const &, Options)

Updates the Event Threat Detection custom module with the given name based on the given update mask.

Parameters
Name	Description
`request`	`google::cloud::securitycentermanagement::v1::UpdateEventThreatDetectionCustomModuleRequest 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.securitycentermanagement.v1.UpdateEventThreatDetectionCustomModuleRequest. 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::securitycentermanagement::v1::EventThreatDetectionCustomModule >`	the result of the RPC. The response message type (google.cloud.securitycentermanagement.v1.EventThreatDetectionCustomModule) is mapped to a C++ class using the Protobuf mapping rules. If the request fails, the `StatusOr` contains the error details.

DeleteEventThreatDetectionCustomModule(std::string const &, Options)

Deletes the specified Event Threat Detection custom module and all of its descendants in the Resource Manager hierarchy.

This method is only supported for resident custom modules.

Parameters

Name Description

name

std::string const &

Required. The resource name of the ETD custom module.
Its format is:

"organizations/{organization}/locations/{location}/eventThreatDetectionCustomModules/{event_threat_detection_custom_module}".
"folders/{folder}/locations/{location}/eventThreatDetectionCustomModules/{event_threat_detection_custom_module}".
"projects/{project}/locations/{location}/eventThreatDetectionCustomModules/{event_threat_detection_custom_module}".

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.

DeleteEventThreatDetectionCustomModule(google::cloud::securitycentermanagement::v1::DeleteEventThreatDetectionCustomModuleRequest const &, Options)

Deletes the specified Event Threat Detection custom module and all of its descendants in the Resource Manager hierarchy.

This method is only supported for resident custom modules.

Parameters
Name	Description
`request`	`google::cloud::securitycentermanagement::v1::DeleteEventThreatDetectionCustomModuleRequest 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.securitycentermanagement.v1.DeleteEventThreatDetectionCustomModuleRequest. 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.

ValidateEventThreatDetectionCustomModule(google::cloud::securitycentermanagement::v1::ValidateEventThreatDetectionCustomModuleRequest const &, Options)

Validates the given Event Threat Detection custom module.

Parameters
Name	Description
`request`	`google::cloud::securitycentermanagement::v1::ValidateEventThreatDetectionCustomModuleRequest 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.securitycentermanagement.v1.ValidateEventThreatDetectionCustomModuleRequest. 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::securitycentermanagement::v1::ValidateEventThreatDetectionCustomModuleResponse >`	the result of the RPC. The response message type (google.cloud.securitycentermanagement.v1.ValidateEventThreatDetectionCustomModuleResponse) is mapped to a C++ class using the Protobuf mapping rules. If the request fails, the `StatusOr` contains the error details.