Google Cloud Security Center Management V1 Client - Class DeleteSecurityHealthAnalyticsCustomModuleRequest (1.1.0)

Reference documentation and code samples for the Google Cloud Security Center Management V1 Client class DeleteSecurityHealthAnalyticsCustomModuleRequest.

Request message for SecurityCenterManagement.DeleteSecurityHealthAnalyticsCustomModule.

Generated from protobuf message google.cloud.securitycentermanagement.v1.DeleteSecurityHealthAnalyticsCustomModuleRequest

Namespace

Google \ Cloud \ SecurityCenterManagement \ V1

Methods

__construct

Constructor.

Parameters
Name Description
data array

Optional. Data for populating the Message object.
↳ name string

Required. The resource name of the SHA custom module, in one of the following formats: * organizations/{organization}/locations/{location}/securityHealthAnalyticsCustomModules/{custom_module} * folders/{folder}/locations/{location}/securityHealthAnalyticsCustomModules/{custom_module} * projects/{project}/locations/{location}/securityHealthAnalyticsCustomModules/{custom_module}
↳ validate_only bool

Optional. When set to true, the request will be validated (including IAM checks), but no module will be deleted. An OK response indicates that the request is valid, while an error response indicates that the request is invalid. If the request is valid, a subsequent request to delete the module could still fail for one of the following reasons: * The state of your cloud resources changed; for example, you lost a required IAM permission * An error occurred during deletion of the module Defaults to false.

getName

Required. The resource name of the SHA custom module, in one of the following formats:

  • organizations/{organization}/locations/{location}/securityHealthAnalyticsCustomModules/{custom_module}
  • folders/{folder}/locations/{location}/securityHealthAnalyticsCustomModules/{custom_module}
  • projects/{project}/locations/{location}/securityHealthAnalyticsCustomModules/{custom_module}
Returns
Type Description
string

setName

Required. The resource name of the SHA custom module, in one of the following formats:

  • organizations/{organization}/locations/{location}/securityHealthAnalyticsCustomModules/{custom_module}
  • folders/{folder}/locations/{location}/securityHealthAnalyticsCustomModules/{custom_module}
  • projects/{project}/locations/{location}/securityHealthAnalyticsCustomModules/{custom_module}
Parameter
Name Description
var string
Returns
Type Description
$this

getValidateOnly

Optional. When set to true, the request will be validated (including IAM checks), but no module will be deleted. An OK response indicates that the request is valid, while an error response indicates that the request is invalid.

If the request is valid, a subsequent request to delete the module could still fail for one of the following reasons:

  • The state of your cloud resources changed; for example, you lost a required IAM permission
  • An error occurred during deletion of the module Defaults to false.
Returns
Type Description
bool

setValidateOnly

Optional. When set to true, the request will be validated (including IAM checks), but no module will be deleted. An OK response indicates that the request is valid, while an error response indicates that the request is invalid.

If the request is valid, a subsequent request to delete the module could still fail for one of the following reasons:

  • The state of your cloud resources changed; for example, you lost a required IAM permission
  • An error occurred during deletion of the module Defaults to false.
Parameter
Name Description
var bool
Returns
Type Description
$this

static::build

Parameter
Name Description
name string

Required. The resource name of the SHA custom module, in one of the following formats:

  • organizations/{organization}/locations/{location}/securityHealthAnalyticsCustomModules/{custom_module}
  • folders/{folder}/locations/{location}/securityHealthAnalyticsCustomModules/{custom_module}
  • projects/{project}/locations/{location}/securityHealthAnalyticsCustomModules/{custom_module} Please see Google\Cloud\SecurityCenterManagement\V1\SecurityCenterManagementClient::securityHealthAnalyticsCustomModuleName() for help formatting this field.
Returns
Type Description
Google\Cloud\SecurityCenterManagement\V1\DeleteSecurityHealthAnalyticsCustomModuleRequest