Note: The following fields are mutually exclusive: gcs_source, inline_source. If a field in that set is populated, all other fields in the set will automatically be cleared.
Note: The following fields are mutually exclusive: gcs_source, inline_source. If a field in that set is populated, all other fields in the set will automatically be cleared.
Note: The following fields are mutually exclusive: gcs_source, inline_source. If a field in that set is populated, all other fields in the set will automatically be cleared.
Note: The following fields are mutually exclusive: inline_source, gcs_source. If a field in that set is populated, all other fields in the set will automatically be cleared.
Note: The following fields are mutually exclusive: inline_source, gcs_source. If a field in that set is populated, all other fields in the set will automatically be cleared.
Note: The following fields are mutually exclusive: inline_source, gcs_source. If a field in that set is populated, all other fields in the set will automatically be cleared.
#parent
defparent()->::String
Returns
(::String) — Required. The parent resource name, such as
projects/{project}/locations/{location}/collections/{collection}/dataStores/{data_store}/branches/{branch}.
#parent=
defparent=(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}.
[[["Easy to understand","easyToUnderstand","thumb-up"],["Solved my problem","solvedMyProblem","thumb-up"],["Other","otherUp","thumb-up"]],[["Hard to understand","hardToUnderstand","thumb-down"],["Incorrect information or sample code","incorrectInformationOrSampleCode","thumb-down"],["Missing the information/samples I need","missingTheInformationSamplesINeed","thumb-down"],["Other","otherDown","thumb-down"]],["Last updated 2025-09-04 UTC."],[],[],null,["# Discovery Engine V1BETA API - Class Google::Cloud::DiscoveryEngine::V1beta::PurgeDocumentsRequest (v0.21.0)\n\nVersion latestkeyboard_arrow_down\n\n- [0.21.0 (latest)](/ruby/docs/reference/google-cloud-discovery_engine-v1beta/latest/Google-Cloud-DiscoveryEngine-V1beta-PurgeDocumentsRequest)\n- [0.20.1](/ruby/docs/reference/google-cloud-discovery_engine-v1beta/0.20.1/Google-Cloud-DiscoveryEngine-V1beta-PurgeDocumentsRequest)\n- [0.19.1](/ruby/docs/reference/google-cloud-discovery_engine-v1beta/0.19.1/Google-Cloud-DiscoveryEngine-V1beta-PurgeDocumentsRequest)\n- [0.18.0](/ruby/docs/reference/google-cloud-discovery_engine-v1beta/0.18.0/Google-Cloud-DiscoveryEngine-V1beta-PurgeDocumentsRequest)\n- [0.17.0](/ruby/docs/reference/google-cloud-discovery_engine-v1beta/0.17.0/Google-Cloud-DiscoveryEngine-V1beta-PurgeDocumentsRequest)\n- [0.16.0](/ruby/docs/reference/google-cloud-discovery_engine-v1beta/0.16.0/Google-Cloud-DiscoveryEngine-V1beta-PurgeDocumentsRequest)\n- [0.15.0](/ruby/docs/reference/google-cloud-discovery_engine-v1beta/0.15.0/Google-Cloud-DiscoveryEngine-V1beta-PurgeDocumentsRequest)\n- [0.14.2](/ruby/docs/reference/google-cloud-discovery_engine-v1beta/0.14.2/Google-Cloud-DiscoveryEngine-V1beta-PurgeDocumentsRequest)\n- [0.13.0](/ruby/docs/reference/google-cloud-discovery_engine-v1beta/0.13.0/Google-Cloud-DiscoveryEngine-V1beta-PurgeDocumentsRequest)\n- [0.12.0](/ruby/docs/reference/google-cloud-discovery_engine-v1beta/0.12.0/Google-Cloud-DiscoveryEngine-V1beta-PurgeDocumentsRequest)\n- [0.11.0](/ruby/docs/reference/google-cloud-discovery_engine-v1beta/0.11.0/Google-Cloud-DiscoveryEngine-V1beta-PurgeDocumentsRequest)\n- [0.10.0](/ruby/docs/reference/google-cloud-discovery_engine-v1beta/0.10.0/Google-Cloud-DiscoveryEngine-V1beta-PurgeDocumentsRequest)\n- [0.9.0](/ruby/docs/reference/google-cloud-discovery_engine-v1beta/0.9.0/Google-Cloud-DiscoveryEngine-V1beta-PurgeDocumentsRequest)\n- [0.8.0](/ruby/docs/reference/google-cloud-discovery_engine-v1beta/0.8.0/Google-Cloud-DiscoveryEngine-V1beta-PurgeDocumentsRequest)\n- [0.7.2](/ruby/docs/reference/google-cloud-discovery_engine-v1beta/0.7.2/Google-Cloud-DiscoveryEngine-V1beta-PurgeDocumentsRequest)\n- [0.6.0](/ruby/docs/reference/google-cloud-discovery_engine-v1beta/0.6.0/Google-Cloud-DiscoveryEngine-V1beta-PurgeDocumentsRequest)\n- [0.5.0](/ruby/docs/reference/google-cloud-discovery_engine-v1beta/0.5.0/Google-Cloud-DiscoveryEngine-V1beta-PurgeDocumentsRequest)\n- [0.4.0](/ruby/docs/reference/google-cloud-discovery_engine-v1beta/0.4.0/Google-Cloud-DiscoveryEngine-V1beta-PurgeDocumentsRequest)\n- [0.3.0](/ruby/docs/reference/google-cloud-discovery_engine-v1beta/0.3.0/Google-Cloud-DiscoveryEngine-V1beta-PurgeDocumentsRequest)\n- [0.2.1](/ruby/docs/reference/google-cloud-discovery_engine-v1beta/0.2.1/Google-Cloud-DiscoveryEngine-V1beta-PurgeDocumentsRequest)\n- [0.1.0](/ruby/docs/reference/google-cloud-discovery_engine-v1beta/0.1.0/Google-Cloud-DiscoveryEngine-V1beta-PurgeDocumentsRequest) \nReference documentation and code samples for the Discovery Engine V1BETA API class Google::Cloud::DiscoveryEngine::V1beta::PurgeDocumentsRequest.\n\nRequest message for\n[DocumentService.PurgeDocuments](/ruby/docs/reference/google-cloud-discovery_engine-v1beta/latest/Google-Cloud-DiscoveryEngine-V1beta-DocumentService-Client#Google__Cloud__DiscoveryEngine__V1beta__DocumentService__Client_purge_documents_instance_ \"Google::Cloud::DiscoveryEngine::V1beta::DocumentService::Client#purge_documents (method)\")\nmethod. \n\nInherits\n--------\n\n- Object \n\nExtended By\n-----------\n\n- Google::Protobuf::MessageExts::ClassMethods \n\nIncludes\n--------\n\n- Google::Protobuf::MessageExts\n\nMethods\n-------\n\n### #error_config\n\n def error_config() -\u003e ::Google::Cloud::DiscoveryEngine::V1beta::PurgeErrorConfig\n\n**Returns**\n\n- ([::Google::Cloud::DiscoveryEngine::V1beta::PurgeErrorConfig](./Google-Cloud-DiscoveryEngine-V1beta-PurgeErrorConfig)) --- The desired location of errors incurred during the purge.\n\n### #error_config=\n\n def error_config=(value) -\u003e ::Google::Cloud::DiscoveryEngine::V1beta::PurgeErrorConfig\n\n**Parameter**\n\n- **value** ([::Google::Cloud::DiscoveryEngine::V1beta::PurgeErrorConfig](./Google-Cloud-DiscoveryEngine-V1beta-PurgeErrorConfig)) --- The desired location of errors incurred during the purge. \n**Returns**\n\n- ([::Google::Cloud::DiscoveryEngine::V1beta::PurgeErrorConfig](./Google-Cloud-DiscoveryEngine-V1beta-PurgeErrorConfig)) --- The desired location of errors incurred during the purge.\n\n### #filter\n\n def filter() -\u003e ::String\n\n**Returns**\n\n- (::String) --- Required. Filter matching documents to purge. Only currently supported value is `*` (all items).\n\n### #filter=\n\n def filter=(value) -\u003e ::String\n\n**Parameter**\n\n- **value** (::String) --- Required. Filter matching documents to purge. Only currently supported value is `*` (all items). \n**Returns**\n\n- (::String) --- Required. Filter matching documents to purge. Only currently supported value is `*` (all items).\n\n### #force\n\n def force() -\u003e ::Boolean\n\n**Returns**\n\n- (::Boolean) --- Actually performs the purge. If `force` is set to false, return the expected purge count without deleting any documents.\n\n### #force=\n\n def force=(value) -\u003e ::Boolean\n\n**Parameter**\n\n- **value** (::Boolean) --- Actually performs the purge. If `force` is set to false, return the expected purge count without deleting any documents. \n**Returns**\n\n- (::Boolean) --- Actually performs the purge. If `force` is set to false, return the expected purge count without deleting any documents.\n\n### #gcs_source\n\n def gcs_source() -\u003e ::Google::Cloud::DiscoveryEngine::V1beta::GcsSource\n\n**Returns**\n\n- ([::Google::Cloud::DiscoveryEngine::V1beta::GcsSource](./Google-Cloud-DiscoveryEngine-V1beta-GcsSource)) --- Cloud Storage location for the input content. Supported `data_schema`:\n\n\n - `document_id`: One valid [Document.id](/ruby/docs/reference/google-cloud-discovery_engine-v1beta/latest/Google-Cloud-DiscoveryEngine-V1beta-Document#Google__Cloud__DiscoveryEngine__V1beta__Document_id_instance_ \"Google::Cloud::DiscoveryEngine::V1beta::Document#id (method)\") per line.\n\n Note: The following fields are mutually exclusive: `gcs_source`, `inline_source`. If a field in that set is populated, all other fields in the set will automatically be cleared.\n\n### #gcs_source=\n\n def gcs_source=(value) -\u003e ::Google::Cloud::DiscoveryEngine::V1beta::GcsSource\n\n**Parameter**\n\n- **value** ([::Google::Cloud::DiscoveryEngine::V1beta::GcsSource](./Google-Cloud-DiscoveryEngine-V1beta-GcsSource)) --- Cloud Storage location for the input content. Supported `data_schema`:\n\n\n - `document_id`: One valid [Document.id](/ruby/docs/reference/google-cloud-discovery_engine-v1beta/latest/Google-Cloud-DiscoveryEngine-V1beta-Document#Google__Cloud__DiscoveryEngine__V1beta__Document_id_instance_ \"Google::Cloud::DiscoveryEngine::V1beta::Document#id (method)\") per line.\n\nNote: The following fields are mutually exclusive: `gcs_source`, `inline_source`. If a field in that set is populated, all other fields in the set will automatically be cleared. \n**Returns**\n\n- ([::Google::Cloud::DiscoveryEngine::V1beta::GcsSource](./Google-Cloud-DiscoveryEngine-V1beta-GcsSource)) --- Cloud Storage location for the input content. Supported `data_schema`:\n\n\n - `document_id`: One valid [Document.id](/ruby/docs/reference/google-cloud-discovery_engine-v1beta/latest/Google-Cloud-DiscoveryEngine-V1beta-Document#Google__Cloud__DiscoveryEngine__V1beta__Document_id_instance_ \"Google::Cloud::DiscoveryEngine::V1beta::Document#id (method)\") per line.\n\n Note: The following fields are mutually exclusive: `gcs_source`, `inline_source`. If a field in that set is populated, all other fields in the set will automatically be cleared.\n\n### #inline_source\n\n def inline_source() -\u003e ::Google::Cloud::DiscoveryEngine::V1beta::PurgeDocumentsRequest::InlineSource\n\n**Returns**\n\n- ([::Google::Cloud::DiscoveryEngine::V1beta::PurgeDocumentsRequest::InlineSource](./Google-Cloud-DiscoveryEngine-V1beta-PurgeDocumentsRequest-InlineSource)) --- Inline source for the input content for purge.\n\n\n Note: The following fields are mutually exclusive: `inline_source`, `gcs_source`. If a field in that set is populated, all other fields in the set will automatically be cleared.\n\n### #inline_source=\n\n def inline_source=(value) -\u003e ::Google::Cloud::DiscoveryEngine::V1beta::PurgeDocumentsRequest::InlineSource\n\n**Parameter**\n\n- **value** ([::Google::Cloud::DiscoveryEngine::V1beta::PurgeDocumentsRequest::InlineSource](./Google-Cloud-DiscoveryEngine-V1beta-PurgeDocumentsRequest-InlineSource)) --- Inline source for the input content for purge.\n\n\nNote: The following fields are mutually exclusive: `inline_source`, `gcs_source`. If a field in that set is populated, all other fields in the set will automatically be cleared. \n**Returns**\n\n- ([::Google::Cloud::DiscoveryEngine::V1beta::PurgeDocumentsRequest::InlineSource](./Google-Cloud-DiscoveryEngine-V1beta-PurgeDocumentsRequest-InlineSource)) --- Inline source for the input content for purge.\n\n\n Note: The following fields are mutually exclusive: `inline_source`, `gcs_source`. If a field in that set is populated, all other fields in the set will automatically be cleared.\n\n### #parent\n\n def parent() -\u003e ::String\n\n**Returns**\n\n- (::String) --- Required. The parent resource name, such as `projects/{project}/locations/{location}/collections/{collection}/dataStores/{data_store}/branches/{branch}`.\n\n### #parent=\n\n def parent=(value) -\u003e ::String\n\n**Parameter**\n\n- **value** (::String) --- Required. The parent resource name, such as `projects/{project}/locations/{location}/collections/{collection}/dataStores/{data_store}/branches/{branch}`. \n**Returns**\n\n- (::String) --- Required. The parent resource name, such as `projects/{project}/locations/{location}/collections/{collection}/dataStores/{data_store}/branches/{branch}`."]]
