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 message google.cloud.storagebatchoperations.v1.PutObjectHold
Namespace
Google \ Cloud \ StorageBatchOperations \ V1Methods
__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 |
Enum of type HoldStatus. |
setTemporaryHold
Required. Updates object temporary holds state. When object temporary hold is set, object cannot be deleted or replaced.
| Parameter | |
|---|---|
| Name | Description |
var |
int
Enum of type HoldStatus. |
| 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 |
Enum of type HoldStatus. |
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.
| Parameter | |
|---|---|
| Name | Description |
var |
int
Enum of type HoldStatus. |
| Returns | |
|---|---|
| Type | Description |
$this |
|