S3ListFiles (SeqWare 1.1.2 API)

java.lang.Object
- net.sourceforge.seqware.pipeline.module.Module
- - net.sourceforge.seqware.pipeline.modules.utilities.S3ListFiles

All Implemented Interfaces:

ModuleInterface
```
public class S3ListFiles
extends Module
```
Purpose: This module simply lists files at the S3 URL you provide. It's less useful in workflows and more likely to be used by end-users to see what's in S3.

Since:

20110928

Version:

$Id: $Id

Author:

boconnor

Field Summary

Fields
Modifier and Type Field and Description

protected String accessKey

protected joptsimple.OptionSet options

protected String secretKey
- Fields inherited from class net.sourceforge.seqware.pipeline.module.Module
  processingAccession, VERSION

Fields
Modifier and Type	Field and Description
`protected String`	`accessKey`
`protected joptsimple.OptionSet`	`options`
`protected String`	`secretKey`

Constructor Summary

Constructors
Constructor and Description

S3ListFiles()

Constructors
Constructor and Description
`S3ListFiles()`

Method Summary

Methods
Modifier and Type	Method and Description
`ReturnValue`	`clean_up()` clean_up.
`ReturnValue`	`do_run()` do_run.
`ReturnValue`	`do_test()` do_test.
`ReturnValue`	`do_verify_input()` do_verify_input.
`ReturnValue`	`do_verify_output()` do_verify_output.
`ReturnValue`	`do_verify_parameters()` do_verify_parameters.
`String`	`get_syntax()` get_syntax.
`protected joptsimple.OptionParser`	`getOptionParser()` getOptionParser.
`ReturnValue`	`init()` init.

Methods inherited from class net.sourceforge.seqware.pipeline.module.Module
get_galaxy_xml, getAlgorithm, getMetadata, getParameters, getProcessingAccession, getStderrFile, getStdoutFile, setAlgorithm, setMetadata, setParameters, setProcessingAccession, setStderrFile, setStdoutFile

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Field Detail
  - options
```
protected joptsimple.OptionSet options
```
  - accessKey
```
protected String accessKey
```
  - secretKey
```
protected String secretKey
```
- Constructor Detail
  - S3ListFiles
```
public S3ListFiles()
```
- Method Detail
  - getOptionParser
```
protected joptsimple.OptionParser getOptionParser()
```
    getOptionParser.
    
    Overrides:
    
    getOptionParser in class Module
    
    Returns:
    a OptionParser object.
  - get_syntax
```
public String get_syntax()
```
    get_syntax.
    
    Specified by:
    
    get_syntax in interface ModuleInterface
    
    Overrides:
    
    get_syntax in class Module
    
    Returns:
    a String object.
  - do_test
```
public ReturnValue do_test()
```
    do_test.
    Not implemented
    
    Specified by:
    
    do_test in interface ModuleInterface
    
    Specified by:
    
    do_test in class Module
    
    Returns:
  - do_verify_parameters
```
public ReturnValue do_verify_parameters()
```
    do_verify_parameters.
    Just makes sure the param was passed in.
    
    Specified by:
    
    do_verify_parameters in interface ModuleInterface
    
    Specified by:
    
    do_verify_parameters in class Module
    
    Returns:
  - do_verify_input
```
public ReturnValue do_verify_input()
```
    do_verify_input.
    
    Specified by:
    
    do_verify_input in interface ModuleInterface
    
    Specified by:
    
    do_verify_input in class Module
    
    Returns:
  - do_run
```
public ReturnValue do_run()
```
    do_run.
    
    Specified by:
    
    do_run in interface ModuleInterface
    
    Specified by:
    
    do_run in class Module
    
    Returns:
  - do_verify_output
```
public ReturnValue do_verify_output()
```
    do_verify_output.
    
    Specified by:
    
    do_verify_output in interface ModuleInterface
    
    Specified by:
    
    do_verify_output in class Module
    
    Returns:
  - init
```
public ReturnValue init()
```
    init.
    
    Specified by:
    
    init in interface ModuleInterface
    
    Overrides:
    
    init in class Module
    
    Returns:
    a ReturnValue object.
  - clean_up
```
public ReturnValue clean_up()
```
    clean_up.
    
    Specified by:
    
    clean_up in interface ModuleInterface
    
    Overrides:
    
    clean_up in class Module
    
    Returns:
    a ReturnValue object.

Class S3ListFiles

Field Summary

Fields inherited from class net.sourceforge.seqware.pipeline.module.Module

Constructor Summary

Method Summary

Methods inherited from class net.sourceforge.seqware.pipeline.module.Module

Methods inherited from class java.lang.Object

Field Detail

options

accessKey

secretKey

Constructor Detail

S3ListFiles

Method Detail

getOptionParser

get_syntax

do_test

do_verify_parameters

do_verify_input

do_run

do_verify_output

init

clean_up