Class: Google::Apis::DiscoveryengineV1beta::GoogleCloudDiscoveryengineV1betaPurgeDocumentsResponse

Inherits:
Object
  • Object
show all
Includes:
Core::Hashable, Core::JsonObjectSupport
Defined in:
lib/google/apis/discoveryengine_v1beta/classes.rb,
lib/google/apis/discoveryengine_v1beta/representations.rb,
lib/google/apis/discoveryengine_v1beta/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

Instance Method Summary collapse

Constructor Details

#initialize(**args) ⇒ GoogleCloudDiscoveryengineV1betaPurgeDocumentsResponse

Returns a new instance of GoogleCloudDiscoveryengineV1betaPurgeDocumentsResponse.



6177
6178
6179
 
# File 'lib/google/apis/discoveryengine_v1beta/classes.rb', line 6177

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

Returns:

  • (Fixnum) 


6168
6169
6170
 
# File 'lib/google/apis/discoveryengine_v1beta/classes.rb', line 6168

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

Returns:

  • (Array<String>) 


6175
6176
6177
 
# File 'lib/google/apis/discoveryengine_v1beta/classes.rb', line 6175

def purge_sample
  @purge_sample
end

Instance Method Details

#update!(**args) ⇒ Object

Update properties of this object



6182
6183
6184
6185
 
# File 'lib/google/apis/discoveryengine_v1beta/classes.rb', line 6182

def update!(**args)
  @purge_count = args[:purge_count] if args.key?(:purge_count)
  @purge_sample = args[:purge_sample] if args.key?(:purge_sample)
end