Reference documentation and code samples for the Discovery Engine V1BETA API class Google::Cloud::DiscoveryEngine::V1beta::PurgeDocumentsRequest.
Request message for DocumentService.PurgeDocuments method.
Inherits
- Object
Extended By
- Google::Protobuf::MessageExts::ClassMethods
Includes
- Google::Protobuf::MessageExts
Methods
#filter
def filter() -> ::String
Returns
-
(::String) — Required. Filter matching documents to purge. Only currently supported
value is
*
(all items).
#filter=
def filter=(value) -> ::String
Parameter
-
value (::String) — 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).
#force
def force() -> ::Boolean
Returns
-
(::Boolean) — Actually performs the purge. If
force
is set to false, return the expected purge count without deleting any documents.
#force=
def force=(value) -> ::Boolean
Parameter
-
value (::Boolean) — 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.
#parent
def parent() -> ::String
Returns
-
(::String) — Required. The parent resource name, such as
projects/{project}/locations/{location}/collections/{collection}/dataStores/{data_store}/branches/{branch}
.
#parent=
def parent=(value) -> ::String
Parameter
-
value (::String) — 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}
.