Skip to main content

PolicyBinding

Struct PolicyBinding 

Source
#[non_exhaustive]
pub struct PolicyBinding { pub name: String, pub uid: String, pub etag: String, pub display_name: String, pub annotations: HashMap<String, String>, pub target: Option<Target>, pub policy_kind: PolicyKind, pub policy: String, pub policy_uid: String, pub condition: Option<Expr>, pub create_time: Option<Timestamp>, pub update_time: Option<Timestamp>, /* private fields */ }
Expand description

IAM policy binding resource.

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

Identifier. The name of the policy binding, in the format {binding_parent/locations/{location}/policyBindings/{policy_binding_id}. The binding parent is the closest Resource Manager resource (project, folder, or organization) to the binding target.

Format:

  • projects/{project_id}/locations/{location}/policyBindings/{policy_binding_id}
  • projects/{project_number}/locations/{location}/policyBindings/{policy_binding_id}
  • folders/{folder_id}/locations/{location}/policyBindings/{policy_binding_id}
  • organizations/{organization_id}/locations/{location}/policyBindings/{policy_binding_id}
§uid: String

Output only. The globally unique ID of the policy binding. Assigned when the policy binding is created.

§etag: String

Optional. The etag for the policy binding. If this is provided on update, it must match the server’s etag.

§display_name: String

Optional. The description of the policy binding. Must be less than or equal to 63 characters.

§annotations: HashMap<String, String>

Optional. User-defined annotations. See https://google.aip.dev/148#annotations for more details such as format and size limitations

§target: Option<Target>

Required. Immutable. Target is the full resource name of the resource to which the policy will be bound. Immutable once set.

§policy_kind: PolicyKind

Immutable. The kind of the policy to attach in this binding. This field must be one of the following:

  • Left empty (will be automatically set to the policy kind)
  • The input policy kind
§policy: String

Required. Immutable. The resource name of the policy to be bound. The binding parent and policy must belong to the same organization.

§policy_uid: String

Output only. The globally unique ID of the policy to be bound.

§condition: Option<Expr>

Optional. The condition to apply to the policy binding. When set, the expression field in the Expr must include from 1 to 10 subexpressions, joined by the “||”(Logical OR), “&&”(Logical AND) or “!”(Logical NOT) operators and cannot contain more than 250 characters.

The condition is currently only supported when bound to policies of kind principal access boundary.

When the bound policy is a principal access boundary policy, the only supported attributes in any subexpression are principal.type and principal.subject. An example expression is: “principal.type == ‘iam.googleapis.com/ServiceAccount’” or “principal.subject == ‘bob@example.com’”.

Allowed operations for principal.subject:

  • principal.subject == <principal subject string>
  • principal.subject != <principal subject string>
  • principal.subject in [<list of principal subjects>]
  • principal.subject.startsWith(<string>)
  • principal.subject.endsWith(<string>)

Allowed operations for principal.type:

  • principal.type == <principal type string>
  • principal.type != <principal type string>
  • principal.type in [<list of principal types>]

Supported principal types are Workspace, Workforce Pool, Workload Pool and Service Account. Allowed string must be one of:

  • iam.googleapis.com/WorkspaceIdentity
  • iam.googleapis.com/WorkforcePoolIdentity
  • iam.googleapis.com/WorkloadPoolIdentity
  • iam.googleapis.com/ServiceAccount
§create_time: Option<Timestamp>

Output only. The time when the policy binding was created.

§update_time: Option<Timestamp>

Output only. The time when the policy binding was most recently updated.

Implementations§

Source§

impl PolicyBinding

Source

pub fn new() -> Self

Source

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

Sets the value of name.

§Example
let x = PolicyBinding::new().set_name("example");
Source

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

Sets the value of uid.

§Example
let x = PolicyBinding::new().set_uid("example");
Source

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

Sets the value of etag.

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

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

Sets the value of display_name.

§Example
let x = PolicyBinding::new().set_display_name("example");
Source

pub fn set_annotations<T, K, V>(self, v: T) -> Self
where T: IntoIterator<Item = (K, V)>, K: Into<String>, V: Into<String>,

Sets the value of annotations.

§Example
let x = PolicyBinding::new().set_annotations([
    ("key0", "abc"),
    ("key1", "xyz"),
]);
Source

pub fn set_target<T>(self, v: T) -> Self
where T: Into<Target>,

Sets the value of target.

§Example
use google_cloud_iam_v3::model::policy_binding::Target;
let x = PolicyBinding::new().set_target(Target::default()/* use setters */);
Source

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

Sets or clears the value of target.

§Example
use google_cloud_iam_v3::model::policy_binding::Target;
let x = PolicyBinding::new().set_or_clear_target(Some(Target::default()/* use setters */));
let x = PolicyBinding::new().set_or_clear_target(None::<Target>);
Source

pub fn set_policy_kind<T: Into<PolicyKind>>(self, v: T) -> Self

Sets the value of policy_kind.

§Example
use google_cloud_iam_v3::model::policy_binding::PolicyKind;
let x0 = PolicyBinding::new().set_policy_kind(PolicyKind::PrincipalAccessBoundary);
Source

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

Sets the value of policy.

§Example
let x = PolicyBinding::new().set_policy("example");
Source

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

Sets the value of policy_uid.

§Example
let x = PolicyBinding::new().set_policy_uid("example");
Source

pub fn set_condition<T>(self, v: T) -> Self
where T: Into<Expr>,

Sets the value of condition.

§Example
use google_cloud_type::model::Expr;
let x = PolicyBinding::new().set_condition(Expr::default()/* use setters */);
Source

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

Sets or clears the value of condition.

§Example
use google_cloud_type::model::Expr;
let x = PolicyBinding::new().set_or_clear_condition(Some(Expr::default()/* use setters */));
let x = PolicyBinding::new().set_or_clear_condition(None::<Expr>);
Source

pub fn set_create_time<T>(self, v: T) -> Self
where T: Into<Timestamp>,

Sets the value of create_time.

§Example
use wkt::Timestamp;
let x = PolicyBinding::new().set_create_time(Timestamp::default()/* use setters */);
Source

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

Sets or clears the value of create_time.

§Example
use wkt::Timestamp;
let x = PolicyBinding::new().set_or_clear_create_time(Some(Timestamp::default()/* use setters */));
let x = PolicyBinding::new().set_or_clear_create_time(None::<Timestamp>);
Source

pub fn set_update_time<T>(self, v: T) -> Self
where T: Into<Timestamp>,

Sets the value of update_time.

§Example
use wkt::Timestamp;
let x = PolicyBinding::new().set_update_time(Timestamp::default()/* use setters */);
Source

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

Sets or clears the value of update_time.

§Example
use wkt::Timestamp;
let x = PolicyBinding::new().set_or_clear_update_time(Some(Timestamp::default()/* use setters */));
let x = PolicyBinding::new().set_or_clear_update_time(None::<Timestamp>);

Trait Implementations§

Source§

impl Clone for PolicyBinding

Source§

fn clone(&self) -> PolicyBinding

Returns a duplicate of the value. Read more
1.0.0 · Source§

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

Performs copy-assignment from source. Read more
Source§

impl Debug for PolicyBinding

Source§

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

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

impl Default for PolicyBinding

Source§

fn default() -> PolicyBinding

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

impl Message for PolicyBinding

Source§

fn typename() -> &'static str

The typename of this message.
Source§

impl PartialEq for PolicyBinding

Source§

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

Tests for self and other values to be equal, and is used by ==.
1.0.0 · 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 PolicyBinding

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<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> 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> 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
Source§

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