​

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 show all existing backups. Any text followed by a ’*’ will show backups whose name starts with that text. The default value is ”.

  Returns:

  The current value of backupName.

• ​

  setBackupName

  public ShowBackupRequest setBackupName(String backupName)

  Name of the backup. An empty string or ’*’ will show all existing backups. Any text followed by a ’*’ will show 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 ShowBackupRequest 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 show. Leave empty to show information from the most recent snapshot in the backup. The default value is ”.
  • BACKUP_TYPE: Show backups by type. This option is ignored if BACKUP_ID is non-empty. Supported values:
    • ALL: Show all backup types.
    • FULL: Show full backups only.
    • INCREMENTAL: Show incremental backups only.
    • DIFFERENTIAL: Show differential backups only.
    The default value is ALL.
  • SHOW_CONTENTS: Show the contents of the backed-up snapshots. Supported values:
    • NONE: Don’t show snapshot contents.
    • OBJECT_NAMES: Show backed-up object names, and for tables, sizing detail.
    • OBJECT_FILES: Show backed-up object names, and for tables, sizing detail and associated files.
    The default value is NONE.
  • NO_ERROR_IF_NOT_EXISTS: Whether or not to suppress the error if the specified backup does not exist. Supported values:
    • TRUE
    • FALSE
    The default value is FALSE.

  The default value is an empty Map.

  Returns:

  The current value of options.

• ​

  setOptions

  public ShowBackupRequest setOptions(Map<String,String> options)

  Optional parameters.

  • BACKUP_ID: ID of the snapshot to show. Leave empty to show information from the most recent snapshot in the backup. The default value is ”.
  • BACKUP_TYPE: Show backups by type. This option is ignored if BACKUP_ID is non-empty. Supported values:
    • ALL: Show all backup types.
    • FULL: Show full backups only.
    • INCREMENTAL: Show incremental backups only.
    • DIFFERENTIAL: Show differential backups only.
    The default value is ALL.
  • SHOW_CONTENTS: Show the contents of the backed-up snapshots. Supported values:
    • NONE: Don’t show snapshot contents.
    • OBJECT_NAMES: Show backed-up object names, and for tables, sizing detail.
    • OBJECT_FILES: Show backed-up object names, and for tables, sizing detail and associated files.
    The default value is NONE.
  • NO_ERROR_IF_NOT_EXISTS: Whether or not to suppress the error if the specified backup does not exist. Supported values:
    • TRUE
    • FALSE
    The default value is FALSE.

  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