com.google.cloud.discoveryengine.v1

Interface PurgeIdentityMappingsRequestOrBuilder

All Superinterfaces:

com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder

All Known Implementing Classes:

PurgeIdentityMappingsRequest, PurgeIdentityMappingsRequest.Builder

@Generated
public interface PurgeIdentityMappingsRequestOrBuilder
extends com.google.protobuf.MessageOrBuilder

Method Summary

Modifier and Type	Method and Description
String	getFilter() Filter matching identity mappings to purge.
com.google.protobuf.ByteString	getFilterBytes() Filter matching identity mappings to purge.
boolean	getForce() Actually performs the purge.
String	getIdentityMappingStore() Required.
com.google.protobuf.ByteString	getIdentityMappingStoreBytes() Required.
PurgeIdentityMappingsRequest.InlineSource	getInlineSource() The inline source to purge identity mapping entries from.
PurgeIdentityMappingsRequest.InlineSourceOrBuilder	getInlineSourceOrBuilder() The inline source to purge identity mapping entries from.
PurgeIdentityMappingsRequest.SourceCase	getSourceCase()
boolean	hasForce() Actually performs the purge.
boolean	hasInlineSource() The inline source to purge identity mapping entries from.

Methods inherited from interface com.google.protobuf.MessageOrBuilder

findInitializationErrors, getAllFields, getDefaultInstanceForType, getDescriptorForType, getField, getInitializationErrorString, getOneofFieldDescriptor, getRepeatedField, getRepeatedFieldCount, getUnknownFields, hasField, hasOneof

Methods inherited from interface com.google.protobuf.MessageLiteOrBuilder

isInitialized

Method Detail

hasInlineSource

boolean hasInlineSource()

 The inline source to purge identity mapping entries from.
 

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

Returns:

Whether the inlineSource field is set.

getInlineSource

PurgeIdentityMappingsRequest.InlineSource getInlineSource()

 The inline source to purge identity mapping entries from.
 

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

Returns:

The inlineSource.

getInlineSourceOrBuilder

PurgeIdentityMappingsRequest.InlineSourceOrBuilder getInlineSourceOrBuilder()

 The inline source to purge identity mapping entries from.
 

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

getIdentityMappingStore

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:

The identityMappingStore.

getIdentityMappingStoreBytes

com.google.protobuf.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:

The bytes for identityMappingStore.

getFilter

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:

The filter.

getFilterBytes

com.google.protobuf.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:

The bytes for filter.

hasForce

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:

Whether the force field is set.

getForce

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:

The force.

getSourceCase

PurgeIdentityMappingsRequest.SourceCase getSourceCase()