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.



8558
8559
8560
# File 'lib/google/apis/discoveryengine_v1alpha/classes.rb', line 8558

def initialize(**args)
   update!(**args)
end

Instance Attribute Details

#purge_countFixnum

The total count of documents purged as a result of the operation. Corresponds to the JSON property purgeCount

Returns:

  • (Fixnum)


8549
8550
8551
# File 'lib/google/apis/discoveryengine_v1alpha/classes.rb', line 8549

def purge_count
  @purge_count
end

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


8556
8557
8558
# File 'lib/google/apis/discoveryengine_v1alpha/classes.rb', line 8556

def purge_sample
  @purge_sample
end

Instance Method Details

#update!(**args) ⇒ Object

Update properties of this object



8563
8564
8565
8566
# File 'lib/google/apis/discoveryengine_v1alpha/classes.rb', line 8563

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