0.20.1 (latest) 0.20.0 0.19.0 0.18.0 0.17.0 0.16.0 0.15.0 0.14.0 0.13.12 0.12.3 0.11.14 0.10.0 0.9.1 0.8.1 0.7.0 0.6.0 0.5.0 0.4.1 0.3.1 0.2.1 0.1.1

    PurgeIdentityMappingsRequest(
        mapping=None, *, ignore_unknown_fields=False, **kwargs
    )

Request message for
IdentityMappingStoreService.PurgeIdentityMappings

.. _oneof: <https://proto-plus-python.readthedocs.io/en/stable/fields.html#oneofs-mutually-exclusive-fields>

| ## Attributes ||
|---|---|
| **Name** | **Description** |
| `inline_source` | `https://docs.cloud.google.com/python/docs/reference/discoveryengine/latest/google.cloud.discoveryengine_v1beta.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.