com.google.api.services.discoveryengine.v1

Class DiscoveryEngine.Projects.Locations.DataStores.Branches.Documents.Delete

java.lang.Object

java.util.AbstractMap<String,Object>

com.google.api.client.util.GenericData

com.google.api.client.googleapis.services.AbstractGoogleClientRequest<T>

com.google.api.client.googleapis.services.json.AbstractGoogleJsonClientRequest<T>

com.google.api.services.discoveryengine.v1.DiscoveryEngineRequest<GoogleProtobufEmpty>

com.google.api.services.discoveryengine.v1.DiscoveryEngine.Projects.Locations.DataStores.Branches.Documents.Delete

All Implemented Interfaces:

Cloneable, Map<String,Object>

Enclosing class:

DiscoveryEngine.Projects.Locations.DataStores.Branches.Documents

public class DiscoveryEngine.Projects.Locations.DataStores.Branches.Documents.Delete
extends DiscoveryEngineRequest<GoogleProtobufEmpty>

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>

Field Summary

Fields inherited from class com.google.api.client.googleapis.services.AbstractGoogleClientRequest

API_VERSION_HEADER, USER_AGENT_SUFFIX

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	Delete(String name) Deletes a Document.

Method Summary

Modifier and Type	Method and Description
String	getName() Required.
DiscoveryEngine.Projects.Locations.DataStores.Branches.Documents.Delete	set(String parameterName, Object value)
DiscoveryEngine.Projects.Locations.DataStores.Branches.Documents.Delete	set$Xgafv(String $Xgafv) V1 error format.
DiscoveryEngine.Projects.Locations.DataStores.Branches.Documents.Delete	setAccessToken(String accessToken) OAuth access token.
DiscoveryEngine.Projects.Locations.DataStores.Branches.Documents.Delete	setAlt(String alt) Data format for response.
DiscoveryEngine.Projects.Locations.DataStores.Branches.Documents.Delete	setCallback(String callback) JSONP
DiscoveryEngine.Projects.Locations.DataStores.Branches.Documents.Delete	setFields(String fields) Selector specifying which fields to include in a partial response.
DiscoveryEngine.Projects.Locations.DataStores.Branches.Documents.Delete	setKey(String key) API key.
DiscoveryEngine.Projects.Locations.DataStores.Branches.Documents.Delete	setName(String name) Required.
DiscoveryEngine.Projects.Locations.DataStores.Branches.Documents.Delete	setOauthToken(String oauthToken) OAuth 2.0 token for the current user.
DiscoveryEngine.Projects.Locations.DataStores.Branches.Documents.Delete	setPrettyPrint(Boolean prettyPrint) Returns response with indentations and line breaks.
DiscoveryEngine.Projects.Locations.DataStores.Branches.Documents.Delete	setQuotaUser(String quotaUser) Available to use for quota purposes for server-side applications.
DiscoveryEngine.Projects.Locations.DataStores.Branches.Documents.Delete	setUploadProtocol(String uploadProtocol) Upload protocol for media (e.g.
DiscoveryEngine.Projects.Locations.DataStores.Branches.Documents.Delete	setUploadType(String uploadType) Legacy upload protocol for media (e.g.

Methods inherited from class com.google.api.services.discoveryengine.v1.DiscoveryEngineRequest

get$Xgafv, getAbstractGoogleClient, getAccessToken, getAlt, getCallback, getFields, getKey, getOauthToken, getPrettyPrint, getQuotaUser, getUploadProtocol, getUploadType, setDisableGZipContent, setRequestHeaders

Methods inherited from class com.google.api.client.googleapis.services.json.AbstractGoogleJsonClientRequest

getJsonContent, newExceptionOnError, queue

Methods inherited from class com.google.api.client.googleapis.services.AbstractGoogleClientRequest

buildHttpRequest, buildHttpRequestUrl, buildHttpRequestUsingHead, checkRequiredParameter, execute, executeAndDownloadTo, executeAsInputStream, executeMedia, executeMediaAndDownloadTo, executeMediaAsInputStream, executeUnparsed, executeUsingHead, getDisableGZipContent, getHttpContent, getLastResponseHeaders, getLastStatusCode, getLastStatusMessage, getMediaHttpDownloader, getMediaHttpUploader, getRequestHeaders, getRequestMethod, getResponseClass, getReturnRawInputSteam, getUriTemplate, initializeMediaDownload, initializeMediaUpload, queue, setReturnRawInputStream

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

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

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

Delete

protected Delete(String name)

Deletes a Document. Create a request for the method "documents.delete". This request holds the parameters needed by the the discoveryengine server. After setting any optional parameters, call the AbstractGoogleClientRequest.execute() method to invoke the remote operation.

DiscoveryEngine.initialize(com.google.api.client.googleapis.services.AbstractGoogleClientRequest) must be called to initialize this instance immediately after invoking the constructor.

Parameters:

name - Required. Full resource name of Document, such as `projects/{project}/locations/{location}/collectio ns/{collection}/dataStores/{data_store}/branches/{branch}/documents/{document}`. If the caller does not have permission to delete the Document, regardless of whether or not it exists, a `PERMISSION_DENIED` error is returned. If the Document to delete does not exist, a `NOT_FOUND` error is returned.

Since:

1.13

Method Detail

set$Xgafv

public DiscoveryEngine.Projects.Locations.DataStores.Branches.Documents.Delete set$Xgafv(String $Xgafv)

Description copied from class: DiscoveryEngineRequest

V1 error format.

Overrides:

set$Xgafv in class DiscoveryEngineRequest<GoogleProtobufEmpty>

setAccessToken

public DiscoveryEngine.Projects.Locations.DataStores.Branches.Documents.Delete setAccessToken(String accessToken)

Description copied from class: DiscoveryEngineRequest

OAuth access token.

Overrides:

setAccessToken in class DiscoveryEngineRequest<GoogleProtobufEmpty>

setAlt

public DiscoveryEngine.Projects.Locations.DataStores.Branches.Documents.Delete setAlt(String alt)

Description copied from class: DiscoveryEngineRequest

Data format for response.

Overrides:

setAlt in class DiscoveryEngineRequest<GoogleProtobufEmpty>

setCallback

public DiscoveryEngine.Projects.Locations.DataStores.Branches.Documents.Delete setCallback(String callback)

Description copied from class: DiscoveryEngineRequest

JSONP

Overrides:

setCallback in class DiscoveryEngineRequest<GoogleProtobufEmpty>

setFields

public DiscoveryEngine.Projects.Locations.DataStores.Branches.Documents.Delete setFields(String fields)

Description copied from class: DiscoveryEngineRequest

Selector specifying which fields to include in a partial response.

Overrides:

setFields in class DiscoveryEngineRequest<GoogleProtobufEmpty>

setKey

public DiscoveryEngine.Projects.Locations.DataStores.Branches.Documents.Delete setKey(String key)

Description copied from class: DiscoveryEngineRequest

API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.

Overrides:

setKey in class DiscoveryEngineRequest<GoogleProtobufEmpty>

setOauthToken

public DiscoveryEngine.Projects.Locations.DataStores.Branches.Documents.Delete setOauthToken(String oauthToken)

Description copied from class: DiscoveryEngineRequest

OAuth 2.0 token for the current user.

Overrides:

setOauthToken in class DiscoveryEngineRequest<GoogleProtobufEmpty>

setPrettyPrint

public DiscoveryEngine.Projects.Locations.DataStores.Branches.Documents.Delete setPrettyPrint(Boolean prettyPrint)

Description copied from class: DiscoveryEngineRequest

Returns response with indentations and line breaks.

Overrides:

setPrettyPrint in class DiscoveryEngineRequest<GoogleProtobufEmpty>

setQuotaUser

public DiscoveryEngine.Projects.Locations.DataStores.Branches.Documents.Delete setQuotaUser(String quotaUser)

Description copied from class: DiscoveryEngineRequest

Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.

Overrides:

setQuotaUser in class DiscoveryEngineRequest<GoogleProtobufEmpty>

setUploadType

public DiscoveryEngine.Projects.Locations.DataStores.Branches.Documents.Delete setUploadType(String uploadType)

Description copied from class: DiscoveryEngineRequest

Legacy upload protocol for media (e.g. "media", "multipart").

Overrides:

setUploadType in class DiscoveryEngineRequest<GoogleProtobufEmpty>

setUploadProtocol

public DiscoveryEngine.Projects.Locations.DataStores.Branches.Documents.Delete setUploadProtocol(String uploadProtocol)

Description copied from class: DiscoveryEngineRequest

Upload protocol for media (e.g. "raw", "multipart").

Overrides:

setUploadProtocol in class DiscoveryEngineRequest<GoogleProtobufEmpty>

getName

public String getName()

Required. Full resource name of Document, such as `projects/{project}/locations/{location}/collecti ons/{collection}/dataStores/{data_store}/branches/{branch}/documents/{document}`. If the caller does not have permission to delete the Document, regardless of whether or not it exists, a `PERMISSION_DENIED` error is returned. If the Document to delete does not exist, a `NOT_FOUND` error is returned.

setName

public DiscoveryEngine.Projects.Locations.DataStores.Branches.Documents.Delete setName(String name)

Required. Full resource name of Document, such as `projects/{project}/locations/{lo cation}/collections/{collection}/dataStores/{data_store}/branches/{branch}/document s/{document}`. If the caller does not have permission to delete the Document, regardless of whether or not it exists, a `PERMISSION_DENIED` error is returned. If the Document to delete does not exist, a `NOT_FOUND` error is returned.

set

public DiscoveryEngine.Projects.Locations.DataStores.Branches.Documents.Delete set(String parameterName,
                                                                                   Object value)

Overrides:

set in class DiscoveryEngineRequest<GoogleProtobufEmpty>