Reference documentation and code samples for the Discovery Engine V1 API class Google::Cloud::DiscoveryEngine::V1::PurgeIdentityMappingsRequest.
Request message for IdentityMappingStoreService.PurgeIdentityMappings
Inherits
- Object
Extended By
- Google::Protobuf::MessageExts::ClassMethods
Includes
- Google::Protobuf::MessageExts
Methods
#filter
def filter() -> ::String
-
(::String) — 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.
#filter=
def filter=(value) -> ::String
-
value (::String) — 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 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.
#force
def force() -> ::Boolean
-
(::Boolean) — 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.
#force=
def force=(value) -> ::Boolean
-
value (::Boolean) — 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.
-
(::Boolean) — 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.
#identity_mapping_store
def identity_mapping_store() -> ::String
-
(::String) — Required. The name of the Identity Mapping Store to purge Identity Mapping
Entries from. Format:
projects/{project}/locations/{location}/identityMappingStores/{identityMappingStore}
#identity_mapping_store=
def identity_mapping_store=(value) -> ::String
-
value (::String) — Required. The name of the Identity Mapping Store to purge Identity Mapping
Entries from. Format:
projects/{project}/locations/{location}/identityMappingStores/{identityMappingStore}
-
(::String) — Required. The name of the Identity Mapping Store to purge Identity Mapping
Entries from. Format:
projects/{project}/locations/{location}/identityMappingStores/{identityMappingStore}
#inline_source
def inline_source() -> ::Google::Cloud::DiscoveryEngine::V1::PurgeIdentityMappingsRequest::InlineSource
- (::Google::Cloud::DiscoveryEngine::V1::PurgeIdentityMappingsRequest::InlineSource) — The inline source to purge identity mapping entries from.
#inline_source=
def inline_source=(value) -> ::Google::Cloud::DiscoveryEngine::V1::PurgeIdentityMappingsRequest::InlineSource
- value (::Google::Cloud::DiscoveryEngine::V1::PurgeIdentityMappingsRequest::InlineSource) — The inline source to purge identity mapping entries from.
- (::Google::Cloud::DiscoveryEngine::V1::PurgeIdentityMappingsRequest::InlineSource) — The inline source to purge identity mapping entries from.