Skip to main content
Package com.gpudb.protocol

​
Class VerifyBackupRequest

java.lang.Object
com.gpudb.protocol.VerifyBackupRequest
All Implemented Interfaces:
org.apache.avro.generic.GenericContainer, org.apache.avro.generic.IndexedRecord
public class VerifyBackupRequest extends Object implements org.apache.avro.generic.IndexedRecord
A set of parameters for GPUdb.verifyBackup.

Inspects the requested database backup(s) for conformity at the remote file store accessible via the data source specified by datasourceName. By default all snapshots are inspected unless the option BACKUP_ID is used to target a specific instance. Returns backup verification results.

  • ​
    Constructor Details

    • ​
      VerifyBackupRequest

      public VerifyBackupRequest()
      Constructs a VerifyBackupRequest object with default parameters.

    • ​
      VerifyBackupRequest

      public VerifyBackupRequest(String backupName, String datasourceName, Map<String,String> options)
      Constructs a VerifyBackupRequest object with the specified parameters.
      Parameters:
      backupName - Name of the backup. An empty string or ’*’ will check all existing backups. Any text followed by a ’*’ will inspect backups whose name starts with that text. The default value is ”.
      datasourceName - Data source through which the backup is accessible.
      options - Optional parameters.
      • BACKUP_ID: ID of the snapshot to verify. Set to ‘-1’ to verify all snapshots in the backup. Leave empty to verify only the most recent snapshot. The default value is ‘-1’.
      The default value is an empty Map.

  • ​
    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()
      Name of the backup. An empty string or ’*’ will check all existing backups. Any text followed by a ’*’ will inspect backups whose name starts with that text. The default value is ”.
      Returns:
      The current value of backupName.

    • ​
      setBackupName

      public VerifyBackupRequest setBackupName(String backupName)
      Name of the backup. An empty string or ’*’ will check all existing backups. Any text followed by a ’*’ will inspect backups whose name starts with that text. The default value is ”.
      Parameters:
      backupName - The new value for backupName.
      Returns:
      this to mimic the builder pattern.

    • ​
      getDatasourceName

      public String getDatasourceName()
      Data source through which the backup is accessible.
      Returns:
      The current value of datasourceName.

    • ​
      setDatasourceName

      public VerifyBackupRequest setDatasourceName(String datasourceName)
      Data source through which the backup is accessible.
      Parameters:
      datasourceName - The new value for datasourceName.
      Returns:
      this to mimic the builder pattern.

    • ​
      getOptions

      public Map<String,String> getOptions()
      Optional parameters.
      • BACKUP_ID: ID of the snapshot to verify. Set to ‘-1’ to verify all snapshots in the backup. Leave empty to verify only the most recent snapshot. The default value is ‘-1’.
      The default value is an empty Map.
      Returns:
      The current value of options.

    • ​
      setOptions

      public VerifyBackupRequest setOptions(Map<String,String> options)
      Optional parameters.
      • BACKUP_ID: ID of the snapshot to verify. Set to ‘-1’ to verify all snapshots in the backup. Leave empty to verify only the most recent snapshot. The default value is ‘-1’.
      The default value is an empty Map.
      Parameters:
      options - The new value for options.
      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:
      IndexOutOfBoundsException

    • ​
      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:
      IndexOutOfBoundsException

    • ​
      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