Send feedback
Class PurgeIdentityMappingsRequest (0.60.0)
Stay organized with collections
Save and categorize content based on your preferences.
Version latestkeyboard_arrow_down
public final class PurgeIdentityMappingsRequest extends GeneratedMessageV3 implements PurgeIdentityMappingsRequestOrBuilder
Request message for
IdentityMappingStoreService.PurgeIdentityMappings
Protobuf type google.cloud.discoveryengine.v1.PurgeIdentityMappingsRequest
Inherited Members
com.google.protobuf.GeneratedMessageV3.<ListT>makeMutableCopy(ListT)
com.google.protobuf.GeneratedMessageV3.<ListT>makeMutableCopy(ListT,int)
com.google.protobuf.GeneratedMessageV3.<T>emptyList(java.lang.Class<T>)
com.google.protobuf.GeneratedMessageV3.internalGetMapFieldReflection(int)
Static Fields
FILTER_FIELD_NUMBER
public static final int FILTER_FIELD_NUMBER
Field Value
Type Description
int
FORCE_FIELD_NUMBER
public static final int FORCE_FIELD_NUMBER
Field Value
Type Description
int
IDENTITY_MAPPING_STORE_FIELD_NUMBER
public static final int IDENTITY_MAPPING_STORE_FIELD_NUMBER
Field Value
Type Description
int
INLINE_SOURCE_FIELD_NUMBER
public static final int INLINE_SOURCE_FIELD_NUMBER
Field Value
Type Description
int
Static Methods
getDefaultInstance()
public static PurgeIdentityMappingsRequest getDefaultInstance ()
getDescriptor()
public static final Descriptors . Descriptor getDescriptor ()
newBuilder()
public static PurgeIdentityMappingsRequest . Builder newBuilder ()
newBuilder(PurgeIdentityMappingsRequest prototype)
public static PurgeIdentityMappingsRequest . Builder newBuilder ( PurgeIdentityMappingsRequest prototype )
public static PurgeIdentityMappingsRequest parseDelimitedFrom ( InputStream input )
public static PurgeIdentityMappingsRequest parseDelimitedFrom ( InputStream input , ExtensionRegistryLite extensionRegistry )
parseFrom(byte[] data)
public static PurgeIdentityMappingsRequest parseFrom ( byte [] data )
Parameter
Name Description
databyte []
parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)
public static PurgeIdentityMappingsRequest parseFrom ( byte [] data , ExtensionRegistryLite extensionRegistry )
parseFrom(ByteString data)
public static PurgeIdentityMappingsRequest parseFrom ( ByteString data )
parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)
public static PurgeIdentityMappingsRequest parseFrom ( ByteString data , ExtensionRegistryLite extensionRegistry )
public static PurgeIdentityMappingsRequest parseFrom ( CodedInputStream input )
public static PurgeIdentityMappingsRequest parseFrom ( CodedInputStream input , ExtensionRegistryLite extensionRegistry )
public static PurgeIdentityMappingsRequest parseFrom ( InputStream input )
public static PurgeIdentityMappingsRequest parseFrom ( InputStream input , ExtensionRegistryLite extensionRegistry )
parseFrom(ByteBuffer data)
public static PurgeIdentityMappingsRequest parseFrom ( ByteBuffer data )
parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)
public static PurgeIdentityMappingsRequest parseFrom ( ByteBuffer data , ExtensionRegistryLite extensionRegistry )
parser()
public static Parser<PurgeIdentityMappingsRequest> parser ()
Methods
equals(Object obj)
public boolean equals ( Object obj )
Parameter
Name Description
objObject
Overrides
getDefaultInstanceForType()
public PurgeIdentityMappingsRequest getDefaultInstanceForType ()
getFilter()
public 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 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 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 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 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 PurgeIdentityMappingsRequest . InlineSource getInlineSource ()
The inline source to purge identity mapping entries from.
.google.cloud.discoveryengine.v1.PurgeIdentityMappingsRequest.InlineSource inline_source = 2;
getInlineSourceOrBuilder()
public PurgeIdentityMappingsRequest . InlineSourceOrBuilder getInlineSourceOrBuilder ()
The inline source to purge identity mapping entries from.
.google.cloud.discoveryengine.v1.PurgeIdentityMappingsRequest.InlineSource inline_source = 2;
getParserForType()
public Parser<PurgeIdentityMappingsRequest> getParserForType ()
Overrides
getSerializedSize()
public int getSerializedSize ()
Returns
Type Description
int
Overrides
getSourceCase()
public PurgeIdentityMappingsRequest . SourceCase getSourceCase ()
hasForce()
public 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 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.
hashCode()
Returns
Type Description
int
Overrides
internalGetFieldAccessorTable()
protected GeneratedMessageV3 . FieldAccessorTable internalGetFieldAccessorTable ()
Overrides
isInitialized()
public final boolean isInitialized ()
Overrides
newBuilderForType()
public PurgeIdentityMappingsRequest . Builder newBuilderForType ()
newBuilderForType(GeneratedMessageV3.BuilderParent parent)
protected PurgeIdentityMappingsRequest . Builder newBuilderForType ( GeneratedMessageV3 . BuilderParent parent )
Overrides
newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)
protected Object newInstance ( GeneratedMessageV3 . UnusedPrivateParameter unused )
Returns
Type Description
Object
Overrides
toBuilder()
public PurgeIdentityMappingsRequest . Builder toBuilder ()
writeTo(CodedOutputStream output)
public void writeTo ( CodedOutputStream output )
Overrides
Send feedback
Except as otherwise noted, the content of this page is licensed under the Creative Commons Attribution 4.0 License , and code samples are licensed under the Apache 2.0 License . For details, see the Google Developers Site Policies . Java is a registered trademark of Oracle and/or its affiliates.
Last updated 2025-06-12 UTC.
Need to tell us more?
[[["Easy to understand","easyToUnderstand","thumb-up"],["Solved my problem","solvedMyProblem","thumb-up"],["Other","otherUp","thumb-up"]],[["Hard to understand","hardToUnderstand","thumb-down"],["Incorrect information or sample code","incorrectInformationOrSampleCode","thumb-down"],["Missing the information/samples I need","missingTheInformationSamplesINeed","thumb-down"],["Other","otherDown","thumb-down"]],["Last updated 2025-06-12 UTC."],[],[]]
