Class Object.Retention.Builder (2.56.0) 
  
      
     
  
  
  
   
  
    
  
  
    
    
    
  Version 2.56.0keyboard_arrow_down  
  
 
    
    
    
    
      
  
  
  
    
public   static   final   class  Object . Retention . Builder   extends   GeneratedMessageV3 . Builder<Object . Retention . Builder >  implements   Object . RetentionOrBuilder  
   
   Specifies retention parameters of the object. Objects under retention
 cannot be deleted or overwritten until their retention expires.
 Protobuf type google.storage.v2.Object.Retention
 
  
  
  
    Inherited Members 
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
      com.google.protobuf.GeneratedMessageV3.Builder.getUnknownFieldSetBuilder() 
    
    
    
    
    
    
    
      com.google.protobuf.GeneratedMessageV3.Builder.internalGetMapFieldReflection(int) 
    
    
    
      com.google.protobuf.GeneratedMessageV3.Builder.internalGetMutableMapFieldReflection(int) 
    
    
    
    
    
    
      com.google.protobuf.GeneratedMessageV3.Builder.mergeUnknownLengthDelimitedField(int,com.google.protobuf.ByteString) 
    
    
      com.google.protobuf.GeneratedMessageV3.Builder.mergeUnknownVarintField(int,int) 
    
    
    
    
    
      com.google.protobuf.GeneratedMessageV3.Builder.parseUnknownField(com.google.protobuf.CodedInputStream,com.google.protobuf.ExtensionRegistryLite,int) 
    
    
    
    
      com.google.protobuf.GeneratedMessageV3.Builder.setUnknownFieldSetBuilder(com.google.protobuf.UnknownFieldSet.Builder) 
    
    
    
    
    
    
    
    
    
    
    
    
   
  Static Methods
   
   
  getDescriptor() 
  
    
public   static   final   Descriptors . Descriptor   getDescriptor ()  
   
  
  Methods
   
   
  addRepeatedField(Descriptors.FieldDescriptor field, Object value) 
  
    
public   Object . Retention . Builder   addRepeatedField ( Descriptors . FieldDescriptor   field ,   Object   value )  
   
  
  
  Overrides 
  
   
  build() 
  
    
public   Object . Retention   build ()  
   
  
   
  buildPartial() 
  
    
public   Object . Retention   buildPartial ()  
   
  
   
  clear() 
  
    
public   Object . Retention . Builder   clear ()  
   
  
  Overrides 
  
   
  clearField(Descriptors.FieldDescriptor field) 
  
    
public   Object . Retention . Builder   clearField ( Descriptors . FieldDescriptor   field )  
   
  
  
  Overrides 
  
   
  clearMode() 
  
    
public   Object . Retention . Builder   clearMode ()  
   
   Optional. The mode of the Retention.
 
 .google.storage.v2.Object.Retention.Mode mode = 1 [(.google.api.field_behavior) = OPTIONAL];
 
 
  
   
  clearOneof(Descriptors.OneofDescriptor oneof) 
  
    
public   Object . Retention . Builder   clearOneof ( Descriptors . OneofDescriptor   oneof )  
   
  
  
  Overrides 
  
   
  clearRetainUntilTime() 
  
    
public   Object . Retention . Builder   clearRetainUntilTime ()  
   
   Optional. The timestamp that the object needs to be retained until.
 Value cannot be set in the past or more than 100 years in the future.
 
 .google.protobuf.Timestamp retain_until_time = 2 [(.google.api.field_behavior) = OPTIONAL];
 
 
  
   
  clone() 
  
    
public   Object . Retention . Builder   clone ()  
   
  
  Overrides 
  
   
  getDefaultInstanceForType() 
  
    
public   Object . Retention   getDefaultInstanceForType ()  
   
  
   
  getDescriptorForType() 
  
    
public   Descriptors . Descriptor   getDescriptorForType ()  
   
  
  Overrides 
  
   
  getMode() 
  
    
public   Object . Retention . Mode   getMode ()  
   
   Optional. The mode of the Retention.
 
 .google.storage.v2.Object.Retention.Mode mode = 1 [(.google.api.field_behavior) = OPTIONAL];
 
 
  
   
  getModeValue() 
  
    
public   int   getModeValue ()  
   
   Optional. The mode of the Retention.
 
 .google.storage.v2.Object.Retention.Mode mode = 1 [(.google.api.field_behavior) = OPTIONAL];
 
 
  
    
      
        Returns  
       
      
        Type  
        Description  
       
      
        int  
        The enum numeric value on the wire for mode.
 
       
     
  
   
  getRetainUntilTime() 
  
    
public   Timestamp   getRetainUntilTime ()  
   
   Optional. The timestamp that the object needs to be retained until.
 Value cannot be set in the past or more than 100 years in the future.
 
 .google.protobuf.Timestamp retain_until_time = 2 [(.google.api.field_behavior) = OPTIONAL];
 
 
  
    
      
        Returns  
       
      
        Type  
        Description  
       
      
        Timestamp  
        The retainUntilTime.
 
       
     
  
   
  getRetainUntilTimeBuilder() 
  
    
public   Timestamp . Builder   getRetainUntilTimeBuilder ()  
   
   Optional. The timestamp that the object needs to be retained until.
 Value cannot be set in the past or more than 100 years in the future.
 
 .google.protobuf.Timestamp retain_until_time = 2 [(.google.api.field_behavior) = OPTIONAL];
 
 
  
   
  getRetainUntilTimeOrBuilder() 
  
    
public   TimestampOrBuilder   getRetainUntilTimeOrBuilder ()  
   
   Optional. The timestamp that the object needs to be retained until.
 Value cannot be set in the past or more than 100 years in the future.
 
 .google.protobuf.Timestamp retain_until_time = 2 [(.google.api.field_behavior) = OPTIONAL];
 
 
  
   
  hasRetainUntilTime() 
  
    
public   boolean   hasRetainUntilTime ()  
   
   Optional. The timestamp that the object needs to be retained until.
 Value cannot be set in the past or more than 100 years in the future.
 
 .google.protobuf.Timestamp retain_until_time = 2 [(.google.api.field_behavior) = OPTIONAL];
 
 
  
    
      
        Returns  
       
      
        Type  
        Description  
       
      
        boolean  
        Whether the retainUntilTime field is set.
 
       
     
  
   
  internalGetFieldAccessorTable() 
  
    
protected   GeneratedMessageV3 . FieldAccessorTable   internalGetFieldAccessorTable ()  
   
  
  Overrides 
  
   
  isInitialized() 
  
    
public   final   boolean   isInitialized ()  
   
  
  Overrides 
  
   
  
  
    
public   Object . Retention . Builder   mergeFrom ( CodedInputStream   input ,   ExtensionRegistryLite   extensionRegistry )  
   
  
  
  Overrides 
  
  
   
  mergeFrom(Message other) 
  
    
public   Object . Retention . Builder   mergeFrom ( Message   other )  
   
  
    
      
        Parameter  
       
      
        Name  
        Description  
       
      
        other 
        Message  
       
     
  
  
  Overrides 
  
   
  mergeFrom(Object.Retention other) 
  
    
public   Object . Retention . Builder   mergeFrom ( Object . Retention   other )  
   
  
  
   
  mergeRetainUntilTime(Timestamp value) 
  
    
public   Object . Retention . Builder   mergeRetainUntilTime ( Timestamp   value )  
   
   Optional. The timestamp that the object needs to be retained until.
 Value cannot be set in the past or more than 100 years in the future.
 
 .google.protobuf.Timestamp retain_until_time = 2 [(.google.api.field_behavior) = OPTIONAL];
 
 
  
  
   
  mergeUnknownFields(UnknownFieldSet unknownFields) 
  
    
public   final   Object . Retention . Builder   mergeUnknownFields ( UnknownFieldSet   unknownFields )  
   
  
  
  Overrides 
  
   
  setField(Descriptors.FieldDescriptor field, Object value) 
  
    
public   Object . Retention . Builder   setField ( Descriptors . FieldDescriptor   field ,   Object   value )  
   
  
  
  Overrides 
  
   
  setMode(Object.Retention.Mode value) 
  
    
public   Object . Retention . Builder   setMode ( Object . Retention . Mode   value )  
   
   Optional. The mode of the Retention.
 
 .google.storage.v2.Object.Retention.Mode mode = 1 [(.google.api.field_behavior) = OPTIONAL];
 
 
  
  
   
  setModeValue(int value) 
  
    
public   Object . Retention . Builder   setModeValue ( int   value )  
   
   Optional. The mode of the Retention.
 
 .google.storage.v2.Object.Retention.Mode mode = 1 [(.google.api.field_behavior) = OPTIONAL];
 
 
  
    
      
        Parameter  
       
      
        Name  
        Description  
       
      
        value 
        int The enum numeric value on the wire for mode to set.
 
       
     
  
  
   
  setRepeatedField(Descriptors.FieldDescriptor field, int index, Object value) 
  
    
public   Object . Retention . Builder   setRepeatedField ( Descriptors . FieldDescriptor   field ,   int   index ,   Object   value )  
   
  
  
  Overrides 
  
   
  setRetainUntilTime(Timestamp value) 
  
    
public   Object . Retention . Builder   setRetainUntilTime ( Timestamp   value )  
   
   Optional. The timestamp that the object needs to be retained until.
 Value cannot be set in the past or more than 100 years in the future.
 
 .google.protobuf.Timestamp retain_until_time = 2 [(.google.api.field_behavior) = OPTIONAL];
 
 
  
  
   
  setRetainUntilTime(Timestamp.Builder builderForValue) 
  
    
public   Object . Retention . Builder   setRetainUntilTime ( Timestamp . Builder   builderForValue )  
   
   Optional. The timestamp that the object needs to be retained until.
 Value cannot be set in the past or more than 100 years in the future.
 
 .google.protobuf.Timestamp retain_until_time = 2 [(.google.api.field_behavior) = OPTIONAL];
 
 
  
    
      
        Parameter  
       
      
        Name  
        Description  
       
      
        builderForValue 
        Builder  
       
     
  
  
   
  setUnknownFields(UnknownFieldSet unknownFields) 
  
    
public   final   Object . Retention . Builder   setUnknownFields ( UnknownFieldSet   unknownFields )  
   
  
  
  Overrides 
  
 
     
    
  
  
  
     
  
 
  
    
    
      
       
    
    
  
  
 
  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 2025-10-30 UTC.
 
 
  
  
  
    
      [[["Easy to understand","easyToUnderstand","thumb-up"],["Solved my problem","solvedMyProblem","thumb-up"],["Other","otherUp","thumb-up"]],[["Missing the information I need","missingTheInformationINeed","thumb-down"],["Too complicated / too many steps","tooComplicatedTooManySteps","thumb-down"],["Out of date","outOfDate","thumb-down"],["Samples / code issue","samplesCodeIssue","thumb-down"],["Other","otherDown","thumb-down"]],["Last updated 2025-10-30 UTC."],[],[]]