Send feedback
Class ObjectRetention (0.22.0)
Stay organized with collections
Save and categorize content based on your preferences.
Version latestkeyboard_arrow_down
public final class ObjectRetention extends GeneratedMessageV3 implements ObjectRetentionOrBuilder
Describes options for object retention update.
Protobuf type google.cloud.storagebatchoperations.v1.ObjectRetention
Inherited Members
com.google.protobuf.GeneratedMessageV3.<ListT>makeMutableCopy(ListT)
com.google.protobuf.GeneratedMessageV3.<ListT>makeMutableCopy(ListT,int)
com.google.protobuf.GeneratedMessageV3.<T>emptyList(java.lang.Class<T>)
com.google.protobuf.GeneratedMessageV3.internalGetMapFieldReflection(int)
Static Fields
RETAIN_UNTIL_TIME_FIELD_NUMBER
public static final int RETAIN_UNTIL_TIME_FIELD_NUMBER
Field Value
Type
Description
int
RETENTION_MODE_FIELD_NUMBER
public static final int RETENTION_MODE_FIELD_NUMBER
Field Value
Type
Description
int
Static Methods
getDefaultInstance()
public static ObjectRetention getDefaultInstance ()
getDescriptor()
public static final Descriptors . Descriptor getDescriptor ()
newBuilder()
public static ObjectRetention . Builder newBuilder ()
newBuilder(ObjectRetention prototype)
public static ObjectRetention . Builder newBuilder ( ObjectRetention prototype )
public static ObjectRetention parseDelimitedFrom ( InputStream input )
public static ObjectRetention parseDelimitedFrom ( InputStream input , ExtensionRegistryLite extensionRegistry )
parseFrom(byte[] data)
public static ObjectRetention parseFrom ( byte [] data )
Parameter
Name
Description
data
byte []
parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)
public static ObjectRetention parseFrom ( byte [] data , ExtensionRegistryLite extensionRegistry )
parseFrom(ByteString data)
public static ObjectRetention parseFrom ( ByteString data )
parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)
public static ObjectRetention parseFrom ( ByteString data , ExtensionRegistryLite extensionRegistry )
public static ObjectRetention parseFrom ( CodedInputStream input )
public static ObjectRetention parseFrom ( CodedInputStream input , ExtensionRegistryLite extensionRegistry )
public static ObjectRetention parseFrom ( InputStream input )
public static ObjectRetention parseFrom ( InputStream input , ExtensionRegistryLite extensionRegistry )
parseFrom(ByteBuffer data)
public static ObjectRetention parseFrom ( ByteBuffer data )
parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)
public static ObjectRetention parseFrom ( ByteBuffer data , ExtensionRegistryLite extensionRegistry )
parser()
public static Parser<ObjectRetention> parser ()
Methods
equals(Object obj)
public boolean equals ( Object obj )
Parameter
Name
Description
obj
Object
Overrides
getDefaultInstanceForType()
public ObjectRetention getDefaultInstanceForType ()
getParserForType()
public Parser<ObjectRetention> getParserForType ()
Overrides
getRetainUntilTime()
public String getRetainUntilTime ()
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'.
optional string retain_until_time = 1 [(.google.api.field_behavior) = REQUIRED];
Returns
Type
Description
String
The retainUntilTime.
getRetainUntilTimeBytes()
public ByteString getRetainUntilTimeBytes ()
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'.
optional string retain_until_time = 1 [(.google.api.field_behavior) = REQUIRED];
Returns
Type
Description
ByteString
The bytes for retainUntilTime.
getRetentionMode()
public ObjectRetention . RetentionMode getRetentionMode ()
Required. The retention mode of the object.
optional .google.cloud.storagebatchoperations.v1.ObjectRetention.RetentionMode retention_mode = 2 [(.google.api.field_behavior) = REQUIRED];
getRetentionModeValue()
public int getRetentionModeValue ()
Required. The retention mode of the object.
optional .google.cloud.storagebatchoperations.v1.ObjectRetention.RetentionMode retention_mode = 2 [(.google.api.field_behavior) = REQUIRED];
Returns
Type
Description
int
The enum numeric value on the wire for retentionMode.
getSerializedSize()
public int getSerializedSize ()
Returns
Type
Description
int
Overrides
hasRetainUntilTime()
public boolean hasRetainUntilTime ()
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'.
optional string retain_until_time = 1 [(.google.api.field_behavior) = REQUIRED];
Returns
Type
Description
boolean
Whether the retainUntilTime field is set.
hasRetentionMode()
public boolean hasRetentionMode ()
Required. The retention mode of the object.
optional .google.cloud.storagebatchoperations.v1.ObjectRetention.RetentionMode retention_mode = 2 [(.google.api.field_behavior) = REQUIRED];
Returns
Type
Description
boolean
Whether the retentionMode field is set.
hashCode()
Returns
Type
Description
int
Overrides
internalGetFieldAccessorTable()
protected GeneratedMessageV3 . FieldAccessorTable internalGetFieldAccessorTable ()
Overrides
isInitialized()
public final boolean isInitialized ()
Overrides
newBuilderForType()
public ObjectRetention . Builder newBuilderForType ()
newBuilderForType(GeneratedMessageV3.BuilderParent parent)
protected ObjectRetention . Builder newBuilderForType ( GeneratedMessageV3 . BuilderParent parent )
Overrides
newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)
protected Object newInstance ( GeneratedMessageV3 . UnusedPrivateParameter unused )
Returns
Type
Description
Object
Overrides
toBuilder()
public ObjectRetention . Builder toBuilder ()
writeTo(CodedOutputStream output)
public void writeTo ( CodedOutputStream output )
Overrides
Send feedback
Except as otherwise noted, the content of this page is licensed under the Creative Commons Attribution 4.0 License , and code samples are licensed under the Apache 2.0 License . For details, see the Google Developers Site Policies . Java is a registered trademark of Oracle and/or its affiliates.
Last updated 2026-01-21 UTC.
Need to tell us more?
[[["Easy to understand","easyToUnderstand","thumb-up"],["Solved my problem","solvedMyProblem","thumb-up"],["Other","otherUp","thumb-up"]],[["Hard to understand","hardToUnderstand","thumb-down"],["Incorrect information or sample code","incorrectInformationOrSampleCode","thumb-down"],["Missing the information/samples I need","missingTheInformationSamplesINeed","thumb-down"],["Other","otherDown","thumb-down"]],["Last updated 2026-01-21 UTC."],[],[]]