Reference documentation and code samples for the Google Cloud Discovery Engine V1beta Client class PurgeDocumentsRequest.
Request message for DocumentService.PurgeDocuments method.
Generated from protobuf message google.cloud.discoveryengine.v1beta.PurgeDocumentsRequest
Methods
__construct
Constructor.
data
array
Optional. Data for populating the Message object.
↳ 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).
↳ force
bool
Actually performs the purge. If force
is set to false, return the expected purge count without deleting any documents.
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
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
