Skip to main content
Package com.gpudb.protocol

​
Class ShowFilesRequest

java.lang.Object
com.gpudb.protocol.ShowFilesRequest
All Implemented Interfaces:
org.apache.avro.generic.GenericContainer, org.apache.avro.generic.IndexedRecord
public class ShowFilesRequest extends Object implements org.apache.avro.generic.IndexedRecord
A set of parameters for GPUdb.showFiles.

Shows information about files in KiFS. Can be used for individual files, or to show all files in a given directory.

  • ​
    Constructor Details

    • ​
      ShowFilesRequest

      public ShowFilesRequest()
      Constructs a ShowFilesRequest object with default parameters.

    • ​
      ShowFilesRequest

      public ShowFilesRequest(List<String> paths, Map<String,String> options)
      Constructs a ShowFilesRequest object with the specified parameters.
      Parameters:
      paths - File paths to show. Each path can be a KiFS directory name, or a full path to a KiFS file. 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. The default value is an empty Map.

  • ​
    Method Details

    • ​
      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.

    • ​
      getPaths

      public List<String> getPaths()
      File paths to show. Each path can be a KiFS directory name, or a full path to a KiFS file. 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 paths.

    • ​
      setPaths

      public ShowFilesRequest setPaths(List<String> paths)
      File paths to show. Each path can be a KiFS directory name, or a full path to a KiFS file. 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:
      paths - The new value for paths.
      Returns:
      this to mimic the builder pattern.

    • ​
      getOptions

      public Map<String,String> getOptions()
      Optional parameters. The default value is an empty Map.
      Returns:
      The current value of options.

    • ​
      setOptions

      public ShowFilesRequest setOptions(Map<String,String> options)
      Optional parameters. 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