Organization Policy V2 API - Class Google::Cloud::OrgPolicy::V2::Constraint (v1.1.0)

Reference documentation and code samples for the Organization Policy V2 API class Google::Cloud::OrgPolicy::V2::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.

Inherits

Object

Extended By

Google::Protobuf::MessageExts::ClassMethods

Includes

Google::Protobuf::MessageExts

Methods

#boolean_constraint

def boolean_constraint() -> ::Google::Cloud::OrgPolicy::V2::Constraint::BooleanConstraint

Returns

(::Google::Cloud::OrgPolicy::V2::Constraint::BooleanConstraint) — Defines this constraint as being a BooleanConstraint.

#boolean_constraint=

def boolean_constraint=(value) -> ::Google::Cloud::OrgPolicy::V2::Constraint::BooleanConstraint

Parameter

value (::Google::Cloud::OrgPolicy::V2::Constraint::BooleanConstraint) — Defines this constraint as being a BooleanConstraint.

Returns

(::Google::Cloud::OrgPolicy::V2::Constraint::BooleanConstraint) — Defines this constraint as being a BooleanConstraint.

#constraint_default

def constraint_default() -> ::Google::Cloud::OrgPolicy::V2::Constraint::ConstraintDefault

Returns

(::Google::Cloud::OrgPolicy::V2::Constraint::ConstraintDefault) — The evaluation behavior of this constraint in the absence of a policy.

#constraint_default=

def constraint_default=(value) -> ::Google::Cloud::OrgPolicy::V2::Constraint::ConstraintDefault

Parameter

value (::Google::Cloud::OrgPolicy::V2::Constraint::ConstraintDefault) — The evaluation behavior of this constraint in the absence of a policy.

Returns

(::Google::Cloud::OrgPolicy::V2::Constraint::ConstraintDefault) — The evaluation behavior of this constraint in the absence of a policy.

#description

def description() -> ::String

Returns

(::String) — Detailed description of what this constraint controls as well as how and where it is enforced.

Mutable.

#description=

def description=(value) -> ::String

Parameter

value (::String) — Detailed description of what this constraint controls as well as how and where it is enforced.

Mutable.

Returns

(::String) — Detailed description of what this constraint controls as well as how and where it is enforced.

Mutable.

#display_name

def display_name() -> ::String

Returns

(::String) — The human readable name.

Mutable.

#display_name=

def display_name=(value) -> ::String

Parameter

value (::String) — The human readable name.

Mutable.

Returns

(::String) — The human readable name.

Mutable.

#list_constraint

def list_constraint() -> ::Google::Cloud::OrgPolicy::V2::Constraint::ListConstraint

Returns

(::Google::Cloud::OrgPolicy::V2::Constraint::ListConstraint) — Defines this constraint as being a ListConstraint.

#list_constraint=

def list_constraint=(value) -> ::Google::Cloud::OrgPolicy::V2::Constraint::ListConstraint

Parameter

value (::Google::Cloud::OrgPolicy::V2::Constraint::ListConstraint) — Defines this constraint as being a ListConstraint.

Returns

(::Google::Cloud::OrgPolicy::V2::Constraint::ListConstraint) — Defines this constraint as being a ListConstraint.

#name

def name() -> ::String

Returns

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

#name=

def name=(value) -> ::String

Parameter

value (::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".

Returns

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

#supports_dry_run

def supports_dry_run() -> ::Boolean

Returns

(::Boolean) — Shows if dry run is supported for this constraint or not.

#supports_dry_run=

def supports_dry_run=(value) -> ::Boolean

Parameter

value (::Boolean) — Shows if dry run is supported for this constraint or not.

Returns

(::Boolean) — Shows if dry run is supported for this constraint or not.