Reference documentation and code samples for the Storage Batch Operations V1 API class Google::Cloud::StorageBatchOperations::V1::ObjectRetention.
Describes options for object retention update.
Inherits
- Object
Extended By
- Google::Protobuf::MessageExts::ClassMethods
Includes
- Google::Protobuf::MessageExts
Methods
#retain_until_time
def retain_until_time() -> ::String
Returns
- (::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'.
#retain_until_time=
def retain_until_time=(value) -> ::String
Parameter
- value (::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'.
Returns
- (::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
def retention_mode() -> ::Google::Cloud::StorageBatchOperations::V1::ObjectRetention::RetentionMode
Returns
- (::Google::Cloud::StorageBatchOperations::V1::ObjectRetention::RetentionMode) — Required. The retention mode of the object.
#retention_mode=
def retention_mode=(value) -> ::Google::Cloud::StorageBatchOperations::V1::ObjectRetention::RetentionMode
Parameter
- value (::Google::Cloud::StorageBatchOperations::V1::ObjectRetention::RetentionMode) — Required. The retention mode of the object.
Returns
- (::Google::Cloud::StorageBatchOperations::V1::ObjectRetention::RetentionMode) — Required. The retention mode of the object.