Reference documentation and code samples for the Google Cloud Storage Batch Operations V1 Client class DeleteObject.
Describes options to delete an object.
Generated from protobuf message google.cloud.storagebatchoperations.v1.DeleteObject
Namespace
Google \ Cloud \ StorageBatchOperations \ V1
Methods
__construct
Constructor.
Parameters
Name
Description
data
array
Optional. Data for populating the Message object.
↳ permanent_object_deletion_enabled
bool
Required. Controls deletion behavior when versioning is enabled for the object's bucket. If true both live and noncurrent objects will be permanently deleted. Otherwise live objects in versioned buckets will become noncurrent and objects that were already noncurrent will be skipped. This setting doesn't have any impact on the Soft Delete feature. All objects deleted by this service can be be restored for the duration of the Soft Delete retention duration if enabled. If enabled and the manifest doesn't specify an object's generation, a GetObjectMetadata call (a Class B operation) will be made to determine the live object generation.
getPermanentObjectDeletionEnabled
Required. Controls deletion behavior when versioning is enabled for the
object's bucket. If true both live and noncurrent objects will be
permanently deleted. Otherwise live objects in versioned buckets will
become noncurrent and objects that were already noncurrent will be skipped.
This setting doesn't have any impact on the Soft Delete feature. All
objects deleted by this service can be be restored for the duration of the
Soft Delete retention duration if enabled. If enabled and the manifest
doesn't specify an object's generation, a GetObjectMetadata call (a Class B
operation) will be made to determine the live object generation.
Returns
Type
Description
bool
setPermanentObjectDeletionEnabled
Required. Controls deletion behavior when versioning is enabled for the
object's bucket. If true both live and noncurrent objects will be
permanently deleted. Otherwise live objects in versioned buckets will
become noncurrent and objects that were already noncurrent will be skipped.
This setting doesn't have any impact on the Soft Delete feature. All
objects deleted by this service can be be restored for the duration of the
Soft Delete retention duration if enabled. If enabled and the manifest
doesn't specify an object's generation, a GetObjectMetadata call (a Class B
operation) will be made to determine the live object generation.
[[["Easy to understand","easyToUnderstand","thumb-up"],["Solved my problem","solvedMyProblem","thumb-up"],["Other","otherUp","thumb-up"]],[["Missing the information I need","missingTheInformationINeed","thumb-down"],["Too complicated / too many steps","tooComplicatedTooManySteps","thumb-down"],["Out of date","outOfDate","thumb-down"],["Samples / code issue","samplesCodeIssue","thumb-down"],["Other","otherDown","thumb-down"]],["Last updated 2025-08-28 UTC."],[],[],null,["# Google Cloud Storage Batch Operations V1 Client - Class DeleteObject (0.1.2)\n\nVersion latestkeyboard_arrow_down\n\n- [0.1.2 (latest)](/php/docs/reference/cloud-storagebatchoperations/latest/V1.DeleteObject)\n- [0.1.1](/php/docs/reference/cloud-storagebatchoperations/0.1.1/V1.DeleteObject) \nReference documentation and code samples for the Google Cloud Storage Batch Operations V1 Client class DeleteObject.\n\nDescribes options to delete an object.\n\nGenerated from protobuf message `google.cloud.storagebatchoperations.v1.DeleteObject`\n\nNamespace\n---------\n\nGoogle \\\\ Cloud \\\\ StorageBatchOperations \\\\ V1\n\nMethods\n-------\n\n### __construct\n\nConstructor.\n\n### getPermanentObjectDeletionEnabled\n\nRequired. Controls deletion behavior when versioning is enabled for the\nobject's bucket. If true both live and noncurrent objects will be\npermanently deleted. Otherwise live objects in versioned buckets will\nbecome noncurrent and objects that were already noncurrent will be skipped.\n\nThis setting doesn't have any impact on the Soft Delete feature. All\nobjects deleted by this service can be be restored for the duration of the\nSoft Delete retention duration if enabled. If enabled and the manifest\ndoesn't specify an object's generation, a GetObjectMetadata call (a Class B\noperation) will be made to determine the live object generation.\n\n### setPermanentObjectDeletionEnabled\n\nRequired. Controls deletion behavior when versioning is enabled for the\nobject's bucket. If true both live and noncurrent objects will be\npermanently deleted. Otherwise live objects in versioned buckets will\nbecome noncurrent and objects that were already noncurrent will be skipped.\n\nThis setting doesn't have any impact on the Soft Delete feature. All\nobjects deleted by this service can be be restored for the duration of the\nSoft Delete retention duration if enabled. If enabled and the manifest\ndoesn't specify an object's generation, a GetObjectMetadata call (a Class B\noperation) will be made to determine the live object generation."]]
