public sealed class PurgeIdentityMappingsRequest : IMessage<PurgeIdentityMappingsRequest>, IEquatable<PurgeIdentityMappingsRequest>, IDeepCloneable<PurgeIdentityMappingsRequest>, IBufferMessage, IMessage
Reference documentation and code samples for the Discovery Engine v1 API class PurgeIdentityMappingsRequest.
Request message for
[IdentityMappingStoreService.PurgeIdentityMappings][google.cloud.discoveryengine.v1.IdentityMappingStoreService.PurgeIdentityMappings]
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.
Required. The name of the Identity Mapping Store to purge Identity Mapping
Entries from. Format:
projects/{project}/locations/{location}/identityMappingStores/{identityMappingStore}
[[["Easy to understand","easyToUnderstand","thumb-up"],["Solved my problem","solvedMyProblem","thumb-up"],["Other","otherUp","thumb-up"]],[["Missing the information I need","missingTheInformationINeed","thumb-down"],["Too complicated / too many steps","tooComplicatedTooManySteps","thumb-down"],["Out of date","outOfDate","thumb-down"],["Samples / code issue","samplesCodeIssue","thumb-down"],["Other","otherDown","thumb-down"]],["Last updated 2025-08-07 UTC."],[],[],null,["# Discovery Engine v1 API - Class PurgeIdentityMappingsRequest (1.9.0)\n\nVersion latestkeyboard_arrow_down\n\n- [1.9.0 (latest)](/dotnet/docs/reference/Google.Cloud.DiscoveryEngine.V1/latest/Google.Cloud.DiscoveryEngine.V1.PurgeIdentityMappingsRequest)\n- [1.8.0](/dotnet/docs/reference/Google.Cloud.DiscoveryEngine.V1/1.8.0/Google.Cloud.DiscoveryEngine.V1.PurgeIdentityMappingsRequest)\n- [1.7.0](/dotnet/docs/reference/Google.Cloud.DiscoveryEngine.V1/1.7.0/Google.Cloud.DiscoveryEngine.V1.PurgeIdentityMappingsRequest)\n- [1.6.0](/dotnet/docs/reference/Google.Cloud.DiscoveryEngine.V1/1.6.0/Google.Cloud.DiscoveryEngine.V1.PurgeIdentityMappingsRequest)\n- [1.5.0](/dotnet/docs/reference/Google.Cloud.DiscoveryEngine.V1/1.5.0/Google.Cloud.DiscoveryEngine.V1.PurgeIdentityMappingsRequest)\n- [1.4.0](/dotnet/docs/reference/Google.Cloud.DiscoveryEngine.V1/1.4.0/Google.Cloud.DiscoveryEngine.V1.PurgeIdentityMappingsRequest)\n- [1.3.0](/dotnet/docs/reference/Google.Cloud.DiscoveryEngine.V1/1.3.0/Google.Cloud.DiscoveryEngine.V1.PurgeIdentityMappingsRequest)\n- [1.2.0](/dotnet/docs/reference/Google.Cloud.DiscoveryEngine.V1/1.2.0/Google.Cloud.DiscoveryEngine.V1.PurgeIdentityMappingsRequest)\n- [1.1.0](/dotnet/docs/reference/Google.Cloud.DiscoveryEngine.V1/1.1.0/Google.Cloud.DiscoveryEngine.V1.PurgeIdentityMappingsRequest)\n- [1.0.0-beta06](/dotnet/docs/reference/Google.Cloud.DiscoveryEngine.V1/1.0.0-beta06/Google.Cloud.DiscoveryEngine.V1.PurgeIdentityMappingsRequest) \n\n public sealed class PurgeIdentityMappingsRequest : IMessage\u003cPurgeIdentityMappingsRequest\u003e, IEquatable\u003cPurgeIdentityMappingsRequest\u003e, IDeepCloneable\u003cPurgeIdentityMappingsRequest\u003e, IBufferMessage, IMessage\n\nReference documentation and code samples for the Discovery Engine v1 API class PurgeIdentityMappingsRequest.\n\nRequest message for\n\\[IdentityMappingStoreService.PurgeIdentityMappings\\]\\[google.cloud.discoveryengine.v1.IdentityMappingStoreService.PurgeIdentityMappings\\] \n\nInheritance\n-----------\n\n[object](https://learn.microsoft.com/dotnet/api/system.object) \\\u003e PurgeIdentityMappingsRequest \n\nImplements\n----------\n\n[IMessage](https://cloud.google.com/dotnet/docs/reference/Google.Protobuf/latest/Google.Protobuf.IMessage-1.html)[PurgeIdentityMappingsRequest](/dotnet/docs/reference/Google.Cloud.DiscoveryEngine.V1/latest/Google.Cloud.DiscoveryEngine.V1.PurgeIdentityMappingsRequest), [IEquatable](https://learn.microsoft.com/dotnet/api/system.iequatable-1)[PurgeIdentityMappingsRequest](/dotnet/docs/reference/Google.Cloud.DiscoveryEngine.V1/latest/Google.Cloud.DiscoveryEngine.V1.PurgeIdentityMappingsRequest), [IDeepCloneable](https://cloud.google.com/dotnet/docs/reference/Google.Protobuf/latest/Google.Protobuf.IDeepCloneable-1.html)[PurgeIdentityMappingsRequest](/dotnet/docs/reference/Google.Cloud.DiscoveryEngine.V1/latest/Google.Cloud.DiscoveryEngine.V1.PurgeIdentityMappingsRequest), [IBufferMessage](https://cloud.google.com/dotnet/docs/reference/Google.Protobuf/latest/Google.Protobuf.IBufferMessage.html), [IMessage](https://cloud.google.com/dotnet/docs/reference/Google.Protobuf/latest/Google.Protobuf.IMessage.html) \n\nInherited Members\n-----------------\n\n[object.GetHashCode()](https://learn.microsoft.com/dotnet/api/system.object.gethashcode) \n[object.GetType()](https://learn.microsoft.com/dotnet/api/system.object.gettype) \n[object.ToString()](https://learn.microsoft.com/dotnet/api/system.object.tostring)\n\nNamespace\n---------\n\n[Google.Cloud.DiscoveryEngine.V1](/dotnet/docs/reference/Google.Cloud.DiscoveryEngine.V1/latest/Google.Cloud.DiscoveryEngine.V1)\n\nAssembly\n--------\n\nGoogle.Cloud.DiscoveryEngine.V1.dll\n\nConstructors\n------------\n\n### PurgeIdentityMappingsRequest()\n\n public PurgeIdentityMappingsRequest()\n\n### PurgeIdentityMappingsRequest(PurgeIdentityMappingsRequest)\n\n public PurgeIdentityMappingsRequest(PurgeIdentityMappingsRequest other)\n\nProperties\n----------\n\n### Filter\n\n public string Filter { get; set; }\n\nFilter matching identity mappings to purge.\nThe eligible field for filtering is:\n\n- `update_time`: in ISO 8601 \"zulu\" format.\n- `external_id`\n\nExamples:\n\n- Deleting all identity mappings updated in a time range: `update_time \u003e \"2012-04-23T18:25:43.511Z\" AND update_time \u003c\n \"2012-04-23T18:30:43.511Z\"`\n- Deleting all identity mappings for a given external_id: `external_id = \"id1\"`\n- Deleting all identity mappings inside an identity mapping store: `*`\n\nThe filtering fields are assumed to have an implicit AND.\nShould not be used with source. An error will be thrown, if both are\nprovided.\n\n### Force\n\n public bool Force { get; set; }\n\nActually performs the purge. If `force` is set to false, return the\nexpected purge count without deleting any identity mappings. This field is\nonly supported for purge with filter. For input source this field is\nignored and data will be purged regardless of the value of this field.\n\n### HasForce\n\n public bool HasForce { get; }\n\nGets whether the \"force\" field is set\n\n### IdentityMappingStore\n\n public string IdentityMappingStore { get; set; }\n\nRequired. The name of the Identity Mapping Store to purge Identity Mapping\nEntries from. Format:\n`projects/{project}/locations/{location}/identityMappingStores/{identityMappingStore}`\n\n### IdentityMappingStoreAsIdentityMappingStoreName\n\n public IdentityMappingStoreName IdentityMappingStoreAsIdentityMappingStoreName { get; set; }\n\n[IdentityMappingStoreName](/dotnet/docs/reference/Google.Cloud.DiscoveryEngine.V1/latest/Google.Cloud.DiscoveryEngine.V1.IdentityMappingStoreName)-typed view over the [IdentityMappingStore](/dotnet/docs/reference/Google.Cloud.DiscoveryEngine.V1/latest/Google.Cloud.DiscoveryEngine.V1.PurgeIdentityMappingsRequest#Google_Cloud_DiscoveryEngine_V1_PurgeIdentityMappingsRequest_IdentityMappingStore) resource name\nproperty.\n\n### InlineSource\n\n public PurgeIdentityMappingsRequest.Types.InlineSource InlineSource { get; set; }\n\nThe inline source to purge identity mapping entries from.\n\n### SourceCase\n\n public PurgeIdentityMappingsRequest.SourceOneofCase SourceCase { get; }"]]
