Discovery Engine v1 API - Class PurgeIdentityMappingsRequest (1.8.0) 

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]

Inheritance

object > PurgeIdentityMappingsRequest

Namespace

Google.Cloud.DiscoveryEngine.V1

Assembly

Google.Cloud.DiscoveryEngine.V1.dll

Constructors

PurgeIdentityMappingsRequest()

public PurgeIdentityMappingsRequest()

PurgeIdentityMappingsRequest(PurgeIdentityMappingsRequest)

public PurgeIdentityMappingsRequest(PurgeIdentityMappingsRequest other)
Parameter
Name Description
other 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
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
bool

HasForce

public bool HasForce { get; }

Gets whether the "force" field is set

Property Value
Type Description
bool

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
string

IdentityMappingStoreAsIdentityMappingStoreName

public IdentityMappingStoreName IdentityMappingStoreAsIdentityMappingStoreName { get; set; }

IdentityMappingStoreName-typed view over the IdentityMappingStore resource name property.

Property Value
Type Description
IdentityMappingStoreName

InlineSource

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

The inline source to purge identity mapping entries from.

Property Value
Type Description
PurgeIdentityMappingsRequestTypesInlineSource

SourceCase

public PurgeIdentityMappingsRequest.SourceOneofCase SourceCase { get; }
Property Value
Type Description
PurgeIdentityMappingsRequestSourceOneofCase