Class BackupRule (0.35.0) 
  
  
  
   
  
    
  
  
    
    
    
    
  Version 0.35.0keyboard_arrow_down  
  
 
    
    
    
    
      
  
  
  
    
public   final   class  BackupRule   extends   GeneratedMessageV3   implements   BackupRuleOrBuilder  
   BackupRule binds the backup schedule to a retention policy.
 Protobuf type google.cloud.backupdr.v1.BackupRule
    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
   
  BACKUP_RETENTION_DAYS_FIELD_NUMBER 
  
    
public   static   final   int   BACKUP_RETENTION_DAYS_FIELD_NUMBER  
  
    
      
        Field Value  
      
        Type Description  
      
        int  
     
  
  RULE_ID_FIELD_NUMBER 
  
    
public   static   final   int   RULE_ID_FIELD_NUMBER  
  
    
      
        Field Value  
      
        Type Description  
      
        int  
     
  
  STANDARD_SCHEDULE_FIELD_NUMBER 
  
    
public   static   final   int   STANDARD_SCHEDULE_FIELD_NUMBER  
  
    
      
        Field Value  
      
        Type Description  
      
        int  
     
  
  Static Methods
   
  getDefaultInstance() 
  
    
public   static   BackupRule   getDefaultInstance ()  
  
  getDescriptor() 
  
    
public   static   final   Descriptors . Descriptor   getDescriptor ()  
  
  newBuilder() 
  
    
public   static   BackupRule . Builder   newBuilder ()  
  
  newBuilder(BackupRule prototype) 
  
    
public   static   BackupRule . Builder   newBuilder ( BackupRule   prototype )  
  
  
  
    
public   static   BackupRule   parseDelimitedFrom ( InputStream   input )  
  
  
  
  
    
public   static   BackupRule   parseDelimitedFrom ( InputStream   input ,   ExtensionRegistryLite   extensionRegistry )  
  
  
  
  parseFrom(byte[] data) 
  
    
public   static   BackupRule   parseFrom ( byte []   data )  
  
    
      
        Parameter  
      
        Name Description  
      
        databyte [] 
     
  
  
  
  parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry) 
  
    
public   static   BackupRule   parseFrom ( byte []   data ,   ExtensionRegistryLite   extensionRegistry )  
  
  
  
  parseFrom(ByteString data) 
  
    
public   static   BackupRule   parseFrom ( ByteString   data )  
  
  
  
  parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry) 
  
    
public   static   BackupRule   parseFrom ( ByteString   data ,   ExtensionRegistryLite   extensionRegistry )  
  
  
  
  
    
public   static   BackupRule   parseFrom ( CodedInputStream   input )  
  
  
  
  
    
public   static   BackupRule   parseFrom ( CodedInputStream   input ,   ExtensionRegistryLite   extensionRegistry )  
  
  
  
  
    
public   static   BackupRule   parseFrom ( InputStream   input )  
  
  
  
  
    
public   static   BackupRule   parseFrom ( InputStream   input ,   ExtensionRegistryLite   extensionRegistry )  
  
  
  
  parseFrom(ByteBuffer data) 
  
    
public   static   BackupRule   parseFrom ( ByteBuffer   data )  
  
  
  
  parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry) 
  
    
public   static   BackupRule   parseFrom ( ByteBuffer   data ,   ExtensionRegistryLite   extensionRegistry )  
  
  
  
  parser() 
  
    
public   static   Parser<BackupRule>   parser ()  
  
  Methods
   
  equals(Object obj) 
  
    
public   boolean   equals ( Object   obj )  
  
    
      
        Parameter  
      
        Name Description  
      
        objObject  
     
  
  
  Overrides 
  
  getBackupRetentionDays() 
  
    
public   int   getBackupRetentionDays ()  
   Required. Configures the duration for which backup data will be kept. It is
 defined in “days”. The value should be greater than or equal to minimum
 enforced retention of the backup vault.
 Minimum value is 1 and maximum value is 36159 for custom retention
 on-demand backup.
 Minimum and maximum values are workload specific for all other rules.
 int32 backup_retention_days = 4 [(.google.api.field_behavior) = REQUIRED];
    
      
        Returns  
      
        Type Description  
      
        int The backupRetentionDays.
 
     
  
  getBackupScheduleOneofCase() 
  
    
public   BackupRule . BackupScheduleOneofCase   getBackupScheduleOneofCase ()  
  
  getDefaultInstanceForType() 
  
    
public   BackupRule   getDefaultInstanceForType ()  
  
  getParserForType() 
  
    
public   Parser<BackupRule>   getParserForType ()  
  
  Overrides 
  
  getRuleId() 
  
    
public   String   getRuleId ()  
   Required. Immutable. The unique id of this BackupRule. The rule_id is
 unique per BackupPlan.The rule_id must start with a lowercase letter
 followed by up to 62 lowercase letters, numbers, or hyphens. Pattern,
 /a-z {,62}/.
 
 string rule_id = 1 [(.google.api.field_behavior) = REQUIRED, (.google.api.field_behavior) = IMMUTABLE];
 
    
      
        Returns  
      
        Type Description  
      
        String The ruleId.
 
     
  
  getRuleIdBytes() 
  
    
public   ByteString   getRuleIdBytes ()  
   Required. Immutable. The unique id of this BackupRule. The rule_id is
 unique per BackupPlan.The rule_id must start with a lowercase letter
 followed by up to 62 lowercase letters, numbers, or hyphens. Pattern,
 /a-z {,62}/.
 
 string rule_id = 1 [(.google.api.field_behavior) = REQUIRED, (.google.api.field_behavior) = IMMUTABLE];
 
    
      
        Returns  
      
        Type Description  
      
        ByteString The bytes for ruleId.
 
     
  
  getSerializedSize() 
  
    
public   int   getSerializedSize ()  
  
    
      
        Returns  
      
        Type Description  
      
        int  
     
  
  Overrides 
  
  getStandardSchedule() 
  
    
public   StandardSchedule   getStandardSchedule ()  
   Optional. Defines a schedule that runs within the confines of a defined
 window of time.
 
 .google.cloud.backupdr.v1.StandardSchedule standard_schedule = 5 [(.google.api.field_behavior) = OPTIONAL];
 
getStandardScheduleOrBuilder() 
  
    
public   StandardScheduleOrBuilder   getStandardScheduleOrBuilder ()  
   Optional. Defines a schedule that runs within the confines of a defined
 window of time.
 
 .google.cloud.backupdr.v1.StandardSchedule standard_schedule = 5 [(.google.api.field_behavior) = OPTIONAL];
 
hasStandardSchedule() 
  
    
public   boolean   hasStandardSchedule ()  
   Optional. Defines a schedule that runs within the confines of a defined
 window of time.
 
 .google.cloud.backupdr.v1.StandardSchedule standard_schedule = 5 [(.google.api.field_behavior) = OPTIONAL];
 
    
      
        Returns  
      
        Type Description  
      
        boolean Whether the standardSchedule field is set.
 
     
  
  hashCode() 
  
  
    
      
        Returns  
      
        Type Description  
      
        int  
     
  
  Overrides 
  
  internalGetFieldAccessorTable() 
  
    
protected   GeneratedMessageV3 . FieldAccessorTable   internalGetFieldAccessorTable ()  
  
  Overrides 
  
  isInitialized() 
  
    
public   final   boolean   isInitialized ()  
  
  Overrides 
  
  newBuilderForType() 
  
    
public   BackupRule . Builder   newBuilderForType ()  
  
  newBuilderForType(GeneratedMessageV3.BuilderParent parent) 
  
    
protected   BackupRule . Builder   newBuilderForType ( GeneratedMessageV3 . BuilderParent   parent )  
  
  
  Overrides 
  
  newInstance(GeneratedMessageV3.UnusedPrivateParameter unused) 
  
    
protected   Object   newInstance ( GeneratedMessageV3 . UnusedPrivateParameter   unused )  
  
  
    
      
        Returns  
      
        Type Description  
      
        Object  
     
  
  Overrides 
  
  toBuilder() 
  
    
public   BackupRule . Builder   toBuilder ()  
  
  writeTo(CodedOutputStream output) 
  
    
public   void   writeTo ( CodedOutputStream   output )  
  
  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-28 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-28 UTC."],[],[]]