Package com.gpudb.protocol

Class DeleteFilesRequest

java.lang.Object

com.gpudb.protocol.DeleteFilesRequest

All Implemented Interfaces:

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

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

A set of parameters for GPUdb.deleteFiles.

Deletes one or more files from KiFS.

Nested Class Summary

Nested Classes

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

Constructor Summary

Constructors

Constructor	Description
DeleteFilesRequest()	Constructs a DeleteFilesRequest object with default parameters.
DeleteFilesRequest(List<String> fileNames, Map<String,String> options)	Constructs a DeleteFilesRequest 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.
static org.apache.avro.Schema	getClassSchema()	This method supports the Avro framework and is not intended to be called directly by the user.
List<String>	getFileNames()	An array of names of files to be deleted.
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.
DeleteFilesRequest	setFileNames(List<String> fileNames)	An array of names of files to be deleted.
DeleteFilesRequest	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

DeleteFilesRequest

public DeleteFilesRequest()

Constructs a DeleteFilesRequest object with default parameters.

DeleteFilesRequest

public DeleteFilesRequest(List<String> fileNames,
                          Map<String,String> options)

Constructs a DeleteFilesRequest object with the specified parameters.

Parameters:

fileNames - An array of names of files to be deleted. File paths may contain wildcard characters after the KiFS directory delimiter. Accepted wildcard characters are asterisk (*) to represent any string of zero or more characters, and question mark (?) to indicate a single character.

options - Optional parameters.

• NO_ERROR_IF_NOT_EXISTS: If TRUE, no error is returned if a specified file 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.

getFileNames

public List<String> getFileNames()

An array of names of files to be deleted. File paths may contain wildcard characters after the KiFS directory delimiter.

Accepted wildcard characters are asterisk (*) to represent any string of zero or more characters, and question mark (?) to indicate a single character.

Returns:

The current value of fileNames.

setFileNames

public DeleteFilesRequest setFileNames(List<String> fileNames)

An array of names of files to be deleted. File paths may contain wildcard characters after the KiFS directory delimiter.

Accepted wildcard characters are asterisk (*) to represent any string of zero or more characters, and question mark (?) to indicate a single character.

Parameters:

fileNames - The new value for fileNames.

Returns:

this to mimic the builder pattern.

getOptions

public Map<String,String> getOptions()

Optional parameters.

• NO_ERROR_IF_NOT_EXISTS: If TRUE, no error is returned if a specified file 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 DeleteFilesRequest setOptions(Map<String,String> options)

Optional parameters.

• NO_ERROR_IF_NOT_EXISTS: If TRUE, no error is returned if a specified file 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