Class: Google::Apis::DiscoveryengineV1::GoogleCloudDiscoveryengineV1PurgeDocumentsRequest

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

Request message for DocumentService.PurgeDocuments method.

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(**args) ⇒ GoogleCloudDiscoveryengineV1PurgeDocumentsRequest

Returns a new instance of GoogleCloudDiscoveryengineV1PurgeDocumentsRequest.



5873
5874
5875
 
# File 'lib/google/apis/discoveryengine_v1/classes.rb', line 5873

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

Instance Attribute Details

#error_config ⇒ Google::Apis::DiscoveryengineV1::GoogleCloudDiscoveryengineV1PurgeErrorConfig

Configuration of destination for Purge related errors. Corresponds to the JSON property errorConfig

Returns:



5847
5848
5849
 
# File 'lib/google/apis/discoveryengine_v1/classes.rb', line 5847

def error_config
  @error_config
end

#filter ⇒ String

Required. Filter matching documents to purge. Only currently supported value is * (all items). Corresponds to the JSON property filter

Returns:

  • (String) 


5853
5854
5855
 
# File 'lib/google/apis/discoveryengine_v1/classes.rb', line 5853

def filter
  @filter
end

#force ⇒ Boolean Also known as: force?

Actually performs the purge. If force is set to false, return the expected purge count without deleting any documents. Corresponds to the JSON property force

Returns:

  • (Boolean) 


5859
5860
5861
 
# File 'lib/google/apis/discoveryengine_v1/classes.rb', line 5859

def force
  @force
end

#gcs_source ⇒ Google::Apis::DiscoveryengineV1::GoogleCloudDiscoveryengineV1GcsSource

Cloud Storage location for input content. Corresponds to the JSON property gcsSource

Returns:



5865
5866
5867
 
# File 'lib/google/apis/discoveryengine_v1/classes.rb', line 5865

def gcs_source
  @gcs_source
end

#inline_source ⇒ Google::Apis::DiscoveryengineV1::GoogleCloudDiscoveryengineV1PurgeDocumentsRequestInlineSource

The inline source for the input config for DocumentService.PurgeDocuments method. Corresponds to the JSON property inlineSource

Returns:



5871
5872
5873
 
# File 'lib/google/apis/discoveryengine_v1/classes.rb', line 5871

def inline_source
  @inline_source
end

Instance Method Details

#update!(**args) ⇒ Object

Update properties of this object



5878
5879
5880
5881
5882
5883
5884
 
# File 'lib/google/apis/discoveryengine_v1/classes.rb', line 5878

def update!(**args)
  @error_config = args[:error_config] if args.key?(:error_config)
  @filter = args[:filter] if args.key?(:filter)
  @force = args[:force] if args.key?(:force)
  @gcs_source = args[:gcs_source] if args.key?(:gcs_source)
  @inline_source = args[:inline_source] if args.key?(:inline_source)
end