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
Namespace
Google \ Cloud \ DiscoveryEngine \ V1betaMethods
__construct
Constructor.
Parameters | |
---|---|
Name | Description |
data |
array
Optional. Data for populating the Message object. |
↳ parent |
string
Required. The parent resource name, such as |
↳ filter |
string
Required. Filter matching documents to purge. Only currently supported value is |
↳ force |
bool
Actually performs the purge. If |
getParent
Required. The parent resource name, such as
projects/{project}/locations/{location}/collections/{collection}/dataStores/{data_store}/branches/{branch}
.
Returns | |
---|---|
Type | Description |
string |
setParent
Required. The parent resource name, such as
projects/{project}/locations/{location}/collections/{collection}/dataStores/{data_store}/branches/{branch}
.
Parameter | |
---|---|
Name | Description |
var |
string
|
Returns | |
---|---|
Type | Description |
$this |
getFilter
Required. Filter matching documents to purge. Only currently supported
value is
*
(all items).
Returns | |
---|---|
Type | Description |
string |
setFilter
Required. Filter matching documents to purge. Only currently supported
value is
*
(all items).
Parameter | |
---|---|
Name | Description |
var |
string
|
Returns | |
---|---|
Type | Description |
$this |
getForce
Actually performs the purge. If force
is set to false, return the
expected purge count without deleting any documents.
Returns | |
---|---|
Type | Description |
bool |
setForce
Actually performs the purge. If force
is set to false, return the
expected purge count without deleting any documents.
Parameter | |
---|---|
Name | Description |
var |
bool
|
Returns | |
---|---|
Type | Description |
$this |