Class: Google::Apis::DiscoveryengineV1::GoogleCloudDiscoveryengineV1PurgeDocumentsResponse
- Inherits:
-
Object
- Object
- Google::Apis::DiscoveryengineV1::GoogleCloudDiscoveryengineV1PurgeDocumentsResponse
- Includes:
- Core::Hashable, Core::JsonObjectSupport
- Defined in:
- lib/google/apis/discoveryengine_v1/classes.rb,
lib/google/apis/discoveryengine_v1/representations.rb,
lib/google/apis/discoveryengine_v1/representations.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 collapse
-
#purge_count ⇒ Fixnum
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 Method Summary collapse
-
#initialize(**args) ⇒ GoogleCloudDiscoveryengineV1PurgeDocumentsResponse
constructor
A new instance of GoogleCloudDiscoveryengineV1PurgeDocumentsResponse.
-
#update!(**args) ⇒ Object
Update properties of this object.
Constructor Details
#initialize(**args) ⇒ GoogleCloudDiscoveryengineV1PurgeDocumentsResponse
Returns a new instance of GoogleCloudDiscoveryengineV1PurgeDocumentsResponse.
5927 5928 5929 |
# File 'lib/google/apis/discoveryengine_v1/classes.rb', line 5927 def initialize(**args) update!(**args) end |
Instance Attribute Details
#purge_count ⇒ Fixnum
The total count of documents purged as a result of the operation.
Corresponds to the JSON property purgeCount
5918 5919 5920 |
# File 'lib/google/apis/discoveryengine_v1/classes.rb', line 5918 def purge_count @purge_count end |
#purge_sample ⇒ 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.
Corresponds to the JSON property purgeSample
5925 5926 5927 |
# File 'lib/google/apis/discoveryengine_v1/classes.rb', line 5925 def purge_sample @purge_sample end |
Instance Method Details
#update!(**args) ⇒ Object
Update properties of this object
5932 5933 5934 5935 |
# File 'lib/google/apis/discoveryengine_v1/classes.rb', line 5932 def update!(**args) @purge_count = args[:purge_count] if args.key?(:purge_count) @purge_sample = args[:purge_sample] if args.key?(:purge_sample) end |