Class: Google::Apis::DiscoveryengineV1alpha::GoogleCloudDiscoveryengineV1alphaPurgeDocumentsRequest
- Inherits:
-
Object
- Object
- Google::Apis::DiscoveryengineV1alpha::GoogleCloudDiscoveryengineV1alphaPurgeDocumentsRequest
- Includes:
- Core::Hashable, Core::JsonObjectSupport
- Defined in:
- lib/google/apis/discoveryengine_v1alpha/classes.rb,
lib/google/apis/discoveryengine_v1alpha/representations.rb,
lib/google/apis/discoveryengine_v1alpha/representations.rb
Overview
Request message for DocumentService.PurgeDocuments method.
Instance Attribute Summary collapse
-
#filter ⇒ String
Required.
-
#force ⇒ Boolean
(also: #force?)
Actually performs the purge.
Instance Method Summary collapse
-
#initialize(**args) ⇒ GoogleCloudDiscoveryengineV1alphaPurgeDocumentsRequest
constructor
A new instance of GoogleCloudDiscoveryengineV1alphaPurgeDocumentsRequest.
-
#update!(**args) ⇒ Object
Update properties of this object.
Constructor Details
#initialize(**args) ⇒ GoogleCloudDiscoveryengineV1alphaPurgeDocumentsRequest
Returns a new instance of GoogleCloudDiscoveryengineV1alphaPurgeDocumentsRequest.
1046 1047 1048 |
# File 'lib/google/apis/discoveryengine_v1alpha/classes.rb', line 1046 def initialize(**args) update!(**args) end |
Instance Attribute Details
#filter ⇒ String
Required. Filter matching documents to purge. Only currently supported value
is *
(all items).
Corresponds to the JSON property filter
1037 1038 1039 |
# File 'lib/google/apis/discoveryengine_v1alpha/classes.rb', line 1037 def filter @filter end |
#force ⇒ Boolean Also known as: force?
Actually performs the purge. If force
is set to false, return the expected
purge count without deleting any documents.
Corresponds to the JSON property force
1043 1044 1045 |
# File 'lib/google/apis/discoveryengine_v1alpha/classes.rb', line 1043 def force @force end |
Instance Method Details
#update!(**args) ⇒ Object
Update properties of this object
1051 1052 1053 1054 |
# File 'lib/google/apis/discoveryengine_v1alpha/classes.rb', line 1051 def update!(**args) @filter = args[:filter] if args.key?(:filter) @force = args[:force] if args.key?(:force) end |