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

Inherits:

Object

• Object
• Google::Apis::DiscoveryengineV1alpha::GoogleCloudDiscoveryengineV1alphaPurgeDocumentsRequest

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

• #filter ⇒ String

  Required.

• #force ⇒ Boolean (also: #force?)

  Actually performs the purge.

Instance Method Summary

• #initialize(**args) ⇒ GoogleCloudDiscoveryengineV1alphaPurgeDocumentsRequest constructor

  A new instance of GoogleCloudDiscoveryengineV1alphaPurgeDocumentsRequest.

• #update!(**args) ⇒ Object

  Update properties of this object.

Constructor Details

#initialize(**args) ⇒ GoogleCloudDiscoveryengineV1alphaPurgeDocumentsRequest

Returns a new instance of GoogleCloudDiscoveryengineV1alphaPurgeDocumentsRequest.

# File 'lib/google/apis/discoveryengine_v1alpha/classes.rb', line 4548

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

Instance Attribute Details

#filter ⇒ String

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

Returns:

• (String)

# File 'lib/google/apis/discoveryengine_v1alpha/classes.rb', line 4539

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)

# File 'lib/google/apis/discoveryengine_v1alpha/classes.rb', line 4545

def force
  @force
end

Instance Method Details

#update!(**args) ⇒ Object

Update properties of this object

# File 'lib/google/apis/discoveryengine_v1alpha/classes.rb', line 4553

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