Class: Google::Cloud::DiscoveryEngine::V1::PurgeDocumentsResponse

Inherits:

Object

• Object
• Google::Cloud::DiscoveryEngine::V1::PurgeDocumentsResponse

Extended by:

Protobuf::MessageExts::ClassMethods

Includes:

Protobuf::MessageExts

Defined in:

proto_docs/google/cloud/discoveryengine/v1/purge_config.rb

Overview

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.

Instance Attribute Summary

• #purge_count ⇒ ::Integer

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

• #purge_sample ⇒ ::Array<::String>

  A sample of document names that will be deleted.

Instance Attribute Details

#purge_count ⇒ ::Integer

Returns 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.

# File 'proto_docs/google/cloud/discoveryengine/v1/purge_config.rb', line 172

class PurgeDocumentsResponse
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods
end

#purge_sample ⇒ ::Array<::String>

Returns 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.

# File 'proto_docs/google/cloud/discoveryengine/v1/purge_config.rb', line 172

class PurgeDocumentsResponse
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods
end