Google Cloud Storage Batch Operations V1 Client - Class ObjectRetention (0.3.0)

Reference documentation and code samples for the Google Cloud Storage Batch Operations V1 Client class ObjectRetention.

Describes options for object retention update.

Generated from protobuf message google.cloud.storagebatchoperations.v1.ObjectRetention

Namespace

Google \ Cloud \ StorageBatchOperations \ V1

Methods

__construct

Constructor.

Parameters
Name
Description
data
array

Optional. Data for populating the Message object.

↳ retain_until_time
string

Required. The time when the object will be retained until. UNSET will clear the retention. Must be specified in RFC 3339 format e.g. YYYY-MM-DD'T'HH:MM:SS.SS'Z' or YYYY-MM-DD'T'HH:MM:SS'Z'.

↳ retention_mode
int

Required. The retention mode of the object.

getRetainUntilTime

Required. The time when the object will be retained until. UNSET will clear the retention. Must be specified in RFC 3339 format e.g.

YYYY-MM-DD'T'HH:MM:SS.SS'Z' or YYYY-MM-DD'T'HH:MM:SS'Z'.

Returns
Type
Description
string

hasRetainUntilTime

clearRetainUntilTime

setRetainUntilTime

Required. The time when the object will be retained until. UNSET will clear the retention. Must be specified in RFC 3339 format e.g.

YYYY-MM-DD'T'HH:MM:SS.SS'Z' or YYYY-MM-DD'T'HH:MM:SS'Z'.

Parameter
Name
Description
var
string
Returns
Type
Description
$this

getRetentionMode

Required. The retention mode of the object.

Returns
Type
Description
int

hasRetentionMode

clearRetentionMode

setRetentionMode

Required. The retention mode of the object.

Parameter
Name
Description
var
int
Returns
Type
Description
$this
Design a Mobile Site
View Site in Mobile | Classic
Share by: