Package com.gpudb.protocol

Class AlterBackupRequest

java.lang.Object

com.gpudb.protocol.AlterBackupRequest

All Implemented Interfaces:

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

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

A set of parameters for GPUdb.alterBackup.

Alters an existing database backup, accessible via the data sink specified by datasinkName.

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	AlterBackupRequest.Action	A set of string constants for the AlterBackupRequest parameter action.
static class	AlterBackupRequest.Options	A set of string constants for the AlterBackupRequest parameter options.

Constructor Summary

Constructors

Constructor	Description
AlterBackupRequest()	Constructs an AlterBackupRequest object with default parameters.
AlterBackupRequest(String backupName, String action, String value, String datasinkName, Map<String,String> options)	Constructs an AlterBackupRequest 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	getAction()	Operation to be applied.
String	getBackupName()	Name of the backup to be altered.
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 is accessible.
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.
String	getValue()	Value of the modification, depending on action.
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.
AlterBackupRequest	setAction(String action)	Operation to be applied.
AlterBackupRequest	setBackupName(String backupName)	Name of the backup to be altered.
AlterBackupRequest	setDatasinkName(String datasinkName)	Data sink through which the backup is accessible.
AlterBackupRequest	setOptions(Map<String,String> options)	Optional parameters.
AlterBackupRequest	setValue(String value)	Value of the modification, depending on action.
String	toString()

Methods inherited from class java.lang.Object

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

Constructor Detail

AlterBackupRequest

public AlterBackupRequest()

Constructs an AlterBackupRequest object with default parameters.

AlterBackupRequest

public AlterBackupRequest(String backupName,
                          String action,
                          String value,
                          String datasinkName,
                          Map<String,String> options)

Constructs an AlterBackupRequest object with the specified parameters.

Parameters:

backupName - Name of the backup to be altered.

action - Operation to be applied. Supported values:

• CHECKSUM: Calculate checksum for backed-up files.
• DDL_ONLY: Whether or not to only save DDL and not back up table data, when taking future snapshots; set value to 'true' or 'false' for DDL only or DDL and table data, respectively.
• MAX_INCREMENTAL_BACKUPS_TO_KEEP: Maximum number of incremental snapshots to keep, when taking future snapshots; set value to the number of snapshots to keep.
• MERGE: Merges all snapshots within a backup and creates a single full snapshot.
• PURGE: Deletes a snapshot from a backup; set value to the snapshot ID to purge.

value - Value of the modification, depending on action.

datasinkName - Data sink through which the backup is accessible.

options - Optional parameters.

• COMMENT: Comments to store with the backup.
• DRY_RUN: Whether or not to perform a dry run of a backup alteration. 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 to be altered.

Returns:

The current value of backupName.

setBackupName

public AlterBackupRequest setBackupName(String backupName)

Name of the backup to be altered.

Parameters:

backupName - The new value for backupName.

Returns:

this to mimic the builder pattern.

getAction

public String getAction()

Operation to be applied. Supported values:

• CHECKSUM: Calculate checksum for backed-up files.
• DDL_ONLY: Whether or not to only save DDL and not back up table data, when taking future snapshots; set value to 'true' or 'false' for DDL only or DDL and table data, respectively.
• MAX_INCREMENTAL_BACKUPS_TO_KEEP: Maximum number of incremental snapshots to keep, when taking future snapshots; set value to the number of snapshots to keep.
• MERGE: Merges all snapshots within a backup and creates a single full snapshot.
• PURGE: Deletes a snapshot from a backup; set value to the snapshot ID to purge.

Returns:

The current value of action.

setAction

public AlterBackupRequest setAction(String action)

Operation to be applied. Supported values:

• CHECKSUM: Calculate checksum for backed-up files.
• DDL_ONLY: Whether or not to only save DDL and not back up table data, when taking future snapshots; set value to 'true' or 'false' for DDL only or DDL and table data, respectively.
• MAX_INCREMENTAL_BACKUPS_TO_KEEP: Maximum number of incremental snapshots to keep, when taking future snapshots; set value to the number of snapshots to keep.
• MERGE: Merges all snapshots within a backup and creates a single full snapshot.
• PURGE: Deletes a snapshot from a backup; set value to the snapshot ID to purge.

Parameters:

action - The new value for action.

Returns:

this to mimic the builder pattern.

getValue

public String getValue()

Value of the modification, depending on action.

Returns:

The current value of value.

setValue

public AlterBackupRequest setValue(String value)

Value of the modification, depending on action.

Parameters:

value - The new value for value.

Returns:

this to mimic the builder pattern.

getDatasinkName

public String getDatasinkName()

Data sink through which the backup is accessible.

Returns:

The current value of datasinkName.

setDatasinkName

public AlterBackupRequest setDatasinkName(String datasinkName)

Data sink through which the backup is accessible.

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 the backup.
• DRY_RUN: Whether or not to perform a dry run of a backup alteration. Supported values:
  • TRUE
  • FALSE
  The default value is FALSE.

The default value is an empty Map.

Returns:

The current value of options.

setOptions

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

Optional parameters.

• COMMENT: Comments to store with the backup.
• DRY_RUN: Whether or not to perform a dry run of a backup alteration. 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