Reference documentation and code samples for the Google Cloud Org Policy V2 Client class CustomConstraint.
A custom constraint defined by customers which can only be applied to the given resource types and organization.
By creating a custom constraint, customers can apply policies of this custom constraint. Creating a custom constraint itself does NOT apply any policy enforcement .
Generated from protobuf message google.cloud.orgpolicy.v2.CustomConstraint
Namespace
Google \ Cloud \ OrgPolicy \ V2Methods
__construct
Constructor.
data
array
Optional. Data for populating the Message object.
↳ name
string
Immutable. Name of the constraint. This is unique within the organization. Format of the name should be * * organizations/{organization_id}/customConstraints/{custom_constraint_id}
Example: organizations/123/customConstraints/custom.createOnlyE2TypeVms
The max length is 70 characters and the minimum length is 1. Note that the prefix organizations/{organization_id}/customConstraints/
is not counted.
↳ resource_types
array
Immutable. The resource instance type on which this policy applies. Format will be of the form : <service name>/<type>
Example: * * compute.googleapis.com/Instance
.
↳ method_types
array
All the operations being applied for this constraint.
↳ condition
string
A Common Expression Language (CEL) condition which is used in the evaluation of the constraint. For example: resource.instanceName.matches("[production|test]_.*_(\d)+")
or, resource.management.auto_upgrade == true
The max length of the condition is 1000 characters.
↳ action_type
int
Allow or deny type.
↳ display_name
string
One line display name for the UI. The max length of the display_name is 200 characters.
↳ description
string
Detailed information about this custom policy constraint. The max length of the description is 2000 characters.
↳ update_time
Google\Protobuf\Timestamp
Output only. The last time this custom constraint was updated. This represents the last time that the CreateCustomConstraint
or UpdateCustomConstraint
methods were called.
getName
Immutable. Name of the constraint. This is unique within the organization.
Format of the name should be
-
organizations/{organization_id}/customConstraints/{custom_constraint_id}Example:organizations/123/customConstraints/custom.createOnlyE2TypeVmsThe max length is 70 characters and the minimum length is 1. Note that the prefixorganizations/{organization_id}/customConstraints/is not counted.
string
setName
Immutable. Name of the constraint. This is unique within the organization.
Format of the name should be
-
organizations/{organization_id}/customConstraints/{custom_constraint_id}Example:organizations/123/customConstraints/custom.createOnlyE2TypeVmsThe max length is 70 characters and the minimum length is 1. Note that the prefixorganizations/{organization_id}/customConstraints/is not counted.
var
string
$this
getResourceTypes
Immutable. The resource instance type on which this policy applies. Format
will be of the form : <service name>/<type>
Example:
-
compute.googleapis.com/Instance.
setResourceTypes
Immutable. The resource instance type on which this policy applies. Format
will be of the form : <service name>/<type>
Example:
-
compute.googleapis.com/Instance.
var
string[]
$this
getMethodTypes
All the operations being applied for this constraint.
setMethodTypes
All the operations being applied for this constraint.
var
int[]
$this
getCondition
A Common Expression Language (CEL) condition which is used in the
evaluation of the constraint. For example: resource.instanceName.matches("[production|test]_.*_(\d)+")
or, resource.management.auto_upgrade == true
The max length of the condition is 1000 characters.
string
setCondition
A Common Expression Language (CEL) condition which is used in the
evaluation of the constraint. For example: resource.instanceName.matches("[production|test]_.*_(\d)+")
or, resource.management.auto_upgrade == true
The max length of the condition is 1000 characters.
var
string
$this
getActionType
Allow or deny type.
int
setActionType
Allow or deny type.
var
int
$this
getDisplayName
One line display name for the UI.
The max length of the display_name is 200 characters.
string
setDisplayName
One line display name for the UI.
The max length of the display_name is 200 characters.
var
string
$this
getDescription
Detailed information about this custom policy constraint.
The max length of the description is 2000 characters.
string
setDescription
Detailed information about this custom policy constraint.
The max length of the description is 2000 characters.
var
string
$this
getUpdateTime
Output only. The last time this custom constraint was updated. This
represents the last time that the CreateCustomConstraint
or UpdateCustomConstraint
methods were called.
hasUpdateTime
clearUpdateTime
setUpdateTime
Output only. The last time this custom constraint was updated. This
represents the last time that the CreateCustomConstraint
or UpdateCustomConstraint
methods were called.
$this
