Discovery Engine v1 API - Class PurgeDocumentsRequest (1.0.0-beta05)

public sealed class PurgeDocumentsRequest : IMessage<PurgeDocumentsRequest>, IEquatable<PurgeDocumentsRequest>, IDeepCloneable<PurgeDocumentsRequest>, IBufferMessage, IMessage

Reference documentation and code samples for the Discovery Engine v1 API class PurgeDocumentsRequest.

Request message for [DocumentService.PurgeDocuments][google.cloud.discoveryengine.v1.DocumentService.PurgeDocuments] method.

Inheritance

object > PurgeDocumentsRequest

Implements

IMessage PurgeDocumentsRequest, IEquatable PurgeDocumentsRequest, IDeepCloneable PurgeDocumentsRequest, IBufferMessage, IMessage

Inherited Members

object.GetHashCode()

object.GetType()

object.ToString()

Namespace

Google.Cloud.DiscoveryEngine.V1

Assembly

Google.Cloud.DiscoveryEngine.V1.dll

Constructors

PurgeDocumentsRequest()

public PurgeDocumentsRequest()

PurgeDocumentsRequest(PurgeDocumentsRequest)

public PurgeDocumentsRequest(PurgeDocumentsRequest other)

Parameter
Name	Description
`other`	`PurgeDocumentsRequest`

Properties

Filter

public string Filter { get; set; }

Required. Filter matching documents to purge. Only currently supported value is * (all items).

Property Value
Type	Description
`string`

Force

public bool Force { get; set; }

Actually performs the purge. If force is set to false, return the expected purge count without deleting any documents.

Property Value
Type	Description
`bool`

Parent

public string Parent { get; set; }

Required. The parent resource name, such as projects/{project}/locations/{location}/collections/{collection}/dataStores/{data_store}/branches/{branch}.

Property Value
Type	Description
`string`

ParentAsBranchName

public BranchName ParentAsBranchName { get; set; }

BranchName-typed view over the Parent resource name property.

Property Value
Type	Description
`BranchName`