Reference documentation and code samples for the Google Cloud Storage Batch Operations V1 Client class PutObjectHold.
Describes options to update object hold.
Generated from protobuf messagegoogle.cloud.storagebatchoperations.v1.PutObjectHold
Namespace
Google \ Cloud \ StorageBatchOperations \ V1
Methods
__construct
Constructor.
Parameters
Name
Description
data
array
Optional. Data for populating the Message object.
↳ temporary_hold
int
Required. Updates object temporary holds state. When object temporary hold is set, object cannot be deleted or replaced.
↳ event_based_hold
int
Required. Updates object event based holds state. When object event based hold is set, object cannot be deleted or replaced. Resets object's time in the bucket for the purposes of the retention period.
getTemporaryHold
Required. Updates object temporary holds state. When object temporary hold
is set, object cannot be deleted or replaced.
Returns
Type
Description
int
setTemporaryHold
Required. Updates object temporary holds state. When object temporary hold
is set, object cannot be deleted or replaced.
Parameter
Name
Description
var
int
Returns
Type
Description
$this
getEventBasedHold
Required. Updates object event based holds state. When object event based
hold is set, object cannot be deleted or replaced. Resets object's time in
the bucket for the purposes of the retention period.
Returns
Type
Description
int
setEventBasedHold
Required. Updates object event based holds state. When object event based
hold is set, object cannot be deleted or replaced. Resets object's time in
the bucket for the purposes of the retention period.
[[["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,["# Google Cloud Storage Batch Operations V1 Client - Class PutObjectHold (0.1.2)\n\nVersion latestkeyboard_arrow_down\n\n- [0.1.2 (latest)](/php/docs/reference/cloud-storagebatchoperations/latest/V1.PutObjectHold)\n- [0.1.1](/php/docs/reference/cloud-storagebatchoperations/0.1.1/V1.PutObjectHold) \nReference documentation and code samples for the Google Cloud Storage Batch Operations V1 Client class PutObjectHold.\n\nDescribes options to update object hold.\n\nGenerated from protobuf message `google.cloud.storagebatchoperations.v1.PutObjectHold`\n\nNamespace\n---------\n\nGoogle \\\\ Cloud \\\\ StorageBatchOperations \\\\ V1\n\nMethods\n-------\n\n### __construct\n\nConstructor.\n\n### getTemporaryHold\n\nRequired. Updates object temporary holds state. When object temporary hold\nis set, object cannot be deleted or replaced.\n\n### setTemporaryHold\n\nRequired. Updates object temporary holds state. When object temporary hold\nis set, object cannot be deleted or replaced.\n\n### getEventBasedHold\n\nRequired. Updates object event based holds state. When object event based\nhold is set, object cannot be deleted or replaced. Resets object's time in\nthe bucket for the purposes of the retention period.\n\n### setEventBasedHold\n\nRequired. Updates object event based holds state. When object event based\nhold is set, object cannot be deleted or replaced. Resets object's time in\nthe bucket for the purposes of the retention period."]]
