Send feedback
Class PurgeIdentityMappingsRequest (0.13.11)
Stay organized with collections
Save and categorize content based on your preferences.
Version latestkeyboard_arrow_down
PurgeIdentityMappingsRequest (
mapping = None , * , ignore_unknown_fields = False , ** kwargs
)
Attributes
Name
Description
inline_source
google.cloud.discoveryengine_v1.types.PurgeIdentityMappingsRequest.InlineSource
The inline source to purge identity mapping
entries from.
This field is a member of oneof
_ source
.
identity_mapping_store
str
Required. The name of the Identity Mapping Store to purge
Identity Mapping Entries from. Format:
projects/{project}/locations/{location}/identityMappingStores/{identityMappingStore}
filter
str
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 <>
- 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
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.
This field is a member of oneof
_ _force
.
Classes
InlineSource
InlineSource ( mapping = None , * , ignore_unknown_fields = False , ** kwargs )
The inline source to purge identity mapping entries from.
Send feedback
Except as otherwise noted, the content of this page is licensed under the Creative Commons Attribution 4.0 License , and code samples are licensed under the Apache 2.0 License . For details, see the Google Developers Site Policies . Java is a registered trademark of Oracle and/or its affiliates.
Last updated 2025-08-07 UTC.
Need to tell us more?
[[["Easy to understand","easyToUnderstand","thumb-up"],["Solved my problem","solvedMyProblem","thumb-up"],["Other","otherUp","thumb-up"]],[["Hard to understand","hardToUnderstand","thumb-down"],["Incorrect information or sample code","incorrectInformationOrSampleCode","thumb-down"],["Missing the information/samples I need","missingTheInformationSamplesINeed","thumb-down"],["Other","otherDown","thumb-down"]],["Last updated 2025-08-07 UTC."],[],[],null,["# Class PurgeIdentityMappingsRequest (0.13.11)\n\nVersion latestkeyboard_arrow_down\n\n- [0.13.11 (latest)](/python/docs/reference/discoveryengine/latest/google.cloud.discoveryengine_v1.types.PurgeIdentityMappingsRequest)\n- [0.13.10](/python/docs/reference/discoveryengine/0.13.10/google.cloud.discoveryengine_v1.types.PurgeIdentityMappingsRequest)\n- [0.12.3](/python/docs/reference/discoveryengine/0.12.3/google.cloud.discoveryengine_v1.types.PurgeIdentityMappingsRequest)\n- [0.11.14](/python/docs/reference/discoveryengine/0.11.14/google.cloud.discoveryengine_v1.types.PurgeIdentityMappingsRequest)\n- [0.10.0](/python/docs/reference/discoveryengine/0.10.0/google.cloud.discoveryengine_v1.types.PurgeIdentityMappingsRequest)\n- [0.9.1](/python/docs/reference/discoveryengine/0.9.1/google.cloud.discoveryengine_v1.types.PurgeIdentityMappingsRequest)\n- [0.8.1](/python/docs/reference/discoveryengine/0.8.1/google.cloud.discoveryengine_v1.types.PurgeIdentityMappingsRequest)\n- [0.7.0](/python/docs/reference/discoveryengine/0.7.0/google.cloud.discoveryengine_v1.types.PurgeIdentityMappingsRequest)\n- [0.6.0](/python/docs/reference/discoveryengine/0.6.0/google.cloud.discoveryengine_v1.types.PurgeIdentityMappingsRequest)\n- [0.5.0](/python/docs/reference/discoveryengine/0.5.0/google.cloud.discoveryengine_v1.types.PurgeIdentityMappingsRequest)\n- [0.4.1](/python/docs/reference/discoveryengine/0.4.1/google.cloud.discoveryengine_v1.types.PurgeIdentityMappingsRequest)\n- [0.3.1](/python/docs/reference/discoveryengine/0.3.1/google.cloud.discoveryengine_v1.types.PurgeIdentityMappingsRequest)\n- [0.2.1](/python/docs/reference/discoveryengine/0.2.1/google.cloud.discoveryengine_v1.types.PurgeIdentityMappingsRequest)\n- [0.1.1](/python/docs/reference/discoveryengine/0.1.1/google.cloud.discoveryengine_v1.types.PurgeIdentityMappingsRequest) \n\n PurgeIdentityMappingsRequest(\n mapping=None, *, ignore_unknown_fields=False, **kwargs\n )\n\nRequest message for\nIdentityMappingStoreService.PurgeIdentityMappings\n\n.. _oneof: \u003chttps://proto-plus-python.readthedocs.io/en/stable/fields.html#oneofs-mutually-exclusive-fields\u003e\n\nClasses\n-------\n\n### InlineSource\n\n InlineSource(mapping=None, *, ignore_unknown_fields=False, **kwargs)\n\nThe inline source to purge identity mapping entries from."]]