Google Cloud Security Compliance V1 Client - Class Framework (0.1.0)

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

A Framework is a collection of CloudControls to address security and compliance requirements. Frameworks can be used for prevention, detection, and auditing. They can be either built-in, industry-standard frameworks provided by GCP/AZURE/AWS (e.g., NIST, FedRAMP) or custom frameworks created by users.

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

Namespace

Google \ Cloud \ CloudSecurityCompliance \ V1

Methods

__construct

Constructor.

Parameters
Name	Description
`data`	`array` Optional. Data for populating the Message object.
`↳ name`	`string` Required. Identifier. The name of the framework. Format: organizations/{organization}/locations/{location}/frameworks/{framework_id}
`↳ major_revision_id`	`int\|string` Output only. Major revision of the framework incremented in ascending order.
`↳ display_name`	`string` Optional. Display name of the framework. The maximum length is 200 characters.
`↳ description`	`string` Optional. The description of the framework. The maximum length is 2000 characters.
`↳ type`	`int` Output only. The type of the framework. The default is TYPE_CUSTOM.
`↳ cloud_control_details`	`array<CloudControlDetails>` Optional. The details of the cloud controls directly added without any grouping in the framework.
`↳ category`	`array` Optional. The category of the framework.
`↳ supported_cloud_providers`	`array` Output only. cloud providers supported
`↳ supported_target_resource_types`	`array` Output only. target resource types supported by the Framework.
`↳ supported_enforcement_modes`	`array` Output only. The supported enforcement modes of the framework.

getName

Required. Identifier. The name of the framework.

Format: organizations/{organization}/locations/{location}/frameworks/{framework_id}

Returns
Type	Description
`string`

setName

Required. Identifier. The name of the framework.

Format: organizations/{organization}/locations/{location}/frameworks/{framework_id}

Parameter
Name	Description
`var`	`string`

Returns
Type	Description
`$this`

getMajorRevisionId

Output only. Major revision of the framework incremented in ascending order.

Returns
Type	Description
`int\|string`

setMajorRevisionId

Output only. Major revision of the framework incremented in ascending order.

Parameter
Name	Description
`var`	`int\|string`

Returns
Type	Description
`$this`

getDisplayName

Optional. Display name of the framework. The maximum length is 200 characters.

Returns
Type	Description
`string`

setDisplayName

Optional. Display name of the framework. The maximum length is 200 characters.

Parameter
Name	Description
`var`	`string`

Returns
Type	Description
`$this`

getDescription

Optional. The description of the framework. The maximum length is 2000 characters.

Returns
Type	Description
`string`

setDescription

Optional. The description of the framework. The maximum length is 2000 characters.

Parameter
Name	Description
`var`	`string`

Returns
Type	Description
`$this`

getType

Output only. The type of the framework. The default is TYPE_CUSTOM.

Returns
Type	Description
`int`	Enum of type FrameworkType.

setType

Output only. The type of the framework. The default is TYPE_CUSTOM.

Parameter
Name	Description
`var`	`int` Enum of type FrameworkType.

Returns
Type	Description
`$this`

getCloudControlDetails

Optional. The details of the cloud controls directly added without any grouping in the framework.

Returns
Type	Description
`Google\Protobuf\Internal\RepeatedField`

setCloudControlDetails

Optional. The details of the cloud controls directly added without any grouping in the framework.

Parameter
Name	Description
`var`	`array<CloudControlDetails>`

Returns
Type	Description
`$this`

getCategory

Optional. The category of the framework.

Returns
Type	Description
`Google\Protobuf\Internal\RepeatedField`

setCategory