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

Class GoogleCloudDiscoveryengineV1PurgeDocumentsRequest

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.GoogleCloudDiscoveryengineV1PurgeDocumentsRequest

All Implemented Interfaces:

Cloneable, Map<String,Object>

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

Request message for DocumentService.PurgeDocuments method.

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
GoogleCloudDiscoveryengineV1PurgeDocumentsRequest()

Method Summary

Modifier and Type	Method and Description
GoogleCloudDiscoveryengineV1PurgeDocumentsRequest	clone()
GoogleCloudDiscoveryengineV1PurgeErrorConfig	getErrorConfig() The desired location of errors incurred during the purge.
String	getFilter() Required.
Boolean	getForce() Actually performs the purge.
GoogleCloudDiscoveryengineV1GcsSource	getGcsSource() Cloud Storage location for the input content.
GoogleCloudDiscoveryengineV1PurgeDocumentsRequestInlineSource	getInlineSource() Inline source for the input content for purge.
GoogleCloudDiscoveryengineV1PurgeDocumentsRequest	set(String fieldName, Object value)
GoogleCloudDiscoveryengineV1PurgeDocumentsRequest	setErrorConfig(GoogleCloudDiscoveryengineV1PurgeErrorConfig errorConfig) The desired location of errors incurred during the purge.
GoogleCloudDiscoveryengineV1PurgeDocumentsRequest	setFilter(String filter) Required.
GoogleCloudDiscoveryengineV1PurgeDocumentsRequest	setForce(Boolean force) Actually performs the purge.
GoogleCloudDiscoveryengineV1PurgeDocumentsRequest	setGcsSource(GoogleCloudDiscoveryengineV1GcsSource gcsSource) Cloud Storage location for the input content.
GoogleCloudDiscoveryengineV1PurgeDocumentsRequest	setInlineSource(GoogleCloudDiscoveryengineV1PurgeDocumentsRequestInlineSource inlineSource) Inline source for the input content for purge.

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

GoogleCloudDiscoveryengineV1PurgeDocumentsRequest

public GoogleCloudDiscoveryengineV1PurgeDocumentsRequest()

Method Detail

getErrorConfig

public GoogleCloudDiscoveryengineV1PurgeErrorConfig getErrorConfig()

The desired location of errors incurred during the purge.

Returns:

value or null for none

setErrorConfig

public GoogleCloudDiscoveryengineV1PurgeDocumentsRequest setErrorConfig(GoogleCloudDiscoveryengineV1PurgeErrorConfig errorConfig)

The desired location of errors incurred during the purge.

Parameters:

errorConfig - errorConfig or null for none

getFilter

public String getFilter()

Required. Filter matching documents to purge. Only currently supported value is `*` (all items).

Returns:

value or null for none

setFilter

public GoogleCloudDiscoveryengineV1PurgeDocumentsRequest setFilter(String filter)

Required. Filter matching documents to purge. Only currently supported value is `*` (all items).

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 documents.

Returns:

value or null for none

setForce

public GoogleCloudDiscoveryengineV1PurgeDocumentsRequest setForce(Boolean force)

Actually performs the purge. If `force` is set to false, return the expected purge count without deleting any documents.

Parameters:

force - force or null for none

getGcsSource

public GoogleCloudDiscoveryengineV1GcsSource getGcsSource()

Cloud Storage location for the input content. Supported `data_schema`: * `document_id`: One valid Document.id per line.

Returns:

value or null for none

setGcsSource

public GoogleCloudDiscoveryengineV1PurgeDocumentsRequest setGcsSource(GoogleCloudDiscoveryengineV1GcsSource gcsSource)

Cloud Storage location for the input content. Supported `data_schema`: * `document_id`: One valid Document.id per line.

Parameters:

gcsSource - gcsSource or null for none

getInlineSource

public GoogleCloudDiscoveryengineV1PurgeDocumentsRequestInlineSource getInlineSource()

Inline source for the input content for purge.

Returns:

value or null for none

setInlineSource

public GoogleCloudDiscoveryengineV1PurgeDocumentsRequest setInlineSource(GoogleCloudDiscoveryengineV1PurgeDocumentsRequestInlineSource inlineSource)

Inline source for the input content for purge.

Parameters:

inlineSource - inlineSource or null for none

set

public GoogleCloudDiscoveryengineV1PurgeDocumentsRequest set(String fieldName,
                                                             Object value)

Overrides:

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

clone

public GoogleCloudDiscoveryengineV1PurgeDocumentsRequest clone()

Overrides:

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