Reference documentation and code samples for the Google Cloud Discovery Engine V1 Client class PurgeDocumentsRequest.
Request message for DocumentService.PurgeDocuments method.
Generated from protobuf message google.cloud.discoveryengine.v1.PurgeDocumentsRequest
Namespace
Google \ Cloud \ DiscoveryEngine \ V1Methods
__construct
Constructor.
data
array
Optional. Data for populating the Message object.
↳ gcs_source
GcsSource
Cloud Storage location for the input content. Supported data_schema
: * * document_id
: One valid Document.id
per line.
↳ inline_source
↳ parent
string
Required. The parent resource name, such as projects/{project}/locations/{location}/collections/{collection}/dataStores/{data_store}/branches/{branch}
.
↳ filter
string
Required. Filter matching documents to purge. Only currently supported value is *
(all items).
↳ error_config
↳ force
bool
Actually performs the purge. If force
is set to false, return the expected purge count without deleting any documents.
getGcsSource
Cloud Storage location for the input content.
Supported data_schema
:
-
document_id: One valid Document.id per line.
hasGcsSource
setGcsSource
Cloud Storage location for the input content.
Supported data_schema
:
-
document_id: One valid Document.id per line.
$this
getInlineSource
Inline source for the input content for purge.
hasInlineSource
setInlineSource
Inline source for the input content for purge.
$this
getParent
Required. The parent resource name, such as projects/{project}/locations/{location}/collections/{collection}/dataStores/{data_store}/branches/{branch}
.
string
setParent
Required. The parent resource name, such as projects/{project}/locations/{location}/collections/{collection}/dataStores/{data_store}/branches/{branch}
.
var
string
$this
getFilter
Required. Filter matching documents to purge. Only currently supported
value is *
(all items).
string
setFilter
Required. Filter matching documents to purge. Only currently supported
value is *
(all items).
var
string
$this
getErrorConfig
The desired location of errors incurred during the purge.
hasErrorConfig
clearErrorConfig
setErrorConfig
The desired location of errors incurred during the purge.
$this
getForce
Actually performs the purge. If force
is set to false, return the
expected purge count without deleting any documents.
bool
setForce
Actually performs the purge. If force
is set to false, return the
expected purge count without deleting any documents.
var
bool
$this
getSource
string
