Struct UserCreds 

#[non_exhaustive]
pub struct UserCreds {
    pub name: String,
    pub create_time: Option<Timestamp>,
    pub update_time: Option<Timestamp>,
    pub state: State,
    pub secure_password: String,
    pub user_creds_identity: Option<UserCredsIdentity>,
    /* private fields */
}

A Cloud Firestore User Creds.

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.

name: String

Identifier. The resource name of the UserCreds. Format: projects/{project}/databases/{database}/userCreds/{user_creds}

create_time: Option<Timestamp>

Output only. The time the user creds were created.

update_time: Option<Timestamp>

Output only. The time the user creds were last updated.

state: State

Output only. Whether the user creds are enabled or disabled. Defaults to ENABLED on creation.

secure_password: String

Output only. The plaintext server-generated password for the user creds. Only populated in responses for CreateUserCreds and ResetUserPassword.

user_creds_identity: Option<UserCredsIdentity>

Identity associated with this User Creds.

Implementations

impl UserCreds

pub fn new() -> Self

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

Sets the value of name.

Example

let x = UserCreds::new().set_name("example");

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 = UserCreds::new().set_create_time(Timestamp::default()/* use setters */);

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 = UserCreds::new().set_or_clear_create_time(Some(Timestamp::default()/* use setters */));
let x = UserCreds::new().set_or_clear_create_time(None::<Timestamp>);

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 = UserCreds::new().set_update_time(Timestamp::default()/* use setters */);

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 = UserCreds::new().set_or_clear_update_time(Some(Timestamp::default()/* use setters */));
let x = UserCreds::new().set_or_clear_update_time(None::<Timestamp>);

pub fn set_state<T: Into<State>>(self, v: T) -> Self

Sets the value of state.

Example

use google_cloud_firestore_admin_v1::model::user_creds::State;
let x0 = UserCreds::new().set_state(State::Enabled);
let x1 = UserCreds::new().set_state(State::Disabled);

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

Sets the value of secure_password.

Example

let x = UserCreds::new().set_secure_password("example");

pub fn set_user_creds_identity<T: Into<Option<UserCredsIdentity>>>( self, v: T, ) -> Self

Sets the value of user_creds_identity.

Note that all the setters affecting user_creds_identity are mutually exclusive.

Example

use google_cloud_firestore_admin_v1::model::user_creds::ResourceIdentity;
let x = UserCreds::new().set_user_creds_identity(Some(
    google_cloud_firestore_admin_v1::model::user_creds::UserCredsIdentity::ResourceIdentity(ResourceIdentity::default().into())));

pub fn resource_identity(&self) -> Option<&Box<ResourceIdentity>>

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

pub fn set_resource_identity<T: Into<Box<ResourceIdentity>>>(self, v: T) -> Self

Sets the value of user_creds_identity to hold a ResourceIdentity.

Note that all the setters affecting user_creds_identity are mutually exclusive.

Example

use google_cloud_firestore_admin_v1::model::user_creds::ResourceIdentity;
let x = UserCreds::new().set_resource_identity(ResourceIdentity::default()/* use setters */);
assert!(x.resource_identity().is_some());

Trait Implementations

impl Clone for UserCreds

fn clone(&self) -> UserCreds

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for UserCreds

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

Formats the value using the given formatter.

impl Default for UserCreds

fn default() -> UserCreds

Returns the “default value” for a type.

impl Message for UserCreds

fn typename() -> &'static str

The typename of this message.

impl PartialEq for UserCreds

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