Struct google_api_proto::google::cloud::orgpolicy::v2::Constraint

pub struct Constraint {
    pub name: String,
    pub display_name: String,
    pub description: String,
    pub constraint_default: i32,
    pub supports_dry_run: bool,
    pub constraint_type: Option<ConstraintType>,
}

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.

Fields

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: i32

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

supports_dry_run: bool

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

constraint_type: Option<ConstraintType>

The type of restrictions for this Constraint.

Immutable after creation.

Implementations

impl Constraint

pub fn constraint_default(&self) -> ConstraintDefault

Returns the enum value of constraint_default, or the default if the field is set to an invalid enum value.

pub fn set_constraint_default(&mut self, value: ConstraintDefault)

Sets constraint_default to the provided enum value.

Trait Implementations

impl Clone for Constraint

fn clone(&self) -> Constraint

Returns a copy of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Debug for Constraint

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl Default for Constraint

fn default() -> Self

Returns the “default value” for a type.

impl Message for Constraint

fn encoded_len(&self) -> usize

Returns the encoded length of the message without a length delimiter.

fn clear(&mut self)

Clears the message, resetting all fields to their default.

fn encode(&self, buf: &mut impl BufMut) -> Result<(), EncodeError>

where Self: Sized,

Encodes the message to a buffer.

fn encode_to_vec(&self) -> Vec<u8>

where Self: Sized,

Encodes the message to a newly allocated buffer.

fn encode_length_delimited( &self, buf: &mut impl BufMut, ) -> Result<(), EncodeError>

where Self: Sized,

Encodes the message with a length-delimiter to a buffer.

fn encode_length_delimited_to_vec(&self) -> Vec<u8>

where Self: Sized,

Encodes the message with a length-delimiter to a newly allocated buffer.

fn decode(buf: impl Buf) -> Result<Self, DecodeError>

where Self: Default,

Decodes an instance of the message from a buffer.

fn decode_length_delimited(buf: impl Buf) -> Result<Self, DecodeError>

where Self: Default,

Decodes a length-delimited instance of the message from the buffer.

fn merge(&mut self, buf: impl Buf) -> Result<(), DecodeError>

where Self: Sized,

Decodes an instance of the message from a buffer, and merges it into self.

fn merge_length_delimited(&mut self, buf: impl Buf) -> Result<(), DecodeError>

where Self: Sized,

Decodes a length-delimited instance of the message from buffer, and merges it into self.

impl PartialEq for Constraint

fn eq(&self, other: &Constraint) -> bool

This method tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &Rhs) -> bool

This method tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl StructuralPartialEq for Constraint