Class: Google::Cloud::DiscoveryEngine::V1::PurgeDocumentsRequest

Inherits:
Object
  • Object
show all
Extended by:
Protobuf::MessageExts::ClassMethods
Includes:
Protobuf::MessageExts
Defined in:
proto_docs/google/cloud/discoveryengine/v1/purge_config.rb

Overview

Request message for DocumentService.PurgeDocuments method.

Instance Attribute Summary collapse

Instance Attribute Details

#filter ⇒ ::String

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

Returns:

  • (::String) —

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



40
41
42
43
 
# File 'proto_docs/google/cloud/discoveryengine/v1/purge_config.rb', line 40

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

#force ⇒ ::Boolean

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

Returns:

  • (::Boolean) —

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



40
41
42
43
 
# File 'proto_docs/google/cloud/discoveryengine/v1/purge_config.rb', line 40

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

#parent ⇒ ::String

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

Returns:

  • (::String) —

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



40
41
42
43
 
# File 'proto_docs/google/cloud/discoveryengine/v1/purge_config.rb', line 40

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