Reference documentation and code samples for the Discovery Engine V1BETA API class Google::Cloud::DiscoveryEngine::V1beta::PurgeDocumentsResponse.
Response message for
DocumentService.PurgeDocuments
method. If the long running operation is successfully done, then this message
is returned by the google.longrunning.Operations.response field.
Inherits
Object
Extended By
Google::Protobuf::MessageExts::ClassMethods
Includes
Google::Protobuf::MessageExts
Methods
#purge_count
defpurge_count()->::Integer
Returns
(::Integer) — The total count of documents purged as a result of the operation.
#purge_count=
defpurge_count=(value)->::Integer
Parameter
value (::Integer) — The total count of documents purged as a result of the operation.
Returns
(::Integer) — The total count of documents purged as a result of the operation.
#purge_sample
defpurge_sample()->::Array<::String>
Returns
(::Array<::String>) — A sample of document names that will be deleted. Only populated if force
is set to false. A max of 100 names will be returned and the names are
chosen at random.
#purge_sample=
defpurge_sample=(value)->::Array<::String>
Parameter
value (::Array<::String>) — A sample of document names that will be deleted. Only populated if force
is set to false. A max of 100 names will be returned and the names are
chosen at random.
Returns
(::Array<::String>) — A sample of document names that will be deleted. Only populated if force
is set to false. A max of 100 names will be returned and the names are
chosen at random.
[[["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::PurgeDocumentsResponse (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-PurgeDocumentsResponse)\n- [0.20.1](/ruby/docs/reference/google-cloud-discovery_engine-v1beta/0.20.1/Google-Cloud-DiscoveryEngine-V1beta-PurgeDocumentsResponse)\n- [0.19.1](/ruby/docs/reference/google-cloud-discovery_engine-v1beta/0.19.1/Google-Cloud-DiscoveryEngine-V1beta-PurgeDocumentsResponse)\n- [0.18.0](/ruby/docs/reference/google-cloud-discovery_engine-v1beta/0.18.0/Google-Cloud-DiscoveryEngine-V1beta-PurgeDocumentsResponse)\n- [0.17.0](/ruby/docs/reference/google-cloud-discovery_engine-v1beta/0.17.0/Google-Cloud-DiscoveryEngine-V1beta-PurgeDocumentsResponse)\n- [0.16.0](/ruby/docs/reference/google-cloud-discovery_engine-v1beta/0.16.0/Google-Cloud-DiscoveryEngine-V1beta-PurgeDocumentsResponse)\n- [0.15.0](/ruby/docs/reference/google-cloud-discovery_engine-v1beta/0.15.0/Google-Cloud-DiscoveryEngine-V1beta-PurgeDocumentsResponse)\n- [0.14.2](/ruby/docs/reference/google-cloud-discovery_engine-v1beta/0.14.2/Google-Cloud-DiscoveryEngine-V1beta-PurgeDocumentsResponse)\n- [0.13.0](/ruby/docs/reference/google-cloud-discovery_engine-v1beta/0.13.0/Google-Cloud-DiscoveryEngine-V1beta-PurgeDocumentsResponse)\n- [0.12.0](/ruby/docs/reference/google-cloud-discovery_engine-v1beta/0.12.0/Google-Cloud-DiscoveryEngine-V1beta-PurgeDocumentsResponse)\n- [0.11.0](/ruby/docs/reference/google-cloud-discovery_engine-v1beta/0.11.0/Google-Cloud-DiscoveryEngine-V1beta-PurgeDocumentsResponse)\n- [0.10.0](/ruby/docs/reference/google-cloud-discovery_engine-v1beta/0.10.0/Google-Cloud-DiscoveryEngine-V1beta-PurgeDocumentsResponse)\n- [0.9.0](/ruby/docs/reference/google-cloud-discovery_engine-v1beta/0.9.0/Google-Cloud-DiscoveryEngine-V1beta-PurgeDocumentsResponse)\n- [0.8.0](/ruby/docs/reference/google-cloud-discovery_engine-v1beta/0.8.0/Google-Cloud-DiscoveryEngine-V1beta-PurgeDocumentsResponse)\n- [0.7.2](/ruby/docs/reference/google-cloud-discovery_engine-v1beta/0.7.2/Google-Cloud-DiscoveryEngine-V1beta-PurgeDocumentsResponse)\n- [0.6.0](/ruby/docs/reference/google-cloud-discovery_engine-v1beta/0.6.0/Google-Cloud-DiscoveryEngine-V1beta-PurgeDocumentsResponse)\n- [0.5.0](/ruby/docs/reference/google-cloud-discovery_engine-v1beta/0.5.0/Google-Cloud-DiscoveryEngine-V1beta-PurgeDocumentsResponse)\n- [0.4.0](/ruby/docs/reference/google-cloud-discovery_engine-v1beta/0.4.0/Google-Cloud-DiscoveryEngine-V1beta-PurgeDocumentsResponse)\n- [0.3.0](/ruby/docs/reference/google-cloud-discovery_engine-v1beta/0.3.0/Google-Cloud-DiscoveryEngine-V1beta-PurgeDocumentsResponse)\n- [0.2.1](/ruby/docs/reference/google-cloud-discovery_engine-v1beta/0.2.1/Google-Cloud-DiscoveryEngine-V1beta-PurgeDocumentsResponse)\n- [0.1.0](/ruby/docs/reference/google-cloud-discovery_engine-v1beta/0.1.0/Google-Cloud-DiscoveryEngine-V1beta-PurgeDocumentsResponse) \nReference documentation and code samples for the Discovery Engine V1BETA API class Google::Cloud::DiscoveryEngine::V1beta::PurgeDocumentsResponse.\n\nResponse 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. If the long running operation is successfully done, then this message\nis returned by the google.longrunning.Operations.response field. \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### #purge_count\n\n def purge_count() -\u003e ::Integer\n\n**Returns**\n\n- (::Integer) --- The total count of documents purged as a result of the operation.\n\n### #purge_count=\n\n def purge_count=(value) -\u003e ::Integer\n\n**Parameter**\n\n- **value** (::Integer) --- The total count of documents purged as a result of the operation. \n**Returns**\n\n- (::Integer) --- The total count of documents purged as a result of the operation.\n\n### #purge_sample\n\n def purge_sample() -\u003e ::Array\u003c::String\u003e\n\n**Returns**\n\n- (::Array\\\u003c::String\\\u003e) --- A sample of document names that will be deleted. Only populated if `force` is set to false. A max of 100 names will be returned and the names are chosen at random.\n\n### #purge_sample=\n\n def purge_sample=(value) -\u003e ::Array\u003c::String\u003e\n\n**Parameter**\n\n- **value** (::Array\\\u003c::String\\\u003e) --- A sample of document names that will be deleted. Only populated if `force` is set to false. A max of 100 names will be returned and the names are chosen at random. \n**Returns**\n\n- (::Array\\\u003c::String\\\u003e) --- A sample of document names that will be deleted. Only populated if `force` is set to false. A max of 100 names will be returned and the names are chosen at random."]]
