1.0.0-beta25 (latest) 1.0.0-beta24

    public sealed class PurgeIdentityMappingsRequest : IMessage<PurgeIdentityMappingsRequest>, IEquatable<PurgeIdentityMappingsRequest>, IDeepCloneable<PurgeIdentityMappingsRequest>, IBufferMessage, IMessage

Reference documentation and code samples for the Discovery Engine v1beta API class PurgeIdentityMappingsRequest.

Request message for
\[IdentityMappingStoreService.PurgeIdentityMappings\]\[google.cloud.discoveryengine.v1beta.IdentityMappingStoreService.PurgeIdentityMappings\]

## Inheritance

[object](https://learn.microsoft.com/dotnet/api/system.object) \> PurgeIdentityMappingsRequest

## Implements

[IMessage](https://cloud.google.com/dotnet/docs/reference/Google.Protobuf/latest/Google.Protobuf.IMessage-1.html)[PurgeIdentityMappingsRequest](https://docs.cloud.google.com/dotnet/docs/reference/Google.Cloud.DiscoveryEngine.V1Beta/latest/Google.Cloud.DiscoveryEngine.V1Beta.PurgeIdentityMappingsRequest), [IEquatable](https://learn.microsoft.com/dotnet/api/system.iequatable-1)[PurgeIdentityMappingsRequest](https://docs.cloud.google.com/dotnet/docs/reference/Google.Cloud.DiscoveryEngine.V1Beta/latest/Google.Cloud.DiscoveryEngine.V1Beta.PurgeIdentityMappingsRequest), [IDeepCloneable](https://cloud.google.com/dotnet/docs/reference/Google.Protobuf/latest/Google.Protobuf.IDeepCloneable-1.html)[PurgeIdentityMappingsRequest](https://docs.cloud.google.com/dotnet/docs/reference/Google.Cloud.DiscoveryEngine.V1Beta/latest/Google.Cloud.DiscoveryEngine.V1Beta.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)

## Inherited Members

[object.GetHashCode()](https://learn.microsoft.com/dotnet/api/system.object.gethashcode) [object.GetType()](https://learn.microsoft.com/dotnet/api/system.object.gettype) [object.ToString()](https://learn.microsoft.com/dotnet/api/system.object.tostring)

## Namespace

[Google.Cloud.DiscoveryEngine.V1Beta](https://docs.cloud.google.com/dotnet/docs/reference/Google.Cloud.DiscoveryEngine.V1Beta/latest/Google.Cloud.DiscoveryEngine.V1Beta)

## Assembly

Google.Cloud.DiscoveryEngine.V1Beta.dll

## Constructors

### PurgeIdentityMappingsRequest()

    public PurgeIdentityMappingsRequest()

### PurgeIdentityMappingsRequest(PurgeIdentityMappingsRequest)

    public PurgeIdentityMappingsRequest(PurgeIdentityMappingsRequest other)

| **Parameter** ||
|---|---|
| **Name** | **Description** |
| `other` | `https://docs.cloud.google.com/dotnet/docs/reference/Google.Cloud.DiscoveryEngine.V1Beta/latest/Google.Cloud.DiscoveryEngine.V1Beta.PurgeIdentityMappingsRequest` |

## Properties

### Filter

    public string Filter { get; set; }

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.

| **Property Value** ||
|---|---|
| **Type** | **Description** |
| `https://learn.microsoft.com/dotnet/api/system.string` |   |

### Force

    public bool Force { get; set; }

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.

| **Property Value** ||
|---|---|
| **Type** | **Description** |
| `https://learn.microsoft.com/dotnet/api/system.boolean` |   |

### HasForce

    public bool HasForce { get; }

Gets whether the "force" field is set

| **Property Value** ||
|---|---|
| **Type** | **Description** |
| `https://learn.microsoft.com/dotnet/api/system.boolean` |   |

### IdentityMappingStore

    public string IdentityMappingStore { get; set; }

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

| **Property Value** ||
|---|---|
| **Type** | **Description** |
| `https://learn.microsoft.com/dotnet/api/system.string` |   |

### IdentityMappingStoreAsIdentityMappingStoreName

    public IdentityMappingStoreName IdentityMappingStoreAsIdentityMappingStoreName { get; set; }

[IdentityMappingStoreName](https://docs.cloud.google.com/dotnet/docs/reference/Google.Cloud.DiscoveryEngine.V1Beta/latest/Google.Cloud.DiscoveryEngine.V1Beta.IdentityMappingStoreName)-typed view over the [IdentityMappingStore](https://docs.cloud.google.com/dotnet/docs/reference/Google.Cloud.DiscoveryEngine.V1Beta/latest/Google.Cloud.DiscoveryEngine.V1Beta.PurgeIdentityMappingsRequest#Google_Cloud_DiscoveryEngine_V1Beta_PurgeIdentityMappingsRequest_IdentityMappingStore) resource name
property.

| **Property Value** ||
|---|---|
| **Type** | **Description** |
| `https://docs.cloud.google.com/dotnet/docs/reference/Google.Cloud.DiscoveryEngine.V1Beta/latest/Google.Cloud.DiscoveryEngine.V1Beta.IdentityMappingStoreName` |   |

### InlineSource

    public PurgeIdentityMappingsRequest.Types.InlineSource InlineSource { get; set; }

The inline source to purge identity mapping entries from.

| **Property Value** ||
|---|---|
| **Type** | **Description** |
| `https://docs.cloud.google.com/dotnet/docs/reference/Google.Cloud.DiscoveryEngine.V1Beta/latest/Google.Cloud.DiscoveryEngine.V1Beta.PurgeIdentityMappingsRequesthttps://docs.cloud.google.com/dotnet/docs/reference/Google.Cloud.DiscoveryEngine.V1Beta/latest/Google.Cloud.DiscoveryEngine.V1Beta.PurgeIdentityMappingsRequest.Typeshttps://docs.cloud.google.com/dotnet/docs/reference/Google.Cloud.DiscoveryEngine.V1Beta/latest/Google.Cloud.DiscoveryEngine.V1Beta.PurgeIdentityMappingsRequest.Types.InlineSource` |   |

### SourceCase

    public PurgeIdentityMappingsRequest.SourceOneofCase SourceCase { get; }

| **Property Value** ||
|---|---|
| **Type** | **Description** |
| `https://docs.cloud.google.com/dotnet/docs/reference/Google.Cloud.DiscoveryEngine.V1Beta/latest/Google.Cloud.DiscoveryEngine.V1Beta.PurgeIdentityMappingsRequesthttps://docs.cloud.google.com/dotnet/docs/reference/Google.Cloud.DiscoveryEngine.V1Beta/latest/Google.Cloud.DiscoveryEngine.V1Beta.PurgeIdentityMappingsRequest.SourceOneofCase` |   |