com.gpudb.protocol

Class RestoreBackupRequest

java.lang.Object

com.gpudb.protocol.RestoreBackupRequest

All Implemented Interfaces:

org.apache.avro.generic.GenericContainer, org.apache.avro.generic.IndexedRecord

public class RestoreBackupRequest
extends Object
implements org.apache.avro.generic.IndexedRecord

A set of parameters for GPUdb.restoreBackup.

Restores objects from a backup instance. Response from a backup restoration operation.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	RestoreBackupRequest.Options A set of string constants for the RestoreBackupRequest parameter options.
static class	RestoreBackupRequest.RestoreObjectsMap A set of string constants for the RestoreBackupRequest parameter restoreObjectsMap.

Constructor Summary

Constructors

Constructor and Description
RestoreBackupRequest() Constructs a RestoreBackupRequest object with default parameters.
RestoreBackupRequest(String backupName, Map<String,String> restoreObjectsMap, String datasourceName, Map<String,String> options) Constructs a RestoreBackupRequest object with the specified parameters.

Method Summary

Modifier and Type	Method and Description
boolean	equals(Object obj)
Object	get(int index) This method supports the Avro framework and is not intended to be called directly by the user.
String	getBackupName() Name of the backup object, which must refer to a currently existing backup.
static org.apache.avro.Schema	getClassSchema() This method supports the Avro framework and is not intended to be called directly by the user.
String	getDatasourceName() Datasource where backup is located.
Map<String,String>	getOptions() Optional parameters.
Map<String,String>	getRestoreObjectsMap() Map of objects to be restored from the backup.
org.apache.avro.Schema	getSchema() This method supports the Avro framework and is not intended to be called directly by the user.
int	hashCode()
void	put(int index, Object value) This method supports the Avro framework and is not intended to be called directly by the user.
RestoreBackupRequest	setBackupName(String backupName) Name of the backup object, which must refer to a currently existing backup.
RestoreBackupRequest	setDatasourceName(String datasourceName) Datasource where backup is located.
RestoreBackupRequest	setOptions(Map<String,String> options) Optional parameters.
RestoreBackupRequest	setRestoreObjectsMap(Map<String,String> restoreObjectsMap) Map of objects to be restored from the backup.
String	toString()

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Constructor Detail

RestoreBackupRequest

public RestoreBackupRequest()

Constructs a RestoreBackupRequest object with default parameters.

RestoreBackupRequest

public RestoreBackupRequest(String backupName,
                            Map<String,String> restoreObjectsMap,
                            String datasourceName,
                            Map<String,String> options)

Constructs a RestoreBackupRequest object with the specified parameters.

Parameters:

backupName - Name of the backup object, which must refer to a currently existing backup. The default value is ''.

restoreObjectsMap - Map of objects to be restored from the backup. Error if empty.

• ALL: All object types in a schema (excludes permissions, system configuration, host secret key, KiFS directories and user defined functions)
• TABLE: Database Table
• CREDENTIAL: Credential
• CONTEXT: Context
• DATASINK: Data Sink
• DATASOURCE: Data Source
• STORED_PROCEDURE: SQL Procedure
• MONITOR: Table Monitor (Stream)
• USER: User (internal and external) and associated permissions
• ROLE: Role, role members (roles or users, recursively) and associated permissions
• CONFIGURATION: If TRUE, restore the database configuration file. Supported values:
  • FALSE
  • TRUE
  The default value is FALSE.

datasourceName - Datasource where backup is located.

options - Optional parameters.

• BACKUP_ID: Backup instance ID to restore. Leave empty to restore the most recent backup instance. The default value is ''.
• RESTORE_POLICY: Behavior to apply when restoring objects that already exist. Supported values:
  • NONE: If an object to be restored currently exists with the same name, abort and return error
  • REPLACE: If an object to be restored currently exists with the same name, replace it with the backup version
  • RENAME: If an object to be restored currently exists with the same name, rename the original version
  The default value is NONE.
• RENAMED_OBJECTS_SCHEMA: If the restore policy is rename, optionally use this schema for renamed objects instead of a default generated one. The default value is ''.
• CREATE_SCHEMA_IF_NOT_EXIST: Create the schema for an object to be restored if it does not currently exist. Error otherwise. Supported values:
  • FALSE
  • TRUE
  The default value is TRUE.
• REINGEST: Restore table data by re-ingesting. If the cluster topology differs from the contained backup this is the default behavior, otherwise restore the persist directly. Supported values:
  • FALSE
  • TRUE
  The default value is FALSE.
• DDL_ONLY: Only recreates the objects from their DDL, do not restore table data. Supported values:
  • TRUE
  • FALSE
  The default value is FALSE.
• CHECKSUM: Verify checksum for backup files. Supported values:
  • FALSE
  • TRUE
  The default value is FALSE.
• DRY_RUN: Does a dry-run restoration operation. Supported values:
  • TRUE
  • FALSE
  The default value is FALSE.

The default value is an empty Map.

Method Detail

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 object, which must refer to a currently existing backup. The default value is ''.

Returns:

The current value of backupName.

setBackupName

public RestoreBackupRequest setBackupName(String backupName)

Name of the backup object, which must refer to a currently 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 objects to be restored from the backup. Error if empty.

• ALL: All object types in a schema (excludes permissions, system configuration, host secret key, KiFS directories and user defined functions)
• TABLE: Database Table
• CREDENTIAL: Credential
• CONTEXT: Context
• DATASINK: Data Sink
• DATASOURCE: Data Source
• STORED_PROCEDURE: SQL Procedure
• MONITOR: Table Monitor (Stream)
• USER: User (internal and external) and associated permissions
• ROLE: Role, role members (roles or users, recursively) and associated permissions
• CONFIGURATION: If TRUE, restore the database configuration file. Supported values:
  • FALSE
  • TRUE
  The default value is FALSE.

Returns:

The current value of restoreObjectsMap.

setRestoreObjectsMap

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

Map of objects to be restored from the backup. Error if empty.

• ALL: All object types in a schema (excludes permissions, system configuration, host secret key, KiFS directories and user defined functions)
• TABLE: Database Table
• CREDENTIAL: Credential
• CONTEXT: Context
• DATASINK: Data Sink
• DATASOURCE: Data Source
• STORED_PROCEDURE: SQL Procedure
• MONITOR: Table Monitor (Stream)
• USER: User (internal and external) and associated permissions
• ROLE: Role, role members (roles or users, recursively) and associated permissions
• CONFIGURATION: If TRUE, restore the database configuration file. Supported values:
  • FALSE
  • TRUE
  The default value is FALSE.

Parameters:

restoreObjectsMap - The new value for restoreObjectsMap.

Returns:

this to mimic the builder pattern.

getDatasourceName

public String getDatasourceName()

Datasource where backup is located.

Returns:

The current value of datasourceName.

setDatasourceName

public RestoreBackupRequest setDatasourceName(String datasourceName)

Datasource where backup is located.

Parameters:

datasourceName - The new value for datasourceName.

Returns:

this to mimic the builder pattern.

getOptions

public Map<String,String> getOptions()

Optional parameters.

• BACKUP_ID: Backup instance ID to restore. Leave empty to restore the most recent backup instance. The default value is ''.
• RESTORE_POLICY: Behavior to apply when restoring objects that already exist. Supported values:
  • NONE: If an object to be restored currently exists with the same name, abort and return error
  • REPLACE: If an object to be restored currently exists with the same name, replace it with the backup version
  • RENAME: If an object to be restored currently exists with the same name, rename the original version
  The default value is NONE.
• RENAMED_OBJECTS_SCHEMA: If the restore policy is rename, optionally use this schema for renamed objects instead of a default generated one. The default value is ''.
• CREATE_SCHEMA_IF_NOT_EXIST: Create the schema for an object to be restored if it does not currently exist. Error otherwise. Supported values:
  • FALSE
  • TRUE
  The default value is TRUE.
• REINGEST: Restore table data by re-ingesting. If the cluster topology differs from the contained backup this is the default behavior, otherwise restore the persist directly. Supported values:
  • FALSE
  • TRUE
  The default value is FALSE.
• DDL_ONLY: Only recreates the objects from their DDL, do not restore table data. Supported values:
  • TRUE
  • FALSE
  The default value is FALSE.
• CHECKSUM: Verify checksum for backup files. Supported values:
  • FALSE
  • TRUE
  The default value is FALSE.
• DRY_RUN: Does a dry-run restoration operation. Supported values:
  • TRUE
  • FALSE
  The default value is FALSE.

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: Backup instance ID to restore. Leave empty to restore the most recent backup instance. The default value is ''.
• RESTORE_POLICY: Behavior to apply when restoring objects that already exist. Supported values:
  • NONE: If an object to be restored currently exists with the same name, abort and return error
  • REPLACE: If an object to be restored currently exists with the same name, replace it with the backup version
  • RENAME: If an object to be restored currently exists with the same name, rename the original version
  The default value is NONE.
• RENAMED_OBJECTS_SCHEMA: If the restore policy is rename, optionally use this schema for renamed objects instead of a default generated one. The default value is ''.
• CREATE_SCHEMA_IF_NOT_EXIST: Create the schema for an object to be restored if it does not currently exist. Error otherwise. Supported values:
  • FALSE
  • TRUE
  The default value is TRUE.
• REINGEST: Restore table data by re-ingesting. If the cluster topology differs from the contained backup this is the default behavior, otherwise restore the persist directly. Supported values:
  • FALSE
  • TRUE
  The default value is FALSE.
• DDL_ONLY: Only recreates the objects from their DDL, do not restore table data. Supported values:
  • TRUE
  • FALSE
  The default value is FALSE.
• CHECKSUM: Verify checksum for backup files. Supported values:
  • FALSE
  • TRUE
  The default value is FALSE.
• DRY_RUN: Does a dry-run restoration operation. 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