Skip to main content

Class RestoreBackupResponse

java.lang.Object
com.gpudb.protocol.RestoreBackupResponse
All Implemented Interfaces:
org.apache.avro.generic.GenericContainer, org.apache.avro.generic.IndexedRecord

public class RestoreBackupResponse extends Object implements org.apache.avro.generic.IndexedRecord
A set of results returned by GPUdb.restoreBackup.
  • Constructor Details

    • RestoreBackupResponse

      public RestoreBackupResponse()
      Constructs a RestoreBackupResponse object with default parameters.
  • Method Details

    • getClassSchema

      public static org.apache.avro.Schema getClassSchema()
      This method supports the Avro framework and is not intended to be called directly by the user.
      Returns:
      The schema for the class.
    • getBackupName

      public String getBackupName()
      Value of backupName.
      Returns:
      The current value of backupName.
    • setBackupName

      public RestoreBackupResponse setBackupName(String backupName)
      Value of backupName.
      Parameters:
      backupName - The new value for backupName.
      Returns:
      this to mimic the builder pattern.
    • getBackupId

      public long getBackupId()
      ID of the snapshot that was restored.
      Returns:
      The current value of backupId.
    • setBackupId

      public RestoreBackupResponse setBackupId(long backupId)
      ID of the snapshot that was restored.
      Parameters:
      backupId - The new value for backupId.
      Returns:
      this to mimic the builder pattern.
    • getRestoredBytes

      public long getRestoredBytes()
      Total size of data restored from backup.
      Returns:
      The current value of restoredBytes.
    • setRestoredBytes

      public RestoreBackupResponse setRestoredBytes(long restoredBytes)
      Total size of data restored from backup.
      Parameters:
      restoredBytes - The new value for restoredBytes.
      Returns:
      this to mimic the builder pattern.
    • getRestoredFiles

      public long getRestoredFiles()
      Total number of files restored from backup.
      Returns:
      The current value of restoredFiles.
    • setRestoredFiles

      public RestoreBackupResponse setRestoredFiles(long restoredFiles)
      Total number of files restored from backup.
      Parameters:
      restoredFiles - The new value for restoredFiles.
      Returns:
      this to mimic the builder pattern.
    • getRestoredRecords

      public long getRestoredRecords()
      Total number of records restored from backup.
      Returns:
      The current value of restoredRecords.
    • setRestoredRecords

      public RestoreBackupResponse setRestoredRecords(long restoredRecords)
      Total number of records restored from backup.
      Parameters:
      restoredRecords - The new value for restoredRecords.
      Returns:
      this to mimic the builder pattern.
    • getRestoredObjects

      public Map<String,String> getRestoredObjects()
      Database objects that were successfully restored and their associated types.
      Returns:
      The current value of restoredObjects.
    • setRestoredObjects

      public RestoreBackupResponse setRestoredObjects(Map<String,String> restoredObjects)
      Database objects that were successfully restored and their associated types.
      Parameters:
      restoredObjects - The new value for restoredObjects.
      Returns:
      this to mimic the builder pattern.
    • getRenamedObjects

      public Map<String,String> getRenamedObjects()
      Original and new names of database objects that were successfully restored and their associated types.
      Returns:
      The current value of renamedObjects.
    • setRenamedObjects

      public RestoreBackupResponse setRenamedObjects(Map<String,String> renamedObjects)
      Original and new names of database objects that were successfully restored and their associated types.
      Parameters:
      renamedObjects - The new value for renamedObjects.
      Returns:
      this to mimic the builder pattern.
    • getFailedObjects

      public Map<String,String> getFailedObjects()
      Database objects that failed to be restored and their associated types.
      Returns:
      The current value of failedObjects.
    • setFailedObjects

      public RestoreBackupResponse setFailedObjects(Map<String,String> failedObjects)
      Database objects that failed to be restored and their associated types.
      Parameters:
      failedObjects - The new value for failedObjects.
      Returns:
      this to mimic the builder pattern.
    • getInfo

      public Map<String,String> getInfo()
      Additional information.
      • CLEAN_DROPPED_OBJECTS: If RESTORE_POLICY is CLEAN or CLEAN_ALL, the objects the clean dropped before restoring, grouped by type, e.g. ‘table: s.a, s.b; user: u1; schema: s’. When DRY_RUN is TRUE, the objects it would drop. A long list ends with the number of objects left out.
      • CLEAN_KEPT_OBJECTS: If RESTORE_POLICY is CLEAN or CLEAN_ALL, comma-separated list of objects in the backup that the clean kept on the target, such as the calling user, and that the restore therefore left as they were instead of restoring them, e.g. user ‘u1’, directory ‘~u1’.
      The default value is an empty Map.
      Returns:
      The current value of info.
    • setInfo

      public RestoreBackupResponse setInfo(Map<String,String> info)
      Additional information.
      • CLEAN_DROPPED_OBJECTS: If RESTORE_POLICY is CLEAN or CLEAN_ALL, the objects the clean dropped before restoring, grouped by type, e.g. ‘table: s.a, s.b; user: u1; schema: s’. When DRY_RUN is TRUE, the objects it would drop. A long list ends with the number of objects left out.
      • CLEAN_KEPT_OBJECTS: If RESTORE_POLICY is CLEAN or CLEAN_ALL, comma-separated list of objects in the backup that the clean kept on the target, such as the calling user, and that the restore therefore left as they were instead of restoring them, e.g. user ‘u1’, directory ‘~u1’.
      The default value is an empty Map.
      Parameters:
      info - The new value for info.
      Returns:
      this to mimic the builder pattern.
    • getSchema

      public org.apache.avro.Schema getSchema()
      This method supports the Avro framework and is not intended to be called directly by the user.
      Specified by:
      getSchema in interface org.apache.avro.generic.GenericContainer
      Returns:
      The schema object describing this class.
    • get

      public Object get(int index)
      This method supports the Avro framework and is not intended to be called directly by the user.
      Specified by:
      get in interface org.apache.avro.generic.IndexedRecord
      Parameters:
      index - the position of the field to get
      Returns:
      value of the field with the given index.
      Throws:
    • put

      public void put(int index, Object value)
      This method supports the Avro framework and is not intended to be called directly by the user.
      Specified by:
      put in interface org.apache.avro.generic.IndexedRecord
      Parameters:
      index - the position of the field to set
      value - the value to set
      Throws:
    • equals

      public boolean equals(Object obj)
      Overrides:
      equals in class Object
    • toString

      public String toString()
      Overrides:
      toString in class Object
    • hashCode

      public int hashCode()
      Overrides:
      hashCode in class Object