Google Cloud Discovery Engine V1beta Client - Class PurgeDocumentsRequest (0.7.1)

Version 0.7.1

• 1.3.1 (latest)
• 1.3.0
• 1.2.0
• 1.1.0
• 1.0.0
• 0.11.3
• 0.8.0
• 0.7.1
• 0.6.0
• 0.5.0
• 0.4.0
• 0.3.0
• 0.2.0
• 0.1.1

Beta

This library is covered by the Pre-GA Offerings Terms of the Terms of Service. Pre-GA libraries might have limited support, and changes to pre-GA libraries might not be compatible with other pre-GA versions. For more information, see the launch stage descriptions.

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 \ V1beta

Methods

__construct

Constructor.

Parameters
Name	Description
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}.

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