public sealed class PurgeDocumentsRequest : IMessage<PurgeDocumentsRequest>, IEquatable<PurgeDocumentsRequest>, IDeepCloneable<PurgeDocumentsRequest>, IBufferMessage, IMessageReference documentation and code samples for the Discovery Engine v1beta API class PurgeDocumentsRequest.
Request message for [DocumentService.PurgeDocuments][google.cloud.discoveryengine.v1beta.DocumentService.PurgeDocuments] method.
Implements
IMessagePurgeDocumentsRequest, IEquatablePurgeDocumentsRequest, IDeepCloneablePurgeDocumentsRequest, IBufferMessage, IMessageNamespace
Google.Cloud.DiscoveryEngine.V1BetaAssembly
Google.Cloud.DiscoveryEngine.V1Beta.dll
Constructors
PurgeDocumentsRequest()
public PurgeDocumentsRequest()PurgeDocumentsRequest(PurgeDocumentsRequest)
public PurgeDocumentsRequest(PurgeDocumentsRequest other)| Parameter | |
|---|---|
| Name | Description |
other |
PurgeDocumentsRequest |
Properties
ErrorConfig
public PurgeErrorConfig ErrorConfig { get; set; }The desired location of errors incurred during the purge.
| Property Value | |
|---|---|
| Type | Description |
PurgeErrorConfig |
|
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 |
|
GcsSource
public GcsSource GcsSource { get; set; }Cloud Storage location for the input content.
Supported data_schema:
document_id: One valid [Document.id][google.cloud.discoveryengine.v1beta.Document.id] per line.
| Property Value | |
|---|---|
| Type | Description |
GcsSource |
|
InlineSource
public PurgeDocumentsRequest.Types.InlineSource InlineSource { get; set; }Inline source for the input content for purge.
| Property Value | |
|---|---|
| Type | Description |
PurgeDocumentsRequestTypesInlineSource |
|
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 |
|
SourceCase
public PurgeDocumentsRequest.SourceOneofCase SourceCase { get; }| Property Value | |
|---|---|
| Type | Description |
PurgeDocumentsRequestSourceOneofCase |
|