Package com.gpudb.protocol

Class DropBackupRequest

java.lang.Object

com.gpudb.protocol.DropBackupRequest

All Implemented Interfaces:

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

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

A set of parameters for GPUdb.dropBackup.

Deletes one or more existing database backups and contained snapshots, accessible via the data sink specified by datasinkName.

Nested Class Summary

Nested Classes

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

Constructor Summary

Constructors

Constructor	Description
DropBackupRequest()	Constructs a DropBackupRequest object with default parameters.
DropBackupRequest(String backupName, String datasinkName, Map<String,String> options)	Constructs a DropBackupRequest 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 of the backup to be deleted.
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.
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.
DropBackupRequest	setBackupName(String backupName)	Name of the backup to be deleted.
DropBackupRequest	setDatasinkName(String datasinkName)	Data sink through which the backup is accessible.
DropBackupRequest	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

DropBackupRequest

public DropBackupRequest()

Constructs a DropBackupRequest object with default parameters.

DropBackupRequest

public DropBackupRequest(String backupName,
                         String datasinkName,
                         Map<String,String> options)

Constructs a DropBackupRequest object with the specified parameters.

Parameters:

backupName - Name of the backup to be deleted. An empty string or '*' will delete all existing backups. Any text followed by a '*' will delete backups whose name starts with that text. When deleting multiple backups, DELETE_ALL_BACKUPS must be set to TRUE.

datasinkName - Data sink through which the backup is accessible.

options - Optional parameters.

• DRY_RUN: Whether or not to perform a dry run of a backup deletion. Supported values:
  • TRUE
  • FALSE
  The default value is FALSE.
• DELETE_ALL_BACKUPS: Allow multiple backups to be deleted if TRUE and multiple backup names are found matching backupName. Supported values:
  • TRUE
  • FALSE
  The default value is FALSE.
• NO_ERROR_IF_NOT_EXISTS: Whether or not to suppress the error if the specified backup does not exist. 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 deleted. An empty string or '*' will delete all existing backups. Any text followed by a '*' will delete backups whose name starts with that text. When deleting multiple backups, DELETE_ALL_BACKUPS must be set to TRUE.

Returns:

The current value of backupName.

setBackupName

public DropBackupRequest setBackupName(String backupName)

Name of the backup to be deleted. An empty string or '*' will delete all existing backups. Any text followed by a '*' will delete backups whose name starts with that text. When deleting multiple backups, DELETE_ALL_BACKUPS must be set to TRUE.

Parameters:

backupName - The new value for backupName.

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 DropBackupRequest 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.

• DRY_RUN: Whether or not to perform a dry run of a backup deletion. Supported values:
  • TRUE
  • FALSE
  The default value is FALSE.
• DELETE_ALL_BACKUPS: Allow multiple backups to be deleted if TRUE and multiple backup names are found matching backupName. Supported values:
  • TRUE
  • FALSE
  The default value is FALSE.
• NO_ERROR_IF_NOT_EXISTS: Whether or not to suppress the error if the specified backup does not exist. Supported values:
  • TRUE
  • FALSE
  The default value is FALSE.

The default value is an empty Map.

Returns:

The current value of options.

setOptions

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

Optional parameters.

• DRY_RUN: Whether or not to perform a dry run of a backup deletion. Supported values:
  • TRUE
  • FALSE
  The default value is FALSE.
• DELETE_ALL_BACKUPS: Allow multiple backups to be deleted if TRUE and multiple backup names are found matching backupName. Supported values:
  • TRUE
  • FALSE
  The default value is FALSE.
• NO_ERROR_IF_NOT_EXISTS: Whether or not to suppress the error if the specified backup does not exist. 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