class GoogleCloudStorage::BucketRetentionPolicy

Overview

The bucket's retention policy. The retention policy enforces a minimum retention time for all objects contained in the bucket, based on their creation time. Any attempt to overwrite or delete objects younger than the retention period will result in a PERMISSION_DENIED error. An unlocked retention policy can be modified or removed from the bucket via a storage.buckets.update operation. A locked retention policy cannot be removed or shortened in duration for the lifetime of the bucket. Attempting to remove or decrease period of a locked retention policy will result in a PERMISSION_DENIED error.

Included Modules

Defined in:

google_cloud_storage/models/bucket_retention_policy.cr

Constructors

Instance Method Summary

Instance methods inherited from module OpenApi::Json

after_initialize after_initialize, eql?(o : self) eql?, to_hash : Hash(String, JSON::Any) to_hash, to_json_any : JSON::Any to_json_any

Class methods inherited from module OpenApi::Json

build_from_hash(hash : Hash) build_from_hash, build_from_json_any(json_any : JSON::Any) build_from_json_any

Instance methods inherited from module OpenApi::Validatable

list_invalid_properties : Array(String) list_invalid_properties, list_invalid_properties_for(key : String) : Array(String) list_invalid_properties_for, valid? : Bool valid?, validate : Nil validate

Instance methods inherited from module JSON::Serializable

to_hash : JSON::Any to_hash

Class methods inherited from module JSON::Serializable

build_from_hash(hash : JSON::Any) build_from_hash

Constructor Detail

def self.new(pull : JSON::PullParser) #

[View source]
def self.new(*, effective_time : Time | Nil = nil, is_locked : Bool | Nil = nil, retention_period : String | Nil = nil) #

Initializes the object @param [Hash] attributes Model attributes in the form of hash


[View source]

Instance Method Detail

def ==(other : self) #

Generates #hash and #== methods from all fields #== @return [Bool] #hash calculates hash code according to all attributes. #hash @return [UInt64] Hash code


def effective_time : Time | Nil #

[View source]
def effective_time=(new_value : Time | Nil) #

Custom attribute writer method checking allowed values (enum). @param [Object] effective_time Object to be assigned


[View source]
def hash(hasher) #

Generates #hash and #== methods from all fields #== @return [Bool] #hash calculates hash code according to all attributes. #hash @return [UInt64] Hash code


def is_locked : Bool | Nil #

[View source]
def is_locked=(new_value : Bool | Nil) #

Custom attribute writer method checking allowed values (enum). @param [Object] is_locked Object to be assigned


[View source]
def list_invalid_properties : Array(String) #

Show invalid properties with the reasons. Usually used together with valid? @return Array for valid properties with the reasons


[View source]
def retention_period : String | Nil #

[View source]
def retention_period=(new_value : String | Nil) #

Custom attribute writer method checking allowed values (enum). @param [Object] retention_period Object to be assigned


[View source]
def valid? : Bool #

Check to see if the all the properties in the model are valid @return true if the model is valid


[View source]