Reference documentation and code samples for the Google Cloud Security Compliance V1 Client class FrameworkDeployment.
FrameworkDeployment represents deployment of a Framework on a target resource. Supported target resources are organizations/{organization}, folders/{folder}, and projects/{project}.
Generated from protobuf message google.cloud.cloudsecuritycompliance.v1.FrameworkDeployment
Namespace
Google \ Cloud \ CloudSecurityCompliance \ V1Methods
__construct
Constructor.
| Parameters | |
|---|---|
| Name | Description |
data |
array
Optional. Data for populating the Message object. |
↳ name |
string
Identifier. FrameworkDeployment name in the following format: organizations/{organization}/locations/{location}/frameworkDeployments/{framework_deployment_id} |
↳ target_resource_config |
TargetResourceConfig
Required. The details of the target resource on which the Framework is to be deployed. It can either be an existing target resource or a new target resource to be created. |
↳ computed_target_resource |
string
Output only. The resource on which the Framework is deployed based on the provided TargetResourceConfig in the following format: organizations/{organization}, folders/{folder} or projects/{project} |
↳ framework |
FrameworkReference
Required. Reference to the framework to be deployed. |
↳ description |
string
Optional. User provided description of the Framework deployment |
↳ cloud_control_metadata |
array<CloudControlMetadata>
Required. Deployment mode and parameters for each of the Cloud Controls in the framework. Every Cloud Control in the framework must have a CloudControlMetadata. |
↳ deployment_state |
int
Output only. State of the Framework Deployment |
↳ create_time |
Google\Protobuf\Timestamp
Output only. The time at which the resource was created. |
↳ update_time |
Google\Protobuf\Timestamp
Output only. The time at which the resource last updated. |
↳ etag |
string
Optional. To prevent concurrent updates from overwriting each other, always provide the |
↳ target_resource_display_name |
string
Output only. The display name of the target resource. |
↳ cloud_control_deployment_references |
array<CloudControlDeploymentReference>
Output only. The references to the cloud control deployments. It has all the CloudControlDeployments which are either directly added in the framework or through a CloudControlGroup. Example: If a framework deployment deploys two cloud controls, cc-deployment-1 and cc-deployment-2, then the cloud_control_deployment_references will be: { cloud_control_deployment_reference: { cloud_control_deployment: "organizations/{organization}/locations/{location}/cloudControlDeployments/cc-deployment-1" }, cloud_control_deployment_reference: { cloud_control_deployment: "organizations/{organization}/locations/{location}/cloudControlDeployments/cc-deployment-2" } |
getName
Identifier. FrameworkDeployment name in the following format: organizations/{organization}/locations/{location}/frameworkDeployments/{framework_deployment_id}
| Returns | |
|---|---|
| Type | Description |
string |
|
setName
Identifier. FrameworkDeployment name in the following format: organizations/{organization}/locations/{location}/frameworkDeployments/{framework_deployment_id}
| Parameter | |
|---|---|
| Name | Description |
var |
string
|
| Returns | |
|---|---|
| Type | Description |
$this |
|
getTargetResourceConfig
Required. The details of the target resource on which the Framework is to be deployed. It can either be an existing target resource or a new target resource to be created.
| Returns | |
|---|---|
| Type | Description |
TargetResourceConfig|null |
|
hasTargetResourceConfig
clearTargetResourceConfig
setTargetResourceConfig
Required. The details of the target resource on which the Framework is to be deployed. It can either be an existing target resource or a new target resource to be created.
| Parameter | |
|---|---|
| Name | Description |
var |
TargetResourceConfig
|
| Returns | |
|---|---|
| Type | Description |
$this |
|
getComputedTargetResource
Output only. The resource on which the Framework is deployed based on the provided TargetResourceConfig in the following format: organizations/{organization}, folders/{folder} or projects/{project}
| Returns | |
|---|---|
| Type | Description |
string |
|
setComputedTargetResource
Output only. The resource on which the Framework is deployed based on the provided TargetResourceConfig in the following format: organizations/{organization}, folders/{folder} or projects/{project}
| Parameter | |
|---|---|
| Name | Description |
var |
string
|
| Returns | |
|---|---|
| Type | Description |
$this |
|
getFramework
Required. Reference to the framework to be deployed.
| Returns | |
|---|---|
| Type | Description |
FrameworkReference|null |
|
hasFramework
clearFramework
setFramework
Required. Reference to the framework to be deployed.
| Parameter | |
|---|---|
| Name | Description |
var |
FrameworkReference
|
| Returns | |
|---|---|
| Type | Description |
$this |
|
getDescription
Optional. User provided description of the Framework deployment
| Returns | |
|---|---|
| Type | Description |
string |
|
setDescription
Optional. User provided description of the Framework deployment
| Parameter | |
|---|---|
| Name | Description |
var |
string
|
| Returns | |
|---|---|
| Type | Description |
$this |
|
getCloudControlMetadata
Required. Deployment mode and parameters for each of the Cloud Controls in the framework. Every Cloud Control in the framework must have a CloudControlMetadata.
| Returns | |
|---|---|
| Type | Description |
Google\Protobuf\Internal\RepeatedField |
|
setCloudControlMetadata
Required. Deployment mode and parameters for each of the Cloud Controls in the framework. Every Cloud Control in the framework must have a CloudControlMetadata.
| Parameter | |
|---|---|
| Name | Description |
var |
array<CloudControlMetadata>
|
| Returns | |
|---|---|
| Type | Description |
$this |
|
getDeploymentState
Output only. State of the Framework Deployment
| Returns | |
|---|---|
| Type | Description |
int |
Enum of type DeploymentState. |
setDeploymentState
Output only. State of the Framework Deployment
| Parameter | |
|---|---|
| Name | Description |
var |
int
Enum of type DeploymentState. |
| Returns | |
|---|---|
| Type | Description |
$this |
|
getCreateTime
Output only. The time at which the resource was created.
| Returns | |
|---|---|
| Type | Description |
Google\Protobuf\Timestamp|null |
|
hasCreateTime
clearCreateTime
setCreateTime
Output only. The time at which the resource was created.
| Parameter | |
|---|---|
| Name | Description |
var |
Google\Protobuf\Timestamp
|
| Returns | |
|---|---|
| Type | Description |
$this |
|
getUpdateTime
Output only. The time at which the resource last updated.
| Returns | |
|---|---|
| Type | Description |
Google\Protobuf\Timestamp|null |
|
hasUpdateTime
clearUpdateTime
setUpdateTime
Output only. The time at which the resource last updated.
| Parameter | |
|---|---|
| Name | Description |
var |
Google\Protobuf\Timestamp
|
| Returns | |
|---|---|
| Type | Description |
$this |
|
getEtag
Optional. To prevent concurrent updates from overwriting each other, always
provide the etag when you update a FrameworkDeployment. You can also
provide the etag when you delete a FrameworkDeployment, to help
ensure that you're deleting the intended version of the
FrameworkDeployment.
| Returns | |
|---|---|
| Type | Description |
string |
|
setEtag
Optional. To prevent concurrent updates from overwriting each other, always
provide the etag when you update a FrameworkDeployment. You can also
provide the etag when you delete a FrameworkDeployment, to help
ensure that you're deleting the intended version of the
FrameworkDeployment.
| Parameter | |
|---|---|
| Name | Description |
var |
string
|
| Returns | |
|---|---|
| Type | Description |
$this |
|
getTargetResourceDisplayName
Output only. The display name of the target resource.
| Returns | |
|---|---|
| Type | Description |
string |
|
setTargetResourceDisplayName
Output only. The display name of the target resource.
| Parameter | |
|---|---|
| Name | Description |
var |
string
|
| Returns | |
|---|---|
| Type | Description |
$this |
|
getCloudControlDeploymentReferences
Output only. The references to the cloud control deployments. It has all the CloudControlDeployments which are either directly added in the framework or through a CloudControlGroup. Example: If a framework deployment deploys two cloud controls, cc-deployment-1 and cc-deployment-2, then the cloud_control_deployment_references will be: { cloud_control_deployment_reference: { cloud_control_deployment: "organizations/{organization}/locations/{location}/cloudControlDeployments/cc-deployment-1" }, cloud_control_deployment_reference: { cloud_control_deployment: "organizations/{organization}/locations/{location}/cloudControlDeployments/cc-deployment-2" }
| Returns | |
|---|---|
| Type | Description |
Google\Protobuf\Internal\RepeatedField |
|
setCloudControlDeploymentReferences
Output only. The references to the cloud control deployments. It has all the CloudControlDeployments which are either directly added in the framework or through a CloudControlGroup. Example: If a framework deployment deploys two cloud controls, cc-deployment-1 and cc-deployment-2, then the cloud_control_deployment_references will be: { cloud_control_deployment_reference: { cloud_control_deployment: "organizations/{organization}/locations/{location}/cloudControlDeployments/cc-deployment-1" }, cloud_control_deployment_reference: { cloud_control_deployment: "organizations/{organization}/locations/{location}/cloudControlDeployments/cc-deployment-2" }
| Parameter | |
|---|---|
| Name | Description |
var |
array<CloudControlDeploymentReference>
|
| Returns | |
|---|---|
| Type | Description |
$this |
|