Class: Google::Apis::DiscoveryengineV1alpha::GoogleCloudDiscoveryengineV1alphaPurgeDocumentsRequest

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

Request message for DocumentService.PurgeDocuments method.

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(**args) ⇒ GoogleCloudDiscoveryengineV1alphaPurgeDocumentsRequest

Returns a new instance of GoogleCloudDiscoveryengineV1alphaPurgeDocumentsRequest.



6941
6942
6943
 
# File 'lib/google/apis/discoveryengine_v1alpha/classes.rb', line 6941

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

Instance Attribute Details

#error_config ⇒ Google::Apis::DiscoveryengineV1alpha::GoogleCloudDiscoveryengineV1alphaPurgeErrorConfig

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

Returns:



6921
6922
6923
 
# File 'lib/google/apis/discoveryengine_v1alpha/classes.rb', line 6921

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) 


6927
6928
6929
 
# File 'lib/google/apis/discoveryengine_v1alpha/classes.rb', line 6927

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) 


6933
6934
6935
 
# File 'lib/google/apis/discoveryengine_v1alpha/classes.rb', line 6933

def force
  @force
end

#gcs_source ⇒ Google::Apis::DiscoveryengineV1alpha::GoogleCloudDiscoveryengineV1alphaGcsSource

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

Returns:



6939
6940
6941
 
# File 'lib/google/apis/discoveryengine_v1alpha/classes.rb', line 6939

def gcs_source
  @gcs_source
end

Instance Method Details

#update!(**args) ⇒ Object

Update properties of this object



6946
6947
6948
6949
6950
6951
 
# File 'lib/google/apis/discoveryengine_v1alpha/classes.rb', line 6946

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