Google Cloud Design Center V1 Client - Class Policy (0.1.0)

Reference documentation and code samples for the Google Cloud Design Center V1 Client class Policy.

A Policy is a resource within an Application Template that refers to a Policy that you author outside of Application Design Center and attach to an application template.

Generated from protobuf message google.cloud.designcenter.v1.Policy

Namespace

Google \ Cloud \ DesignCenter \ V1

Methods

__construct

Constructor.

Parameters
Name	Description
data	array Optional. Data for populating the Message object.
↳ policy_uri	string Optional. URI of the policy.
↳ policy_revision_uri	string Optional. URI of the policy revision.
↳ name	string Identifier. The policy name in the following format: projects/$project/locations/$location/spaces/$space/applicationTemplates/$applicationTemplate/policies/$policy
↳ display_name	string Optional. The policy display name.
↳ description	string Optional. The policy description.
↳ policy_type	int Required. The policy type. Policy type is used to determine the domain of the policy.
↳ apply_conditions	array<ApplyCondition> Optional. Conditions for applying the policy. Condition accepts the criticality and environment parameters from the application template.
↳ create_time	Google\Protobuf\Timestamp Output only. The policy creation timestamp.
↳ update_time	Google\Protobuf\Timestamp Output only. The policy update timestamp.
↳ cloud_control_configs	array<CloudControlConfig> Optional. Input only. Parameter values for the cloud controls of the policy's framework, grouped by cloud control. Only honored when framework parameter support is enabled for the project; ignored otherwise. The values are saved with the application template and are not returned on the policy. On update, they replace the saved values. If they are empty, the saved values are cleared if cloud_control_configs is named in the update mask. Otherwise, the saved values are kept, unless the policy's framework changes.

getPolicyUri

Optional. URI of the policy.

Returns
Type	Description
string

hasPolicyUri

setPolicyUri

Optional. URI of the policy.

Parameter
Name	Description
var	string

Returns
Type	Description
$this

getPolicyRevisionUri

Optional. URI of the policy revision.

Returns
Type	Description
string

hasPolicyRevisionUri

setPolicyRevisionUri

Optional. URI of the policy revision.

Parameter
Name	Description
var	string

Returns
Type	Description
$this

getName

Identifier. The policy name in the following format: projects/$project/locations/$location/spaces/$space/applicationTemplates/$applicationTemplate/policies/$policy

Returns
Type	Description
string

setName

Identifier. The policy name in the following format: projects/$project/locations/$location/spaces/$space/applicationTemplates/$applicationTemplate/policies/$policy

Parameter
Name	Description
var	string

Returns
Type	Description
$this

getDisplayName

Optional. The policy display name.

Returns
Type	Description
string

setDisplayName

Optional. The policy display name.

Parameter
Name	Description
var	string

Returns
Type	Description
$this

getDescription

Optional. The policy description.

Returns
Type	Description
string

setDescription

Optional. The policy description.

Parameter
Name	Description
var	string

Returns
Type	Description
$this

getPolicyType

Required. The policy type.

Policy type is used to determine the domain of the policy.

Returns
Type	Description
int	Enum of type PolicyType.

setPolicyType

Required. The policy type.

Policy type is used to determine the domain of the policy.

Parameter
Name	Description
var	int Enum of type PolicyType.

Returns
Type	Description
$this

getApplyConditions

Optional. Conditions for applying the policy. Condition accepts the criticality and environment parameters from the application template.

Returns
Type	Description
Google\Protobuf\RepeatedField<ApplyCondition>

setApplyConditions

Optional. Conditions for applying the policy. Condition accepts the criticality and environment parameters from the application template.

Parameter
Name	Description
var	array<ApplyCondition>

Returns
Type	Description
$this

getCreateTime

Output only. The policy creation timestamp.

Returns
Type	Description
Google\Protobuf\Timestamp|null

hasCreateTime

clearCreateTime

setCreateTime

Output only. The policy creation timestamp.

Parameter
Name	Description
var	Google\Protobuf\Timestamp

Returns
Type	Description
$this

getUpdateTime

Output only. The policy update timestamp.

Returns
Type	Description
Google\Protobuf\Timestamp|null

hasUpdateTime

clearUpdateTime

setUpdateTime

Output only. The policy update timestamp.

Parameter
Name	Description
var	Google\Protobuf\Timestamp

Returns
Type	Description
$this

getCloudControlConfigs

Optional. Input only. Parameter values for the cloud controls of the policy's framework, grouped by cloud control. Only honored when framework parameter support is enabled for the project; ignored otherwise.

The values are saved with the application template and are not returned on the policy. On update, they replace the saved values. If they are empty, the saved values are cleared if cloud_control_configs is named in the update mask. Otherwise, the saved values are kept, unless the policy's framework changes.

Returns
Type	Description
Google\Protobuf\RepeatedField<CloudControlConfig>

setCloudControlConfigs

Optional. Input only. Parameter values for the cloud controls of the policy's framework, grouped by cloud control. Only honored when framework parameter support is enabled for the project; ignored otherwise.

The values are saved with the application template and are not returned on the policy. On update, they replace the saved values. If they are empty, the saved values are cleared if cloud_control_configs is named in the update mask. Otherwise, the saved values are kept, unless the policy's framework changes.

Parameter
Name	Description
var	array<CloudControlConfig>

Returns
Type	Description
$this

getUri

Returns
Type	Description
string