com.google.api.services.storage.model

Class Bucket.RetentionPolicy

java.lang.Object

java.util.AbstractMap<String,Object>

com.google.api.client.util.GenericData

com.google.api.client.json.GenericJson

com.google.api.services.storage.model.Bucket.RetentionPolicy

All Implemented Interfaces:

Cloneable, Map<String,Object>

Enclosing class:

Bucket

public static final class Bucket.RetentionPolicy
extends com.google.api.client.json.GenericJson

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.

Nested Class Summary

Nested classes/interfaces inherited from class com.google.api.client.util.GenericData

com.google.api.client.util.GenericData.Flags

Nested classes/interfaces inherited from class java.util.AbstractMap

AbstractMap.SimpleEntry<K,V>, AbstractMap.SimpleImmutableEntry<K,V>

Nested classes/interfaces inherited from interface java.util.Map

Map.Entry<K,V>

Constructor Summary

Constructors

Constructor and Description
RetentionPolicy()

Method Summary

Modifier and Type	Method and Description
Bucket.RetentionPolicy	clone()
com.google.api.client.util.DateTime	getEffectiveTime() Server-determined value that indicates the time from which policy was enforced and effective.
Boolean	getIsLocked() Once locked, an object retention policy cannot be modified.
Long	getRetentionPeriod() The duration in seconds that objects need to be retained.
Bucket.RetentionPolicy	set(String fieldName, Object value)
Bucket.RetentionPolicy	setEffectiveTime(com.google.api.client.util.DateTime effectiveTime) Server-determined value that indicates the time from which policy was enforced and effective.
Bucket.RetentionPolicy	setIsLocked(Boolean isLocked) Once locked, an object retention policy cannot be modified.
Bucket.RetentionPolicy	setRetentionPeriod(Long retentionPeriod) The duration in seconds that objects need to be retained.

Methods inherited from class com.google.api.client.json.GenericJson

getFactory, setFactory, toPrettyString, toString

Methods inherited from class com.google.api.client.util.GenericData

entrySet, equals, get, getClassInfo, getUnknownKeys, hashCode, put, putAll, remove, setUnknownKeys

Methods inherited from class java.util.AbstractMap

clear, containsKey, containsValue, isEmpty, keySet, size, values

Methods inherited from class java.lang.Object

finalize, getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface java.util.Map

compute, computeIfAbsent, computeIfPresent, forEach, getOrDefault, merge, putIfAbsent, remove, replace, replace, replaceAll

Constructor Detail

RetentionPolicy

public RetentionPolicy()

Method Detail

getEffectiveTime

public com.google.api.client.util.DateTime getEffectiveTime()

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

Returns:

value or null for none

setEffectiveTime

public Bucket.RetentionPolicy setEffectiveTime(com.google.api.client.util.DateTime effectiveTime)

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

Parameters:

effectiveTime - effectiveTime or null for none

getIsLocked

public Boolean getIsLocked()

Once locked, an object retention policy cannot be modified.

Returns:

value or null for none

setIsLocked

public Bucket.RetentionPolicy setIsLocked(Boolean isLocked)

Once locked, an object retention policy cannot be modified.

Parameters:

isLocked - isLocked or null for none

getRetentionPeriod

public Long getRetentionPeriod()

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.

Returns:

value or null for none

setRetentionPeriod

public Bucket.RetentionPolicy setRetentionPeriod(Long 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.

Parameters:

retentionPeriod - retentionPeriod or null for none

set

public Bucket.RetentionPolicy set(String fieldName,
                                  Object value)

Overrides:

set in class com.google.api.client.json.GenericJson

clone

public Bucket.RetentionPolicy clone()

Overrides:

clone in class com.google.api.client.json.GenericJson