Struct Principal 

#[non_exhaustive]
pub struct Principal {
    pub principal: Option<Principal>,
    /* private fields */
}

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

Principal identifier of a user or a group.

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.

principal: Option<Principal>

Union field principal. Principal can be a user or a group.

Implementations

impl Principal

pub fn new() -> Self

pub fn set_principal<T: Into<Option<Principal>>>(self, v: T) -> Self

Sets the value of principal.

Note that all the setters affecting principal are mutually exclusive.

Example

use google_cloud_discoveryengine_v1::model::principal::Principal as PrincipalOneOf;
let x = Principal::new().set_principal(Some(PrincipalOneOf::UserId("example".to_string())));

pub fn user_id(&self) -> Option<&String>

The value of principal if it holds a UserId, None if the field is not set or holds a different branch.

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

Sets the value of principal to hold a UserId.

Note that all the setters affecting principal are mutually exclusive.

Example

let x = Principal::new().set_user_id("example");
assert!(x.user_id().is_some());
assert!(x.group_id().is_none());
assert!(x.external_entity_id().is_none());

pub fn group_id(&self) -> Option<&String>

The value of principal if it holds a GroupId, None if the field is not set or holds a different branch.

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

Sets the value of principal to hold a GroupId.

Note that all the setters affecting principal are mutually exclusive.

Example

let x = Principal::new().set_group_id("example");
assert!(x.group_id().is_some());
assert!(x.user_id().is_none());
assert!(x.external_entity_id().is_none());

pub fn external_entity_id(&self) -> Option<&String>

The value of principal if it holds a ExternalEntityId, None if the field is not set or holds a different branch.

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

Sets the value of principal to hold a ExternalEntityId.

Note that all the setters affecting principal are mutually exclusive.

Example

let x = Principal::new().set_external_entity_id("example");
assert!(x.external_entity_id().is_some());
assert!(x.user_id().is_none());
assert!(x.group_id().is_none());

Trait Implementations

impl Clone for Principal

fn clone(&self) -> Principal

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for Principal

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

Formats the value using the given formatter.

impl Default for Principal

fn default() -> Principal

Returns the “default value” for a type.

impl Message for Principal

fn typename() -> &'static str

The typename of this message.

impl PartialEq for Principal

fn eq(&self, other: &Principal) -> 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 Principal