com.google.api.services.discoveryengine.v1.model

Class GoogleCloudDiscoveryengineV1PurgeIdentityMappingsRequest

java.lang.Object

java.util.AbstractMap<String,Object>

com.google.api.client.util.GenericData

com.google.api.client.json.GenericJson

com.google.api.services.discoveryengine.v1.model.GoogleCloudDiscoveryengineV1PurgeIdentityMappingsRequest

All Implemented Interfaces:

Cloneable, Map<String,Object>

public final class GoogleCloudDiscoveryengineV1PurgeIdentityMappingsRequest
extends com.google.api.client.json.GenericJson

Request message for IdentityMappingStoreService.PurgeIdentityMappings

This is the Java data model class that specifies how to parse/serialize into the JSON that is transmitted over HTTP when working with the Discovery Engine API. For a detailed explanation see: https://developers.google.com/api-client-library/java/google-http-java-client/json

Author:

Google, Inc.

Nested Class Summary

Nested classes/interfaces inherited from class com.google.api.client.util.GenericData

com.google.api.client.util.GenericData.Flags

Nested classes/interfaces inherited from class java.util.AbstractMap

AbstractMap.SimpleEntry<K,V>, AbstractMap.SimpleImmutableEntry<K,V>

Nested classes/interfaces inherited from interface java.util.Map

Map.Entry<K,V>

Constructor Summary

Constructors

Constructor and Description
GoogleCloudDiscoveryengineV1PurgeIdentityMappingsRequest()

Method Summary

Modifier and Type	Method and Description
GoogleCloudDiscoveryengineV1PurgeIdentityMappingsRequest	clone()
String	getFilter() Filter matching identity mappings to purge.
Boolean	getForce() Actually performs the purge.
GoogleCloudDiscoveryengineV1PurgeIdentityMappingsRequestInlineSource	getInlineSource() The inline source to purge identity mapping entries from.
GoogleCloudDiscoveryengineV1PurgeIdentityMappingsRequest	set(String fieldName, Object value)
GoogleCloudDiscoveryengineV1PurgeIdentityMappingsRequest	setFilter(String filter) Filter matching identity mappings to purge.
GoogleCloudDiscoveryengineV1PurgeIdentityMappingsRequest	setForce(Boolean force) Actually performs the purge.
GoogleCloudDiscoveryengineV1PurgeIdentityMappingsRequest	setInlineSource(GoogleCloudDiscoveryengineV1PurgeIdentityMappingsRequestInlineSource inlineSource) The inline source to purge identity mapping entries from.

Methods inherited from class com.google.api.client.json.GenericJson

getFactory, setFactory, toPrettyString, toString

Methods inherited from class com.google.api.client.util.GenericData

entrySet, equals, get, getClassInfo, getUnknownKeys, hashCode, put, putAll, remove, setUnknownKeys

Methods inherited from class java.util.AbstractMap

clear, containsKey, containsValue, isEmpty, keySet, size, values

Methods inherited from class java.lang.Object

finalize, getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface java.util.Map

compute, computeIfAbsent, computeIfPresent, forEach, getOrDefault, merge, putIfAbsent, remove, replace, replace, replaceAll

Constructor Detail

GoogleCloudDiscoveryengineV1PurgeIdentityMappingsRequest

public GoogleCloudDiscoveryengineV1PurgeIdentityMappingsRequest()

Method Detail

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.

Returns:

value or null for none

setFilter

public GoogleCloudDiscoveryengineV1PurgeIdentityMappingsRequest setFilter(String filter)

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.

Parameters:

filter - filter or null for none

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.

Returns:

value or null for none

setForce

public GoogleCloudDiscoveryengineV1PurgeIdentityMappingsRequest setForce(Boolean force)

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.

Parameters:

force - force or null for none

getInlineSource

public GoogleCloudDiscoveryengineV1PurgeIdentityMappingsRequestInlineSource getInlineSource()

The inline source to purge identity mapping entries from.

Returns:

value or null for none

setInlineSource

public GoogleCloudDiscoveryengineV1PurgeIdentityMappingsRequest setInlineSource(GoogleCloudDiscoveryengineV1PurgeIdentityMappingsRequestInlineSource inlineSource)

The inline source to purge identity mapping entries from.

Parameters:

inlineSource - inlineSource or null for none

set

public GoogleCloudDiscoveryengineV1PurgeIdentityMappingsRequest set(String fieldName,
                                                                    Object value)

Overrides:

set in class com.google.api.client.json.GenericJson

clone

public GoogleCloudDiscoveryengineV1PurgeIdentityMappingsRequest clone()

Overrides:

clone in class com.google.api.client.json.GenericJson