Google Cloud Security Compliance V1 Client - Class CmEnrollment (0.2.0)

Reference documentation and code samples for the Google Cloud Security Compliance V1 Client class CmEnrollment.

The settings for Compliance Manager at a specific resource scope.=

Generated from protobuf message google.cloud.cloudsecuritycompliance.v1.CmEnrollment

Namespace

Google \ Cloud \ CloudSecurityCompliance \ V1

Methods

__construct

Constructor.

Parameters
Name Description
data array

Optional. Data for populating the Message object.

↳ name string

Identifier. The name of the Compliance Manager enrollment. Supported formats are the following: * * organizations/{organization_id}/locations/{location}/cmEnrollment * * folders/{folder_id}/locations/{location}/cmEnrollment * * projects/{project_id}/locations/{location}/cmEnrollment

↳ enrolled bool

Optional. Whether the resource is enrolled in Compliance Manager. This setting is inherited by all descendants.

↳ audit_config AuditConfig

Optional. The audit configuration for Compliance Manager. If set at a scope, this configuration overrides any inherited audit configuration.

getName

Identifier. The name of the Compliance Manager enrollment.

Supported formats are the following:

  • organizations/{organization_id}/locations/{location}/cmEnrollment
  • folders/{folder_id}/locations/{location}/cmEnrollment
  • projects/{project_id}/locations/{location}/cmEnrollment
Returns
Type Description
string

setName

Identifier. The name of the Compliance Manager enrollment.

Supported formats are the following:

  • organizations/{organization_id}/locations/{location}/cmEnrollment
  • folders/{folder_id}/locations/{location}/cmEnrollment
  • projects/{project_id}/locations/{location}/cmEnrollment
Parameter
Name Description
var string
Returns
Type Description
$this

getEnrolled

Optional. Whether the resource is enrolled in Compliance Manager.

This setting is inherited by all descendants.

Returns
Type Description
bool

setEnrolled

Optional. Whether the resource is enrolled in Compliance Manager.

This setting is inherited by all descendants.

Parameter
Name Description
var bool
Returns
Type Description
$this

getAuditConfig

Optional. The audit configuration for Compliance Manager.

If set at a scope, this configuration overrides any inherited audit configuration.

Returns
Type Description
AuditConfig|null

hasAuditConfig

clearAuditConfig

setAuditConfig

Optional. The audit configuration for Compliance Manager.

If set at a scope, this configuration overrides any inherited audit configuration.

Parameter
Name Description
var AuditConfig
Returns
Type Description
$this