Discovery Engine V1 API - Class Google::Cloud::DiscoveryEngine::V1::PurgeDocumentsResponse (v1.0.2)

Reference documentation and code samples for the Discovery Engine V1 API class Google::Cloud::DiscoveryEngine::V1::PurgeDocumentsResponse.

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

Inherits

  • Object

Extended By

  • Google::Protobuf::MessageExts::ClassMethods

Includes

  • Google::Protobuf::MessageExts

Methods

#purge_count

def purge_count() -> ::Integer
Returns
  • (::Integer) — The total count of documents purged as a result of the operation.

#purge_count=

def purge_count=(value) -> ::Integer
Parameter
  • value (::Integer) — The total count of documents purged as a result of the operation.
Returns
  • (::Integer) — The total count of documents purged as a result of the operation.

#purge_sample

def purge_sample() -> ::Array<::String>
Returns
  • (::Array<::String>) — 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.

#purge_sample=

def purge_sample=(value) -> ::Array<::String>
Parameter
  • value (::Array<::String>) — 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.
Returns
  • (::Array<::String>) — 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.