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.
Parameters | |
---|---|
Name | Description |
data |
array
Optional. Data for populating the Message object. |
↳ gcs_source |
Google\Cloud\DiscoveryEngine\V1\GcsSource
Cloud Storage location for the input content. Supported |
↳ inline_source |
Google\Cloud\DiscoveryEngine\V1\PurgeDocumentsRequest\InlineSource
Inline source for the input content for purge. |
↳ parent |
string
Required. The parent resource name, such as |
↳ filter |
string
Required. Filter matching documents to purge. Only currently supported value is |
↳ error_config |
Google\Cloud\DiscoveryEngine\V1\PurgeErrorConfig
The desired location of errors incurred during the purge. |
↳ force |
bool
Actually performs the purge. If |
getGcsSource
Cloud Storage location for the input content.
Supported data_schema
:
document_id
: One valid Document.id per line.
Returns | |
---|---|
Type | Description |
Google\Cloud\DiscoveryEngine\V1\GcsSource|null |
hasGcsSource
setGcsSource
Cloud Storage location for the input content.
Supported data_schema
:
document_id
: One valid Document.id per line.
Parameter | |
---|---|
Name | Description |
var |
Google\Cloud\DiscoveryEngine\V1\GcsSource
|
Returns | |
---|---|
Type | Description |
$this |
getInlineSource
Inline source for the input content for purge.
Returns | |
---|---|
Type | Description |
Google\Cloud\DiscoveryEngine\V1\PurgeDocumentsRequest\InlineSource|null |
hasInlineSource
setInlineSource
Inline source for the input content for purge.
Parameter | |
---|---|
Name | Description |
var |
Google\Cloud\DiscoveryEngine\V1\PurgeDocumentsRequest\InlineSource
|
Returns | |
---|---|
Type | Description |
$this |
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 |
getErrorConfig
The desired location of errors incurred during the purge.
Returns | |
---|---|
Type | Description |
Google\Cloud\DiscoveryEngine\V1\PurgeErrorConfig|null |
hasErrorConfig
clearErrorConfig
setErrorConfig
The desired location of errors incurred during the purge.
Parameter | |
---|---|
Name | Description |
var |
Google\Cloud\DiscoveryEngine\V1\PurgeErrorConfig
|
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 |
getSource
Returns | |
---|---|
Type | Description |
string |