Reference documentation and code samples for the Google Cloud Security Compliance V1 Client class CloudControlDeployment.
CloudControlDeployment represents deployment of a CloudControl on a target resource. Supported target resources are organizations/{organization}, folders/{folder}, and projects/{project}.
Generated from protobuf message google.cloud.cloudsecuritycompliance.v1.CloudControlDeployment
Namespace
Google \ Cloud \ CloudSecurityCompliance \ V1Methods
__construct
Constructor.
| Parameters | |
|---|---|
| Name | Description |
data |
array
Optional. Data for populating the Message object. |
↳ name |
string
Identifier. CloudControlDeployment name in the following format: organizations/{organization}/locations/{location}/cloudControlDeployments/{cloud_control_deployment_id} |
↳ target_resource_config |
TargetResourceConfig
Required. The details of the target resource on which the CloudControl is to be deployed. It can either be an existing target resource or a new target resource to be created. |
↳ target_resource |
string
Output only. The resource on which the CloudControl is deployed based on the provided TargetResourceConfig in the following format: organizations/{organization}, folders/{folder} or projects/{project}. |
↳ cloud_control_metadata |
CloudControlMetadata
Required. Deployment mode and parameters for the Cloud Control. |
↳ description |
string
Optional. User provided description of the CloudControl deployment |
↳ deployment_state |
int
Output only. State of the CloudControl 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 |
↳ parameter_substituted_cloud_control |
CloudControl
Output only. The CloudControl after substitution of given parameters. |
↳ framework_deployment_references |
array<FrameworkDeploymentReference>
Output only. The references to the Framework deployments that this Cloud Control deployment is part of. A Cloud Control deployment can be part of multiple Framework deployments. |
↳ target_resource_display_name |
string
Output only. The display name of the target resource. |
getName
Identifier. CloudControlDeployment name in the following format: organizations/{organization}/locations/{location}/cloudControlDeployments/{cloud_control_deployment_id}
| Returns | |
|---|---|
| Type | Description |
string |
|
setName
Identifier. CloudControlDeployment name in the following format: organizations/{organization}/locations/{location}/cloudControlDeployments/{cloud_control_deployment_id}
| Parameter | |
|---|---|
| Name | Description |
var |
string
|
| Returns | |
|---|---|
| Type | Description |
$this |
|
getTargetResourceConfig
Required. The details of the target resource on which the CloudControl 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 CloudControl 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 |
|
getTargetResource
Output only. The resource on which the CloudControl is deployed based on the provided TargetResourceConfig in the following format: organizations/{organization}, folders/{folder} or projects/{project}.
| Returns | |
|---|---|
| Type | Description |
string |
|
setTargetResource
Output only. The resource on which the CloudControl 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 |
|
getCloudControlMetadata
Required. Deployment mode and parameters for the Cloud Control.
| Returns | |
|---|---|
| Type | Description |
CloudControlMetadata|null |
|
hasCloudControlMetadata
clearCloudControlMetadata
setCloudControlMetadata
Required. Deployment mode and parameters for the Cloud Control.
| Parameter | |
|---|---|
| Name | Description |
var |
CloudControlMetadata
|
| Returns | |
|---|---|
| Type | Description |
$this |
|
getDescription
Optional. User provided description of the CloudControl deployment
| Returns | |
|---|---|
| Type | Description |
string |
|
setDescription
Optional. User provided description of the CloudControl deployment
| Parameter | |
|---|---|
| Name | Description |
var |
string
|
| Returns | |
|---|---|
| Type | Description |
$this |
|
getDeploymentState
Output only. State of the CloudControl deployment
| Returns | |
|---|---|
| Type | Description |
int |
Enum of type DeploymentState. |
setDeploymentState
Output only. State of the CloudControl 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 CloudControlDeployment. You can also
provide the etag when you delete a CloudControlDeployment, to help
ensure that you're deleting the intended version of the
CloudControlDeployment.
| Returns | |
|---|---|
| Type | Description |
string |
|
setEtag
Optional. To prevent concurrent updates from overwriting each other, always
provide the etag when you update a CloudControlDeployment. You can also
provide the etag when you delete a CloudControlDeployment, to help
ensure that you're deleting the intended version of the
CloudControlDeployment.
| Parameter | |
|---|---|
| Name | Description |
var |
string
|
| Returns | |
|---|---|
| Type | Description |
$this |
|
getParameterSubstitutedCloudControl
Output only. The CloudControl after substitution of given parameters.
| Returns | |
|---|---|
| Type | Description |
CloudControl|null |
|
hasParameterSubstitutedCloudControl
clearParameterSubstitutedCloudControl
setParameterSubstitutedCloudControl
Output only. The CloudControl after substitution of given parameters.
| Parameter | |
|---|---|
| Name | Description |
var |
CloudControl
|
| Returns | |
|---|---|
| Type | Description |
$this |
|
getFrameworkDeploymentReferences
Output only. The references to the Framework deployments that this Cloud Control deployment is part of. A Cloud Control deployment can be part of multiple Framework deployments.
| Returns | |
|---|---|
| Type | Description |
Google\Protobuf\Internal\RepeatedField |
|
setFrameworkDeploymentReferences
Output only. The references to the Framework deployments that this Cloud Control deployment is part of. A Cloud Control deployment can be part of multiple Framework deployments.
| Parameter | |
|---|---|
| Name | Description |
var |
array<FrameworkDeploymentReference>
|
| 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 |
|