Struct AccessRestriction 

#[non_exhaustive]
pub struct AccessRestriction {
    pub principals: Vec<Principal>,
    pub idp_wide: bool,
    /* private fields */
}

Available on crate features conversational-search-service or document-service or recommendation-service or search-service only.

AclRestriction to model complex inheritance restrictions.

Example: Modeling a “Both Permit” inheritance, where to access a child document, user needs to have access to parent document.

Document Hierarchy - Space_S –> Page_P.

Readers: Space_S: group_1, user_1 Page_P: group_2, group_3, user_2

Space_S ACL Restriction - { “acl_info”: { “readers”: [ { “principals”: [ { “group_id”: “group_1” }, { “user_id”: “user_1” } ] } ] } }

Page_P ACL Restriction. { “acl_info”: { “readers”: [ { “principals”: [ { “group_id”: “group_2” }, { “group_id”: “group_3” }, { “user_id”: “user_2” } ], }, { “principals”: [ { “group_id”: “group_1” }, { “user_id”: “user_1” } ], } ] } }

Fields (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.

principals: Vec<Principal>

List of principals.

idp_wide: bool

All users within the Identity Provider.

Implementations

impl AccessRestriction

pub fn new() -> Self

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

where T: IntoIterator<Item = V>, V: Into<Principal>,

Sets the value of principals.

Example

use google_cloud_discoveryengine_v1::model::Principal;
let x = AccessRestriction::new()
    .set_principals([
        Principal::default()/* use setters */,
        Principal::default()/* use (different) setters */,
    ]);

pub fn set_idp_wide<T: Into<bool>>(self, v: T) -> Self

Sets the value of idp_wide.

Example

let x = AccessRestriction::new().set_idp_wide(true);

Trait Implementations

impl Clone for AccessRestriction

fn clone(&self) -> AccessRestriction

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for AccessRestriction

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

Formats the value using the given formatter.

impl Default for AccessRestriction

fn default() -> AccessRestriction

Returns the “default value” for a type.

impl Message for AccessRestriction

fn typename() -> &'static str

The typename of this message.

impl PartialEq for AccessRestriction

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

Tests for self and other values to be equal, and is used by ==.

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

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

impl StructuralPartialEq for AccessRestriction