Class: Google::Cloud::StorageBatchOperations::V1::ObjectRetention

Inherits:

Object

Object
Google::Cloud::StorageBatchOperations::V1::ObjectRetention

show all

Extended by:: Protobuf::MessageExts::ClassMethods

Includes:: Protobuf::MessageExts

Defined in:: proto_docs/google/cloud/storagebatchoperations/v1/storage_batch_operations_types.rb

Overview

Describes options for object retention update.

Defined Under Namespace

Modules: RetentionMode

Instance Attribute Summary collapse

Instance Attribute Details

#retain_until_time ⇒ `::String`

Returns 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'.

# File 'proto_docs/google/cloud/storagebatchoperations/v1/storage_batch_operations_types.rb', line 242

class ObjectRetention
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods

  # Describes the retention mode.
  module RetentionMode
    # If set and retain_until_time is empty, clears the retention.
    RETENTION_MODE_UNSPECIFIED = 0

    # Sets the retention mode to locked.
    LOCKED = 1

    # Sets the retention mode to unlocked.
    UNLOCKED = 2
  end
end

#retention_mode ⇒ `::Google::Cloud::StorageBatchOperations::V1::ObjectRetention::RetentionMode`

Returns Required. The retention mode of the object.