Struct PurgeIdentityMappingsRequest 

#[non_exhaustive]
pub struct PurgeIdentityMappingsRequest {
    pub identity_mapping_store: String,
    pub filter: String,
    pub force: Option<bool>,
    pub source: Option<Source>,
    /* private fields */
}

Available on crate feature identity-mapping-store-service only.

Request message for IdentityMappingStoreService.PurgeIdentityMappings

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.

identity_mapping_store: String

Required. The name of the Identity Mapping Store to purge Identity Mapping Entries from. Format: projects/{project}/locations/{location}/identityMappingStores/{identityMappingStore}

filter: String

Filter matching identity mappings to purge. The eligible field for filtering is:

• update_time: in ISO 8601 “zulu” format.
• external_id

Examples:

• Deleting all identity mappings updated in a time range: update_time > "2012-04-23T18:25:43.511Z" AND update_time < "2012-04-23T18:30:43.511Z"
• Deleting all identity mappings for a given external_id: external_id = "id1"
• Deleting all identity mappings inside an identity mapping store: *

The filtering fields are assumed to have an implicit AND. Should not be used with source. An error will be thrown, if both are provided.

force: Option<bool>

Actually performs the purge. If force is set to false, return the expected purge count without deleting any identity mappings. This field is only supported for purge with filter. For input source this field is ignored and data will be purged regardless of the value of this field.

source: Option<Source>

The source of the input.

Implementations

impl PurgeIdentityMappingsRequest

pub fn new() -> Self

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

Sets the value of identity_mapping_store.

Example

let x = PurgeIdentityMappingsRequest::new().set_identity_mapping_store("example");

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

Sets the value of filter.

Example

let x = PurgeIdentityMappingsRequest::new().set_filter("example");

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

where T: Into<bool>,

Sets the value of force.

Example

let x = PurgeIdentityMappingsRequest::new().set_force(true);

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

where T: Into<bool>,

Sets or clears the value of force.

Example

let x = PurgeIdentityMappingsRequest::new().set_or_clear_force(Some(false));
let x = PurgeIdentityMappingsRequest::new().set_or_clear_force(None::<bool>);

pub fn set_source<T: Into<Option<Source>>>(self, v: T) -> Self

Sets the value of source.

Note that all the setters affecting source are mutually exclusive.

Example

use google_cloud_discoveryengine_v1::model::purge_identity_mappings_request::InlineSource;
let x = PurgeIdentityMappingsRequest::new().set_source(Some(
    google_cloud_discoveryengine_v1::model::purge_identity_mappings_request::Source::InlineSource(InlineSource::default().into())));

pub fn inline_source(&self) -> Option<&Box<InlineSource>>

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

pub fn set_inline_source<T: Into<Box<InlineSource>>>(self, v: T) -> Self

Sets the value of source to hold a InlineSource.

Note that all the setters affecting source are mutually exclusive.

Example

use google_cloud_discoveryengine_v1::model::purge_identity_mappings_request::InlineSource;
let x = PurgeIdentityMappingsRequest::new().set_inline_source(InlineSource::default()/* use setters */);
assert!(x.inline_source().is_some());

Trait Implementations

impl Clone for PurgeIdentityMappingsRequest

fn clone(&self) -> PurgeIdentityMappingsRequest

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for PurgeIdentityMappingsRequest

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

Formats the value using the given formatter.

impl Default for PurgeIdentityMappingsRequest

fn default() -> PurgeIdentityMappingsRequest

Returns the “default value” for a type.

impl Message for PurgeIdentityMappingsRequest

fn typename() -> &'static str

The typename of this message.

impl PartialEq for PurgeIdentityMappingsRequest

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