Console
    Start free

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

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

    Framework deployments represent the assignment of a framework to a target resource. Supported target resources are organizations, folders, and projects.

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

    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 framework deployment, in the format organizations/{organization}/locations/{location}/frameworkDeployments/{framework_deployment_id} . The only supported location is global .

    ↳ target_resource_config
    TargetResourceConfig

    Required. The details of the target resource that you want to deploy the framework to. You can specify an existing resource, or create a new one.

    ↳ computed_target_resource
    string

    Output only. The target resource to deploy the framework to, in one the following formats: - organizations/{organizationID} - folders/{folderID} - projects/{projectID}

    ↳ framework
    FrameworkReference

    Required. A reference to the framework that you're deploying.

    ↳ description
    string

    Optional. A user-provided description of the framework deployment.

    ↳ cloud_control_metadata
    array< CloudControlMetadata >

    Required. The deployment mode and parameters for each of the cloud controls in the framework. Every cloud control in the framework includes metadata.

    ↳ deployment_state
    int

    Output only. The state for 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 etag when you update a framework deployment. You can also provide the etag when you delete a framework deployment, to help ensure that you're deleting the intended version of the framework deployment.

    ↳ 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. The reference includes all the cloud control deployments that are in the framework or in a cloud control group. For example, if a framework deployment deploys two cloud controls, cc-deployment-1 and cc-deployment-2 , then the references are: { 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. The name of the framework deployment, in the format organizations/{organization}/locations/{location}/frameworkDeployments/{framework_deployment_id} .

    The only supported location is global .

    Returns
    Type
    Description
    string

    setName

    Identifier. The name of the framework deployment, in the format organizations/{organization}/locations/{location}/frameworkDeployments/{framework_deployment_id} .

    The only supported location is global .

    Parameter
    Name
    Description
    var
    string
    Returns
    Type
    Description
    $this

    getTargetResourceConfig

    Required. The details of the target resource that you want to deploy the framework to. You can specify an existing resource, or create a new one.

    Returns
    Type
    Description
    TargetResourceConfig |null

    hasTargetResourceConfig

    clearTargetResourceConfig

    setTargetResourceConfig

    Required. The details of the target resource that you want to deploy the framework to. You can specify an existing resource, or create a new one.

    Parameter
    Name
    Description
    var
    TargetResourceConfig
    Returns
    Type
    Description
    $this

    getComputedTargetResource

    Output only. The target resource to deploy the framework to, in one the following formats:

    • organizations/{organizationID}
    • folders/{folderID}
    • projects/{projectID}
    Returns
    Type
    Description
    string

    setComputedTargetResource

    Output only. The target resource to deploy the framework to, in one the following formats:

    • organizations/{organizationID}
    • folders/{folderID}
    • projects/{projectID}
    Parameter
    Name
    Description
    var
    string
    Returns
    Type
    Description
    $this

    getFramework

    Required. A reference to the framework that you're deploying.

    Returns
    Type
    Description
    FrameworkReference |null

    hasFramework

    clearFramework

    setFramework

    Required. A reference to the framework that you're deploying.

    Parameter
    Name
    Description
    var
    FrameworkReference
    Returns
    Type
    Description
    $this

    getDescription

    Optional. A user-provided description of the framework deployment.

    Returns
    Type
    Description
    string

    setDescription

    Optional. A user-provided description of the framework deployment.

    Parameter
    Name
    Description
    var
    string
    Returns
    Type
    Description
    $this

    getCloudControlMetadata

    Required. The deployment mode and parameters for each of the cloud controls in the framework. Every cloud control in the framework includes metadata.

    Returns
    Type
    Description
    Google\Protobuf\Internal\RepeatedField

    setCloudControlMetadata

    Required. The deployment mode and parameters for each of the cloud controls in the framework. Every cloud control in the framework includes metadata.

    Parameter
    Name
    Description
    var
    array< CloudControlMetadata >
    Returns
    Type
    Description
    $this

    getDeploymentState

    Output only. The state for the framework deployment.

    Returns
    Type
    Description
    int
    Enum of type DeploymentState .

    setDeploymentState

    Output only. The state for 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 framework deployment. You can also provide the etag when you delete a framework deployment, to help ensure that you're deleting the intended version of the framework deployment.

    Returns
    Type
    Description
    string

    setEtag

    Optional. To prevent concurrent updates from overwriting each other, always provide the etag when you update a framework deployment. You can also provide the etag when you delete a framework deployment, to help ensure that you're deleting the intended version of the framework deployment.

    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. The reference includes all the cloud control deployments that are in the framework or in a cloud control group.

    For example, if a framework deployment deploys two cloud controls, cc-deployment-1 and cc-deployment-2 , then the references are:

     {
 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. The reference includes all the cloud control deployments that are in the framework or in a cloud control group.

    For example, if a framework deployment deploys two cloud controls, cc-deployment-1 and cc-deployment-2 , then the references are:

     {
 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
    Design a Mobile Site
    View Site in Mobile | Classic
    Share by: