Discovery Engine v1beta API - Class PurgeDocumentsResponse (1.0.0-beta15)

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

Reference documentation and code samples for the Discovery Engine v1beta API class PurgeDocumentsResponse.

Response message for [DocumentService.PurgeDocuments][google.cloud.discoveryengine.v1beta.DocumentService.PurgeDocuments] method. If the long running operation is successfully done, then this message is returned by the google.longrunning.Operations.response field.

Inheritance

object > PurgeDocumentsResponse

Namespace

Google.Cloud.DiscoveryEngine.V1Beta

Assembly

Google.Cloud.DiscoveryEngine.V1Beta.dll

Constructors

PurgeDocumentsResponse()

public PurgeDocumentsResponse()

PurgeDocumentsResponse(PurgeDocumentsResponse)

public PurgeDocumentsResponse(PurgeDocumentsResponse other)
Parameter
Name Description
other PurgeDocumentsResponse

Properties

PurgeCount

public long PurgeCount { get; set; }

The total count of documents purged as a result of the operation.

Property Value
Type Description
long

PurgeSample

public RepeatedField<string> PurgeSample { get; }

A sample of document names that will be deleted. Only populated if force is set to false. A max of 100 names will be returned and the names are chosen at random.

Property Value
Type Description
RepeatedFieldstring

PurgeSampleAsDocumentNames

public ResourceNameList<DocumentName> PurgeSampleAsDocumentNames { get; }

DocumentName-typed view over the PurgeSample resource name property.

Property Value
Type Description
ResourceNameListDocumentName