Google Cloud Security Center Management V1 Client - Class CreateSecurityHealthAnalyticsCustomModuleRequest (1.0.0)

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

Message for creating a SecurityHealthAnalyticsCustomModule

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

Namespace

Google \ Cloud \ SecurityCenterManagement \ V1

Methods

__construct

Constructor.

Parameters
Name Description
data array

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

Required. Name of the parent organization, folder, or project of the module, specified in one of the following formats: * organizations/{organization}/locations/{location} * folders/{folder}/locations/{location} * projects/{project}/locations/{location}
↳ security_health_analytics_custom_module Google\Cloud\SecurityCenterManagement\V1\SecurityHealthAnalyticsCustomModule

Required. The resource being created
↳ validate_only bool

Optional. When set to true, only validations (including IAM checks) will done for the request (no module will be created). An OK response indicates the request is valid while an error response indicates the request is invalid. Note that a subsequent request to actually create the module could still fail because: 1. the state could have changed (e.g. IAM permission lost) or 2. A failure occurred during creation of the module. Defaults to false.

getParent

Required. Name of the parent organization, folder, or project of the module, specified in one of the following formats:

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

setParent

Required. Name of the parent organization, folder, or project of the module, specified in one of the following formats:

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

getSecurityHealthAnalyticsCustomModule

Required. The resource being created

Returns
Type Description
Google\Cloud\SecurityCenterManagement\V1\SecurityHealthAnalyticsCustomModule|null

hasSecurityHealthAnalyticsCustomModule

clearSecurityHealthAnalyticsCustomModule

setSecurityHealthAnalyticsCustomModule

Required. The resource being created

Parameter
Name Description
var Google\Cloud\SecurityCenterManagement\V1\SecurityHealthAnalyticsCustomModule
Returns
Type Description
$this

getValidateOnly

Optional. When set to true, only validations (including IAM checks) will done for the request (no module will be created). An OK response indicates the request is valid while an error response indicates the request is invalid. Note that a subsequent request to actually create the module could still fail because:

  1. the state could have changed (e.g. IAM permission lost) or
  2. A failure occurred during creation of the module.

Defaults to false.

Returns
Type Description
bool

setValidateOnly

Optional. When set to true, only validations (including IAM checks) will done for the request (no module will be created). An OK response indicates the request is valid while an error response indicates the request is invalid. Note that a subsequent request to actually create the module could still fail because:

  1. the state could have changed (e.g. IAM permission lost) or
  2. A failure occurred during creation of the module.

Defaults to false.

Parameter
Name Description
var bool
Returns
Type Description
$this

static::build

Parameters
Name Description
parent string

Required. Name of the parent organization, folder, or project of the module, specified in one of the following formats:

  • organizations/{organization}/locations/{location}
  • folders/{folder}/locations/{location}
  • projects/{project}/locations/{location} Please see Google\Cloud\SecurityCenterManagement\V1\SecurityCenterManagementClient::organizationLocationName() for help formatting this field.
securityHealthAnalyticsCustomModule Google\Cloud\SecurityCenterManagement\V1\SecurityHealthAnalyticsCustomModule

Required. The resource being created
Returns
Type Description
Google\Cloud\SecurityCenterManagement\V1\CreateSecurityHealthAnalyticsCustomModuleRequest