RestoreBackupRequest.Options (Kinetica Java API 7.2.3.4 API)

java.lang.Object
- com.gpudb.protocol.RestoreBackupRequest.Options

Enclosing class:

RestoreBackupRequest
```
public static final class RestoreBackupRequest.Options
extends Object
```
A set of string constants for the RestoreBackupRequest parameter options.
Optional parameters.

Field Summary

Fields
Modifier and Type	Field and Description
`static String`	`BACKUP_ID` ID of the snapshot to restore.
`static String`	`CHECKSUM` Whether or not to verify checksums for backup files when restoring.
`static String`	`CREATE_SCHEMA_IF_NOT_EXIST` Behavior to apply when the schema containing any database object to restore does not already exist.
`static String`	`DDL_ONLY` Behavior to apply when restoring tables.
`static String`	`DRY_RUN` Whether or not to perform a dry run of the restoration operation.
`static String`	`FALSE`
`static String`	`NONE` If an object to be restored already exists with the same name, abort and return error.
`static String`	`REINGEST` Behavior to apply when restoring table data.
`static String`	`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`.
`static String`	`RENAMED_OBJECTS_SCHEMA` If the `RESTORE_POLICY` is `RENAME`, use this schema for relocated existing objects instead of the default generated one.
`static String`	`REPLACE` If an object to be restored already exists with the same name, replace it with the backup version.
`static String`	`RESTORE_POLICY` Behavior to apply when any database object to restore already exists.
`static String`	`TRUE`

Method Summary
- Methods inherited from class java.lang.Object
  clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Field Detail
  - BACKUP_ID
```
public static final String BACKUP_ID
```
    ID of the snapshot to restore. Leave empty to restore the most recent snapshot in the backup. The default value is ''.
    
    See Also:
    
    Constant Field Values
  - RESTORE_POLICY
```
public static final String 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.
    The default value is NONE.
    See Also:
    
    Constant Field Values
  - NONE
```
public static final String NONE
```
    If an object to be restored already exists with the same name, abort and return error.
    
    See Also:
    
    Constant Field Values
  - REPLACE
```
public static final String REPLACE
```
    If an object to be restored already exists with the same name, replace it with the backup version.
    
    See Also:
    
    Constant Field Values
  - RENAME
```
public static final String 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.
    
    See Also:
    
    Constant Field Values
  - RENAMED_OBJECTS_SCHEMA
```
public static final String 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 ''.
    
    See Also:
    
    Constant Field Values
  - CREATE_SCHEMA_IF_NOT_EXIST
```
public static final String 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.
    See Also:
    
    Constant Field Values
  - TRUE
```
public static final String TRUE
```
    See Also:
    
    Constant Field Values
  - FALSE
```
public static final String FALSE
```
    See Also:
    
    Constant Field Values
  - REINGEST
```
public static final String 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.
    See Also:
    
    Constant Field Values
  - DDL_ONLY
```
public static final String 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.
    See Also:
    
    Constant Field Values
  - CHECKSUM
```
public static final String CHECKSUM
```
    Whether or not to verify checksums for backup files when restoring. Supported values:
    - TRUE
    - FALSE
    The default value is FALSE.
    See Also:
    
    Constant Field Values
  - DRY_RUN
```
public static final String DRY_RUN
```
    Whether or not to perform a dry run of the restoration operation. Supported values:
    - TRUE
    - FALSE
    The default value is FALSE.
    See Also:
    
    Constant Field Values

Class RestoreBackupRequest.Options

Field Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

BACKUP_ID

RESTORE_POLICY

NONE

REPLACE

RENAME

RENAMED_OBJECTS_SCHEMA

CREATE_SCHEMA_IF_NOT_EXIST

TRUE

FALSE

REINGEST

DDL_ONLY

CHECKSUM

DRY_RUN