Interface PurgeIdentityMappingsRequestOrBuilder (0.60.0)

public interface PurgeIdentityMappingsRequestOrBuilder extends MessageOrBuilder

Implements

MessageOrBuilder

Methods

getFilter()

public abstract String getFilter()

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.

string filter = 3;

Returns
Type Description
String

The filter.

getFilterBytes()

public abstract ByteString getFilterBytes()

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.

string filter = 3;

Returns
Type Description
ByteString

The bytes for filter.

getForce()

public abstract boolean getForce()

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.

optional bool force = 4;

Returns
Type Description
boolean

The force.

getIdentityMappingStore()

public abstract String getIdentityMappingStore()

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

string identity_mapping_store = 1 [(.google.api.field_behavior) = REQUIRED, (.google.api.resource_reference) = { ... }

Returns
Type Description
String

The identityMappingStore.

getIdentityMappingStoreBytes()

public abstract ByteString getIdentityMappingStoreBytes()

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

string identity_mapping_store = 1 [(.google.api.field_behavior) = REQUIRED, (.google.api.resource_reference) = { ... }

Returns
Type Description
ByteString

The bytes for identityMappingStore.

getInlineSource()

public abstract PurgeIdentityMappingsRequest.InlineSource getInlineSource()

The inline source to purge identity mapping entries from.

.google.cloud.discoveryengine.v1.PurgeIdentityMappingsRequest.InlineSource inline_source = 2;

Returns
Type Description
PurgeIdentityMappingsRequest.InlineSource

The inlineSource.

getInlineSourceOrBuilder()

public abstract PurgeIdentityMappingsRequest.InlineSourceOrBuilder getInlineSourceOrBuilder()

The inline source to purge identity mapping entries from.

.google.cloud.discoveryengine.v1.PurgeIdentityMappingsRequest.InlineSource inline_source = 2;

Returns
Type Description
PurgeIdentityMappingsRequest.InlineSourceOrBuilder

getSourceCase()

public abstract PurgeIdentityMappingsRequest.SourceCase getSourceCase()
Returns
Type Description
PurgeIdentityMappingsRequest.SourceCase

hasForce()

public abstract boolean hasForce()

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.

optional bool force = 4;

Returns
Type Description
boolean

Whether the force field is set.

hasInlineSource()

public abstract boolean hasInlineSource()

The inline source to purge identity mapping entries from.

.google.cloud.discoveryengine.v1.PurgeIdentityMappingsRequest.InlineSource inline_source = 2;

Returns
Type Description
boolean

Whether the inlineSource field is set.