Class Bucket.RetentionPolicyData

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.

Inheritance

object

Bucket.RetentionPolicyData

Inherited Members

object.Equals(object)

object.Equals(object, object)

object.GetHashCode()

object.GetType()

object.MemberwiseClone()

object.ReferenceEquals(object, object)

object.ToString()

Namespace: Google.Apis.Storage.v1.Data

Assembly: Google.Apis.Storage.v1.dll

Syntax

public class Bucket.RetentionPolicyData

Properties

EffectiveTime

DateTime representation of EffectiveTimeRaw.

Declaration

[JsonIgnore]
[Obsolete("This property is obsolete and may behave unexpectedly; please use EffectiveTimeDateTimeOffset instead.")]
public virtual DateTime? EffectiveTime { get; set; }

Property Value

Type	Description
DateTime?

EffectiveTimeDateTimeOffset

DateTimeOffset representation of EffectiveTimeRaw.

Declaration

[JsonIgnore]
public virtual DateTimeOffset? EffectiveTimeDateTimeOffset { get; set; }

Property Value

Type	Description
DateTimeOffset?

EffectiveTimeRaw

Server-determined value that indicates the time from which policy was enforced and effective. This value is in RFC 3339 format.

Declaration

[JsonProperty("effectiveTime")]
public virtual string EffectiveTimeRaw { get; set; }

Property Value

Type	Description
string

IsLocked

Once locked, an object retention policy cannot be modified.

Declaration

[JsonProperty("isLocked")]
public virtual bool? IsLocked { get; set; }

Property Value

Type	Description
bool?

RetentionPeriod

The duration in seconds that objects need to be retained. Retention duration must be greater than zero and less than 100 years. Note that enforcement of retention periods less than a day is not guaranteed. Such periods should only be used for testing purposes.

Declaration

[JsonProperty("retentionPeriod")]
public virtual long? RetentionPeriod { get; set; }

Property Value

Type	Description
long?