​

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 to restore from, which must refer to an existing backup. The default value is ”.

  Returns:

  The current value of backupName.

• ​

  setBackupName

  public RestoreBackupRequest setBackupName(String backupName)

  Name of the backup to restore from, which must refer to an existing backup. The default value is ”.

  Parameters:

  backupName - The new value for backupName.

  Returns:

  this to mimic the builder pattern.

• ​

  getRestoreObjectsMap

  public Map<String,String> getRestoreObjectsMap()

  Map of database objects to be restored from the backup.

  • ALL: All object types and data contained in the given schema(s).
  • CONTEXT: Context(s).
  • CREDENTIAL: Credential(s).
  • DATASINK: Data sink(s).
  • DATASOURCE: Data source(s).
  • FUNCTION_ENVIRONMENT: Python UDF function environment(s).
  • GRAPH: Graph(s) definition.
  • MONITOR: Table monitor(s) / SQL stream(s).
  • RESOURCE_GROUP: Resource group(s).
  • ROLE: Role(s), role members (roles or users, recursively), and associated permissions.
  • STORED_PROCEDURE: SQL procedure(s).
  • TABLE: Table(s) and SQL view(s). Tables with subscriptions will by default be restored in the state they were in at the time of the snapshot. See RESTORE_SUBSCRIPTIONS for options to override the default behavior.
  • USER: User(s) (internal and external) and associated permissions.
  • USER_DEFINED_FUNCTION: UDF(s).

  Returns:

  The current value of restoreObjectsMap.

• ​

  setRestoreObjectsMap

  public RestoreBackupRequest setRestoreObjectsMap(Map<String,String> restoreObjectsMap)

  Map of database objects to be restored from the backup.

  • ALL: All object types and data contained in the given schema(s).
  • CONTEXT: Context(s).
  • CREDENTIAL: Credential(s).
  • DATASINK: Data sink(s).
  • DATASOURCE: Data source(s).
  • FUNCTION_ENVIRONMENT: Python UDF function environment(s).
  • GRAPH: Graph(s) definition.
  • MONITOR: Table monitor(s) / SQL stream(s).
  • RESOURCE_GROUP: Resource group(s).
  • ROLE: Role(s), role members (roles or users, recursively), and associated permissions.
  • STORED_PROCEDURE: SQL procedure(s).
  • TABLE: Table(s) and SQL view(s). Tables with subscriptions will by default be restored in the state they were in at the time of the snapshot. See RESTORE_SUBSCRIPTIONS for options to override the default behavior.
  • USER: User(s) (internal and external) and associated permissions.
  • USER_DEFINED_FUNCTION: UDF(s).

  Parameters:

  restoreObjectsMap - The new value for restoreObjectsMap.

  Returns:

  this to mimic the builder pattern.

• ​

  getDatasourceName

  public String getDatasourceName()

  Data source through which the backup will be restored.

  Returns:

  The current value of datasourceName.

• ​

  setDatasourceName

  public RestoreBackupRequest setDatasourceName(String datasourceName)

  Data source through which the backup will be restored.

  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 restore. Leave empty to restore the most recent snapshot in the backup. The default value is ”.
  • CHECKSUM: Whether or not to verify checksums for backup files when restoring. Supported values:
    • TRUE
    • FALSE
    The default value is FALSE.
  • CREATE_SCHEMA_IF_NOT_EXIST: Behavior to apply when the schema containing any database object to restore does not already exist. Supported values:
    • TRUE: If the schema containing any restored object does not exist, create it automatically.
    • FALSE: If the schema containing any restored object does not exist, return an error.
    The default value is TRUE.
  • DDL_ONLY: Behavior to apply when restoring tables. Supported values:
    • TRUE: Restore table DDL, but do not restore data.
    • FALSE: Restore tables and their data.
    The default value is FALSE.
  • DRY_RUN: Whether or not to perform a dry run of the restoration operation. Supported values:
    • TRUE
    • FALSE
    The default value is FALSE.
  • RESTORE_SUBSCRIPTIONS: Behavior to apply when restoring datasource subscriptions on tables. Supported values:
    • RESUME: Resume subscriptions that were active when the backup was made.
    • PAUSE: Pause subscriptions that were active when the backup was made.
    • CANCEL: Cancel active subscriptions.
    The default value is RESUME.
  • REINGEST: Behavior to apply when restoring table data. Supported values:
    • TRUE: Restore table data by re-ingesting it. This is the default behavior if the cluster topology differs from that of the contained backup.
    • FALSE: Restore the persisted data files directly.
    The default value is FALSE.
  • RENAMED_OBJECTS_SCHEMA: If the RESTORE_POLICY is RENAME, use this schema for relocated existing objects instead of the default generated one. The default value is ”.
  • RESTORE_POLICY: Behavior to apply when any database object to restore already exists. Supported values:
    • NONE: If an object to be restored already exists with the same name, abort and return error.
    • REPLACE: If an object to be restored already exists with the same name, replace it with the backup version.
    • RENAME: If an object to be restored already exists with the same name, move that existing one to the schema specified by RENAMED_OBJECTS_SCHEMA. This policy does not apply to non-schema objects.
    The default value is NONE.

  The default value is an empty Map.

  Returns:

  The current value of options.

• ​

  setOptions

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

  Optional parameters.

  • BACKUP_ID: ID of the snapshot to restore. Leave empty to restore the most recent snapshot in the backup. The default value is ”.
  • CHECKSUM: Whether or not to verify checksums for backup files when restoring. Supported values:
    • TRUE
    • FALSE
    The default value is FALSE.
  • CREATE_SCHEMA_IF_NOT_EXIST: Behavior to apply when the schema containing any database object to restore does not already exist. Supported values:
    • TRUE: If the schema containing any restored object does not exist, create it automatically.
    • FALSE: If the schema containing any restored object does not exist, return an error.
    The default value is TRUE.
  • DDL_ONLY: Behavior to apply when restoring tables. Supported values:
    • TRUE: Restore table DDL, but do not restore data.
    • FALSE: Restore tables and their data.
    The default value is FALSE.
  • DRY_RUN: Whether or not to perform a dry run of the restoration operation. Supported values:
    • TRUE
    • FALSE
    The default value is FALSE.
  • RESTORE_SUBSCRIPTIONS: Behavior to apply when restoring datasource subscriptions on tables. Supported values:
    • RESUME: Resume subscriptions that were active when the backup was made.
    • PAUSE: Pause subscriptions that were active when the backup was made.
    • CANCEL: Cancel active subscriptions.
    The default value is RESUME.
  • REINGEST: Behavior to apply when restoring table data. Supported values:
    • TRUE: Restore table data by re-ingesting it. This is the default behavior if the cluster topology differs from that of the contained backup.
    • FALSE: Restore the persisted data files directly.
    The default value is FALSE.
  • RENAMED_OBJECTS_SCHEMA: If the RESTORE_POLICY is RENAME, use this schema for relocated existing objects instead of the default generated one. The default value is ”.
  • RESTORE_POLICY: Behavior to apply when any database object to restore already exists. Supported values:
    • NONE: If an object to be restored already exists with the same name, abort and return error.
    • REPLACE: If an object to be restored already exists with the same name, replace it with the backup version.
    • RENAME: If an object to be restored already exists with the same name, move that existing one to the schema specified by RENAMED_OBJECTS_SCHEMA. This policy does not apply to non-schema objects.
    The default value is NONE.

  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