Discovery Engine V1 API - Class Google::Cloud::DiscoveryEngine::V1::PurgeDocumentsRequest (v1.2.0)

Reference documentation and code samples for the Discovery Engine V1 API class Google::Cloud::DiscoveryEngine::V1::PurgeDocumentsRequest.

Request message for DocumentService.PurgeDocuments method.

Inherits

Object

Extended By

Google::Protobuf::MessageExts::ClassMethods

Includes

Google::Protobuf::MessageExts

Methods

#error_config

def error_config() -> ::Google::Cloud::DiscoveryEngine::V1::PurgeErrorConfig

Returns

(::Google::Cloud::DiscoveryEngine::V1::PurgeErrorConfig) — The desired location of errors incurred during the purge.

#error_config=

def error_config=(value) -> ::Google::Cloud::DiscoveryEngine::V1::PurgeErrorConfig

Parameter

value (::Google::Cloud::DiscoveryEngine::V1::PurgeErrorConfig) — The desired location of errors incurred during the purge.

Returns

(::Google::Cloud::DiscoveryEngine::V1::PurgeErrorConfig) — The desired location of errors incurred during the purge.

#filter

def filter() -> ::String

Returns

(::String) — Required. Filter matching documents to purge. Only currently supported value is * (all items).

#filter=

def filter=(value) -> ::String

Parameter

value (::String) — Required. Filter matching documents to purge. Only currently supported value is * (all items).

Returns

(::String) — Required. Filter matching documents to purge. Only currently supported value is * (all items).

#force

def force() -> ::Boolean

Returns

(::Boolean) — Actually performs the purge. If force is set to false, return the expected purge count without deleting any documents.

#force=

def force=(value) -> ::Boolean

Parameter

value (::Boolean) — Actually performs the purge. If force is set to false, return the expected purge count without deleting any documents.

Returns

(::Boolean) — Actually performs the purge. If force is set to false, return the expected purge count without deleting any documents.

#gcs_source

def gcs_source() -> ::Google::Cloud::DiscoveryEngine::V1::GcsSource

Returns

(::Google::Cloud::DiscoveryEngine::V1::GcsSource) —
Cloud Storage location for the input content. Supported data_schema:
- document_id: One valid Document.id per line.

#gcs_source=

def gcs_source=(value) -> ::Google::Cloud::DiscoveryEngine::V1::GcsSource

Parameter

value (::Google::Cloud::DiscoveryEngine::V1::GcsSource) —
Cloud Storage location for the input content. Supported data_schema:
- document_id: One valid Document.id per line.

Returns

(::Google::Cloud::DiscoveryEngine::V1::GcsSource) —
Cloud Storage location for the input content. Supported data_schema:
- document_id: One valid Document.id per line.

#inline_source

def inline_source() -> ::Google::Cloud::DiscoveryEngine::V1::PurgeDocumentsRequest::InlineSource

Returns

(::Google::Cloud::DiscoveryEngine::V1::PurgeDocumentsRequest::InlineSource) — Inline source for the input content for purge.

#inline_source=

def inline_source=(value) -> ::Google::Cloud::DiscoveryEngine::V1::PurgeDocumentsRequest::InlineSource

Parameter

value (::Google::Cloud::DiscoveryEngine::V1::PurgeDocumentsRequest::InlineSource) — Inline source for the input content for purge.

Returns

(::Google::Cloud::DiscoveryEngine::V1::PurgeDocumentsRequest::InlineSource) — Inline source for the input content for purge.

#parent

def parent() -> ::String

Returns

(::String) — Required. The parent resource name, such as projects/{project}/locations/{location}/collections/{collection}/dataStores/{data_store}/branches/{branch}.

#parent=

def parent=(value) -> ::String

Parameter

value (::String) — Required. The parent resource name, such as projects/{project}/locations/{location}/collections/{collection}/dataStores/{data_store}/branches/{branch}.

Returns

(::String) — Required. The parent resource name, such as projects/{project}/locations/{location}/collections/{collection}/dataStores/{data_store}/branches/{branch}.