Organization Policy v2 API - Class Constraint (2.5.0) 

public sealed class Constraint : IMessage<Constraint>, IEquatable<Constraint>, IDeepCloneable<Constraint>, IBufferMessage, IMessage

Reference documentation and code samples for the Organization Policy v2 API class Constraint.

A constraint describes a way to restrict resource's configuration. For example, you could enforce a constraint that controls which Google 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 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][google.cloud.OrgPolicy.v2.Policy].

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.

Inheritance

object > Constraint

Namespace

Google.Cloud.OrgPolicy.V2

Assembly

Google.Cloud.OrgPolicy.V2.dll

Constructors

Constraint()

public Constraint()

Constraint(Constraint)

public Constraint(Constraint other)
Parameter
Name Description
other Constraint

Properties

BooleanConstraint

public Constraint.Types.BooleanConstraint BooleanConstraint { get; set; }

Defines this constraint as being a BooleanConstraint.

Property Value
Type Description
ConstraintTypesBooleanConstraint

ConstraintDefault

public Constraint.Types.ConstraintDefault ConstraintDefault { get; set; }

The evaluation behavior of this constraint in the absence of a policy.

Property Value
Type Description
ConstraintTypesConstraintDefault

ConstraintName

public ConstraintName ConstraintName { get; set; }

ConstraintName-typed view over the Name resource name property.

Property Value
Type Description
ConstraintName

ConstraintTypeCase

public Constraint.ConstraintTypeOneofCase ConstraintTypeCase { get; }
Property Value
Type Description
ConstraintConstraintTypeOneofCase

Description

public string Description { get; set; }

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

Mutable.

Property Value
Type Description
string

DisplayName

public string DisplayName { get; set; }

The human readable name.

Mutable.

Property Value
Type Description
string

ListConstraint

public Constraint.Types.ListConstraint ListConstraint { get; set; }

Defines this constraint as being a ListConstraint.

Property Value
Type Description
ConstraintTypesListConstraint

Name

public string Name { get; set; }

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".

Property Value
Type Description
string

SupportsDryRun

public bool SupportsDryRun { get; set; }

Shows if dry run is supported for this constraint or not.

Property Value
Type Description
bool