Google Cloud Org Policy V2 Client - Class Constraint (0.5.3)

Reference documentation and code samples for the Google Cloud Org Policy V2 Client class Constraint.

A constraint describes a way to restrict resource's configuration. For example, you could enforce a constraint that controls which cloud services can be activated across an organization, or whether a Compute Engine instance can have serial port connections established. Constraints can be configured by the organization's policy administrator to fit the needs of the organization by setting a policy that includes constraints at different locations in the organization's resource hierarchy. Policies are inherited down the resource hierarchy from higher levels, but can also be overridden.

For details about the inheritance rules please read about policies. Constraints have a default behavior determined by the constraint_default field, which is the enforcement behavior that is used in the absence of a policy being defined or inherited for the resource in question.

Generated from protobuf message google.cloud.orgpolicy.v2.Constraint

Namespace

Google \ Cloud \ OrgPolicy \ V2

Methods

__construct

Constructor.

Parameters
NameDescription
data array

Optional. Data for populating the Message object.

↳ name string

Immutable. The resource name of the Constraint. Must be in one of the following forms: * projects/{project_number}/constraints/{constraint_name} * folders/{folder_id}/constraints/{constraint_name} * organizations/{organization_id}/constraints/{constraint_name} For example, "/projects/123/constraints/compute.disableSerialPortAccess".

↳ display_name string

The human readable name. Mutable.

↳ description string

Detailed description of what this Constraint controls as well as how and where it is enforced. Mutable.

↳ constraint_default int

The evaluation behavior of this constraint in the absence of 'Policy'.

↳ list_constraint Google\Cloud\OrgPolicy\V2\Constraint\ListConstraint

Defines this constraint as being a ListConstraint.

↳ boolean_constraint Google\Cloud\OrgPolicy\V2\Constraint\BooleanConstraint

Defines this constraint as being a BooleanConstraint.

getName

Immutable. The resource name of the Constraint. Must be in one of the following forms:

  • projects/{project_number}/constraints/{constraint_name}
  • folders/{folder_id}/constraints/{constraint_name}
  • organizations/{organization_id}/constraints/{constraint_name} For example, "/projects/123/constraints/compute.disableSerialPortAccess".
Returns
TypeDescription
string

setName

Immutable. The resource name of the Constraint. Must be in one of the following forms:

  • projects/{project_number}/constraints/{constraint_name}
  • folders/{folder_id}/constraints/{constraint_name}
  • organizations/{organization_id}/constraints/{constraint_name} For example, "/projects/123/constraints/compute.disableSerialPortAccess".
Parameter
NameDescription
var string
Returns
TypeDescription
$this

getDisplayName

The human readable name.

Mutable.

Returns
TypeDescription
string

setDisplayName

The human readable name.

Mutable.

Parameter
NameDescription
var string
Returns
TypeDescription
$this

getDescription

Detailed description of what this Constraint controls as well as how and where it is enforced.

Mutable.

Returns
TypeDescription
string

setDescription

Detailed description of what this Constraint controls as well as how and where it is enforced.

Mutable.

Parameter
NameDescription
var string
Returns
TypeDescription
$this

getConstraintDefault

The evaluation behavior of this constraint in the absence of 'Policy'.

Returns
TypeDescription
int

setConstraintDefault

The evaluation behavior of this constraint in the absence of 'Policy'.

Parameter
NameDescription
var int
Returns
TypeDescription
$this

getListConstraint

Defines this constraint as being a ListConstraint.

Returns
TypeDescription
Google\Cloud\OrgPolicy\V2\Constraint\ListConstraint|null

hasListConstraint

setListConstraint

Defines this constraint as being a ListConstraint.

Parameter
NameDescription
var Google\Cloud\OrgPolicy\V2\Constraint\ListConstraint
Returns
TypeDescription
$this

getBooleanConstraint

Defines this constraint as being a BooleanConstraint.

Returns
TypeDescription
Google\Cloud\OrgPolicy\V2\Constraint\BooleanConstraint|null

hasBooleanConstraint

setBooleanConstraint

Defines this constraint as being a BooleanConstraint.

Parameter
NameDescription
var Google\Cloud\OrgPolicy\V2\Constraint\BooleanConstraint
Returns
TypeDescription
$this

getConstraintType

Returns
TypeDescription
string