Class: Google::Apis::DiscoveryengineV1alpha::GoogleCloudDiscoveryengineV1betaPurgeDocumentsResponse

Inherits:
Object
  • Object
show all
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

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.



2323
2324
2325
 
# File 'lib/google/apis/discoveryengine_v1alpha/classes.rb', line 2323

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) 


2314
2315
2316
 
# File 'lib/google/apis/discoveryengine_v1alpha/classes.rb', line 2314

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>) 


2321
2322
2323
 
# File 'lib/google/apis/discoveryengine_v1alpha/classes.rb', line 2321

def purge_sample
  @purge_sample
end

Instance Method Details

#update!(**args) ⇒ Object

Update properties of this object



2328
2329
2330
2331
 
# File 'lib/google/apis/discoveryengine_v1alpha/classes.rb', line 2328

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