Class: Google::Apis::DiscoveryengineV1::GoogleCloudDiscoveryengineV1betaPurgeDocumentsResponse

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

Instance Method Summary collapse

Constructor Details

#initialize(**args) ⇒ GoogleCloudDiscoveryengineV1betaPurgeDocumentsResponse

Returns a new instance of GoogleCloudDiscoveryengineV1betaPurgeDocumentsResponse.



15923
15924
15925
 
# File 'lib/google/apis/discoveryengine_v1/classes.rb', line 15923

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) 


15914
15915
15916
 
# File 'lib/google/apis/discoveryengine_v1/classes.rb', line 15914

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


15921
15922
15923
 
# File 'lib/google/apis/discoveryengine_v1/classes.rb', line 15921

def purge_sample
  @purge_sample
end

Instance Method Details

#update!(**args) ⇒ Object

Update properties of this object



15928
15929
15930
15931
 
# File 'lib/google/apis/discoveryengine_v1/classes.rb', line 15928

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