Skip to main content

Policy

Struct Policy 

Source
#[non_exhaustive]
pub struct Policy { pub name: String, pub spec: Option<PolicySpec>, pub alternate: Option<AlternatePolicySpec>, pub dry_run_spec: Option<PolicySpec>, pub etag: String, /* private fields */ }
Expand description

Defines an organization policy which is used to specify constraints for configurations of Google Cloud resources.

Fields (Non-exhaustive)§

This struct is marked as non-exhaustive
Non-exhaustive structs could have additional fields added in future. Therefore, non-exhaustive structs cannot be constructed in external crates using the traditional Struct { .. } syntax; cannot be matched against without a wildcard ..; and struct update syntax will not work.
§name: String

Immutable. The resource name of the policy. Must be one of the following forms, where constraint_name is the name of the constraint which this policy configures:

  • projects/{project_number}/policies/{constraint_name}
  • folders/{folder_id}/policies/{constraint_name}
  • organizations/{organization_id}/policies/{constraint_name}

For example, projects/123/policies/compute.disableSerialPortAccess.

Note: projects/{project_id}/policies/{constraint_name} is also an acceptable name for API requests, but responses will return the name using the equivalent project number.

§spec: Option<PolicySpec>

Basic information about the organization policy.

§alternate: Option<AlternatePolicySpec>
👎Deprecated

Deprecated.

§dry_run_spec: Option<PolicySpec>

Dry-run policy. Audit-only policy, can be used to monitor how the policy would have impacted the existing and future resources if it’s enforced.

§etag: String

Optional. An opaque tag indicating the current state of the policy, used for concurrency control. This ‘etag’ is computed by the server based on the value of other fields, and may be sent on update and delete requests to ensure the client has an up-to-date value before proceeding.

Implementations§

Source§

impl Policy

Source

pub fn new() -> Self

Creates a new default instance.

Source

pub fn set_name<T: Into<String>>(self, v: T) -> Self

Sets the value of name.

§Example
let x = Policy::new().set_name(format!("projects/{project_id}/policies/{policy_id}"));
Source

pub fn set_spec<T>(self, v: T) -> Self
where T: Into<PolicySpec>,

Sets the value of spec.

§Example
use google_cloud_orgpolicy_v2::model::PolicySpec;
let x = Policy::new().set_spec(PolicySpec::default()/* use setters */);
Source

pub fn set_or_clear_spec<T>(self, v: Option<T>) -> Self
where T: Into<PolicySpec>,

Sets or clears the value of spec.

§Example
use google_cloud_orgpolicy_v2::model::PolicySpec;
let x = Policy::new().set_or_clear_spec(Some(PolicySpec::default()/* use setters */));
let x = Policy::new().set_or_clear_spec(None::<PolicySpec>);
Source

pub fn set_alternate<T>(self, v: T) -> Self

👎Deprecated

Sets the value of alternate.

§Example
use google_cloud_orgpolicy_v2::model::AlternatePolicySpec;
let x = Policy::new().set_alternate(AlternatePolicySpec::default()/* use setters */);
Source

pub fn set_or_clear_alternate<T>(self, v: Option<T>) -> Self

👎Deprecated

Sets or clears the value of alternate.

§Example
use google_cloud_orgpolicy_v2::model::AlternatePolicySpec;
let x = Policy::new().set_or_clear_alternate(Some(AlternatePolicySpec::default()/* use setters */));
let x = Policy::new().set_or_clear_alternate(None::<AlternatePolicySpec>);
Source

pub fn set_dry_run_spec<T>(self, v: T) -> Self
where T: Into<PolicySpec>,

Sets the value of dry_run_spec.

§Example
use google_cloud_orgpolicy_v2::model::PolicySpec;
let x = Policy::new().set_dry_run_spec(PolicySpec::default()/* use setters */);
Source

pub fn set_or_clear_dry_run_spec<T>(self, v: Option<T>) -> Self
where T: Into<PolicySpec>,

Sets or clears the value of dry_run_spec.

§Example
use google_cloud_orgpolicy_v2::model::PolicySpec;
let x = Policy::new().set_or_clear_dry_run_spec(Some(PolicySpec::default()/* use setters */));
let x = Policy::new().set_or_clear_dry_run_spec(None::<PolicySpec>);
Source

pub fn set_etag<T: Into<String>>(self, v: T) -> Self

Sets the value of etag.

§Example
let x = Policy::new().set_etag("example");

Trait Implementations§

Source§

impl Clone for Policy

Source§

fn clone(&self) -> Policy

Returns a duplicate of the value. Read more
1.0.0 (const: unstable) · Source§

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

Performs copy-assignment from source. Read more
Source§

impl Debug for Policy

Source§

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

Formats the value using the given formatter. Read more
Source§

impl Default for Policy

Source§

fn default() -> Policy

Returns the “default value” for a type. Read more
Source§

impl Message for Policy

Source§

fn typename() -> &'static str

The typename of this message.
Source§

impl PartialEq for Policy

Source§

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

Tests for self and other values to be equal, and is used by ==.
1.0.0 (const: unstable) · Source§

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

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.
Source§

impl StructuralPartialEq for Policy

Auto Trait Implementations§

Blanket Implementations§

Source§

impl<T> Any for T
where T: 'static + ?Sized,

Source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
Source§

impl<T> Borrow<T> for T
where T: ?Sized,

Source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
Source§

impl<T> BorrowMut<T> for T
where T: ?Sized,

Source§

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more
Source§

impl<ST, DT> CastableFrom<ST, Initialized, Initialized> for DT
where ST: ?Sized, DT: ?Sized,

Source§

impl<ST, DT> CastableFrom<ST, Uninit, Uninit> for DT
where ST: ?Sized, DT: ?Sized,

Source§

impl<T> CloneToUninit for T
where T: Clone,

Source§

unsafe fn clone_to_uninit(&self, dest: *mut u8)

🔬This is a nightly-only experimental API. (clone_to_uninit)
Performs copy-assignment from self to dest. Read more
Source§

impl<T> DeserializeOwned for T
where T: for<'de> Deserialize<'de>,

Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

Source§

impl<T> FutureExt for T

Source§

fn with_context(self, otel_cx: Context) -> WithContext<Self>

Attaches the provided Context to this type, returning a WithContext wrapper. Read more
Source§

fn with_current_context(self) -> WithContext<Self>

Attaches the current Context to this type, returning a WithContext wrapper. Read more
Source§

impl<T> Instrument for T

Source§

fn instrument(self, span: Span) -> Instrumented<Self>

Instruments this type with the provided Span, returning an Instrumented wrapper. Read more
Source§

fn in_current_span(self) -> Instrumented<Self>

Instruments this type with the current Span, returning an Instrumented wrapper. Read more
Source§

impl<T, U> Into<U> for T
where U: From<T>,

Source§

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

Source§

impl<T> PolicyExt for T
where T: ?Sized,

Source§

fn and<P, B, E>(self, other: P) -> And<T, P>
where T: Policy<B, E>, P: Policy<B, E>,

Create a new Policy that returns Action::Follow only if self and other return Action::Follow. Read more
Source§

fn or<P, B, E>(self, other: P) -> Or<T, P>
where T: Policy<B, E>, P: Policy<B, E>,

Create a new Policy that returns Action::Follow if either self or other returns Action::Follow. Read more
Source§

impl<T> Read<Exclusive, BecauseExclusive> for T
where T: ?Sized,

Source§

impl<T> Same for T

Source§

type Output = T

Should always be Self
Source§

impl<T> ToOwned for T
where T: Clone,

Source§

type Owned = T

The resulting type after obtaining ownership.
Source§

fn to_owned(&self) -> T

Creates owned data from borrowed data, usually by cloning. Read more
Source§

fn clone_into(&self, target: &mut T)

Uses borrowed data to replace owned data, usually by cloning. Read more
Source§

impl<T, U> TryFrom<U> for T
where U: Into<T>,

Source§

type Error = Infallible

The type returned in the event of a conversion error.
Source§

fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

Performs the conversion.
Source§

impl<T, U> TryInto<U> for T
where U: TryFrom<T>,

Source§

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.
Source§

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.
Source§

impl<V, T> VZip<V> for T
where V: MultiLane<T>,

Source§

fn vzip(self) -> V

Source§

impl<T> WithSubscriber for T

Source§

fn with_subscriber<S>(self, subscriber: S) -> WithDispatch<Self>
where S: Into<Dispatch>,

Attaches the provided Subscriber to this type, returning a WithDispatch wrapper. Read more
Source§

fn with_current_subscriber(self) -> WithDispatch<Self>

Attaches the current default Subscriber to this type, returning a WithDispatch wrapper. Read more