Package com.gpudb.protocol

Class CreateBackupRequest

java.lang.Object

com.gpudb.protocol.CreateBackupRequest

All Implemented Interfaces:

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

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

A set of parameters for GPUdb.createBackup.

Creates a database backup, containing a snapshot of existing objects, at the remote file store accessible via the data sink specified by datasinkName.

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	CreateBackupRequest.BackupObjectsMap	A set of string constants for the CreateBackupRequest parameter backupObjectsMap.
static class	CreateBackupRequest.BackupType	A set of string constants for the CreateBackupRequest parameter backupType.
static class	CreateBackupRequest.Options	A set of string constants for the CreateBackupRequest parameter options.

Constructor Summary

Constructors

Constructor	Description
CreateBackupRequest()	Constructs a CreateBackupRequest object with default parameters.
CreateBackupRequest(String backupName, String backupType, Map<String,String> backupObjectsMap, String datasinkName, Map<String,String> options)	Constructs a CreateBackupRequest object with the specified parameters.

Method Summary

Modifier and Type	Method	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 for this backup.
Map<String,String>	getBackupObjectsMap()	Map of objects to be captured in the backup; must be specified when creating a full snapshot and left unspecified when creating an incremental or differential snapshot.
String	getBackupType()	Type of snapshot to create.
static org.apache.avro.Schema	getClassSchema()	This method supports the Avro framework and is not intended to be called directly by the user.
String	getDatasinkName()	Data sink through which the backup will be stored.
Map<String,String>	getOptions()	Optional parameters.
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.
CreateBackupRequest	setBackupName(String backupName)	Name for this backup.
CreateBackupRequest	setBackupObjectsMap(Map<String,String> backupObjectsMap)	Map of objects to be captured in the backup; must be specified when creating a full snapshot and left unspecified when creating an incremental or differential snapshot.
CreateBackupRequest	setBackupType(String backupType)	Type of snapshot to create.
CreateBackupRequest	setDatasinkName(String datasinkName)	Data sink through which the backup will be stored.
CreateBackupRequest	setOptions(Map<String,String> options)	Optional parameters.
String	toString()

Methods inherited from class java.lang.Object

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

Constructor Detail

CreateBackupRequest

public CreateBackupRequest()

Constructs a CreateBackupRequest object with default parameters.

CreateBackupRequest

public CreateBackupRequest(String backupName,
                           String backupType,
                           Map<String,String> backupObjectsMap,
                           String datasinkName,
                           Map<String,String> options)

Constructs a CreateBackupRequest object with the specified parameters.

Parameters:

backupName - Name for this backup. If the backup already exists, only an incremental or differential backup can be made, unless RECREATE is set to TRUE.

backupType - Type of snapshot to create. Supported values:

• INCREMENTAL: Snapshot of changes in the database objects and data since the last snapshot of any kind.
• DIFFERENTIAL: Snapshot of changes in the database objects and data since the last full snapshot.
• FULL: Snapshot of the given database objects and data.

backupObjectsMap - Map of objects to be captured in the backup; must be specified when creating a full snapshot and left unspecified when creating an incremental or differential snapshot.

• ALL: All object types and data contained in the given schemas(s).
• TABLE: Tables(s) and SQL view(s).
• CATALOG: Catalog
• CREDENTIAL: Credential(s).
• CONTEXT: Context(s).
• DATASINK: Data sink(s).
• DATASOURCE: Data source(s).
• STORED_PROCEDURE: SQL procedure(s).
• MONITOR: Table monitor(s) / SQL stream(s).
• USER: User(s) (internal and external) and associated permissions.
• ROLE: Role(s), role members (roles or users, recursively), and associated permissions.
• CONFIGURATION: If TRUE, backup the database configuration file. Supported values:
  • TRUE
  • FALSE
  The default value is FALSE.

datasinkName - Data sink through which the backup will be stored.

options - Optional parameters.

• COMMENT: Comments to store with this backup.
• CHECKSUM: Whether or not to calculate checksums for backup files. Supported values:
  • TRUE
  • FALSE
  The default value is FALSE.
• DDL_ONLY: Whether or not, for tables, to only backup DDL and not table data. Supported values:
  • TRUE: For tables, only back up DDL, not data.
  • FALSE: For tables, back up DDL and data.
  The default value is FALSE.
• MAX_INCREMENTAL_BACKUPS_TO_KEEP: Maximum number of incremental snapshots to keep. The default value is '-1'.
• DELETE_INTERMEDIATE_BACKUPS: Whether or not to delete any intermediate snapshots when the backupType is set to DIFFERENTIAL. Supported values:
  • TRUE
  • FALSE
  The default value is FALSE.
• RECREATE: Whether or not to replace an existing backup object with a new backup with a full snapshot, if one already exists. Supported values:
  • TRUE
  • FALSE
  The default value is FALSE.
• DRY_RUN: Whether or not to perform a dry run of a backup 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 for this backup. If the backup already exists, only an incremental or differential backup can be made, unless RECREATE is set to TRUE.

Returns:

The current value of backupName.

setBackupName

public CreateBackupRequest setBackupName(String backupName)

Name for this backup. If the backup already exists, only an incremental or differential backup can be made, unless RECREATE is set to TRUE.

Parameters:

backupName - The new value for backupName.

Returns:

this to mimic the builder pattern.

getBackupType

public String getBackupType()

Type of snapshot to create. Supported values:

• INCREMENTAL: Snapshot of changes in the database objects and data since the last snapshot of any kind.
• DIFFERENTIAL: Snapshot of changes in the database objects and data since the last full snapshot.
• FULL: Snapshot of the given database objects and data.

Returns:

The current value of backupType.

setBackupType

public CreateBackupRequest setBackupType(String backupType)

Type of snapshot to create. Supported values:

• INCREMENTAL: Snapshot of changes in the database objects and data since the last snapshot of any kind.
• DIFFERENTIAL: Snapshot of changes in the database objects and data since the last full snapshot.
• FULL: Snapshot of the given database objects and data.

Parameters:

backupType - The new value for backupType.

Returns:

this to mimic the builder pattern.

getBackupObjectsMap

public Map<String,String> getBackupObjectsMap()

Map of objects to be captured in the backup; must be specified when creating a full snapshot and left unspecified when creating an incremental or differential snapshot.

• ALL: All object types and data contained in the given schemas(s).
• TABLE: Tables(s) and SQL view(s).
• CATALOG: Catalog
• CREDENTIAL: Credential(s).
• CONTEXT: Context(s).
• DATASINK: Data sink(s).
• DATASOURCE: Data source(s).
• STORED_PROCEDURE: SQL procedure(s).
• MONITOR: Table monitor(s) / SQL stream(s).
• USER: User(s) (internal and external) and associated permissions.
• ROLE: Role(s), role members (roles or users, recursively), and associated permissions.
• CONFIGURATION: If TRUE, backup the database configuration file. Supported values:
  • TRUE
  • FALSE
  The default value is FALSE.

Returns:

The current value of backupObjectsMap.

setBackupObjectsMap

public CreateBackupRequest setBackupObjectsMap(Map<String,String> backupObjectsMap)

Map of objects to be captured in the backup; must be specified when creating a full snapshot and left unspecified when creating an incremental or differential snapshot.

• ALL: All object types and data contained in the given schemas(s).
• TABLE: Tables(s) and SQL view(s).
• CATALOG: Catalog
• CREDENTIAL: Credential(s).
• CONTEXT: Context(s).
• DATASINK: Data sink(s).
• DATASOURCE: Data source(s).
• STORED_PROCEDURE: SQL procedure(s).
• MONITOR: Table monitor(s) / SQL stream(s).
• USER: User(s) (internal and external) and associated permissions.
• ROLE: Role(s), role members (roles or users, recursively), and associated permissions.
• CONFIGURATION: If TRUE, backup the database configuration file. Supported values:
  • TRUE
  • FALSE
  The default value is FALSE.

Parameters:

backupObjectsMap - The new value for backupObjectsMap.

Returns:

this to mimic the builder pattern.

getDatasinkName

public String getDatasinkName()

Data sink through which the backup will be stored.

Returns:

The current value of datasinkName.

setDatasinkName

public CreateBackupRequest setDatasinkName(String datasinkName)

Data sink through which the backup will be stored.

Parameters:

datasinkName - The new value for datasinkName.

Returns:

this to mimic the builder pattern.

getOptions

public Map<String,String> getOptions()

Optional parameters.

• COMMENT: Comments to store with this backup.
• CHECKSUM: Whether or not to calculate checksums for backup files. Supported values:
  • TRUE
  • FALSE
  The default value is FALSE.
• DDL_ONLY: Whether or not, for tables, to only backup DDL and not table data. Supported values:
  • TRUE: For tables, only back up DDL, not data.
  • FALSE: For tables, back up DDL and data.
  The default value is FALSE.
• MAX_INCREMENTAL_BACKUPS_TO_KEEP: Maximum number of incremental snapshots to keep. The default value is '-1'.
• DELETE_INTERMEDIATE_BACKUPS: Whether or not to delete any intermediate snapshots when the backupType is set to DIFFERENTIAL. Supported values:
  • TRUE
  • FALSE
  The default value is FALSE.
• RECREATE: Whether or not to replace an existing backup object with a new backup with a full snapshot, if one already exists. Supported values:
  • TRUE
  • FALSE
  The default value is FALSE.
• DRY_RUN: Whether or not to perform a dry run of a backup 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 CreateBackupRequest setOptions(Map<String,String> options)

Optional parameters.

• COMMENT: Comments to store with this backup.
• CHECKSUM: Whether or not to calculate checksums for backup files. Supported values:
  • TRUE
  • FALSE
  The default value is FALSE.
• DDL_ONLY: Whether or not, for tables, to only backup DDL and not table data. Supported values:
  • TRUE: For tables, only back up DDL, not data.
  • FALSE: For tables, back up DDL and data.
  The default value is FALSE.
• MAX_INCREMENTAL_BACKUPS_TO_KEEP: Maximum number of incremental snapshots to keep. The default value is '-1'.
• DELETE_INTERMEDIATE_BACKUPS: Whether or not to delete any intermediate snapshots when the backupType is set to DIFFERENTIAL. Supported values:
  • TRUE
  • FALSE
  The default value is FALSE.
• RECREATE: Whether or not to replace an existing backup object with a new backup with a full snapshot, if one already exists. Supported values:
  • TRUE
  • FALSE
  The default value is FALSE.
• DRY_RUN: Whether or not to perform a dry run of a backup 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