InputParameter (dnanexus-api 0.1.0-SNAPSHOT API)

java.lang.Object
- com.dnanexus.InputParameter

public class InputParameter
extends Object

An input parameter for an executable.

Nested Class Summary

Nested Classes
Modifier and Type Class Description

static class InputParameter.Builder
Builder class for creating new input parameters.

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method	Description
`IOClass`	`getIOClass()`	Returns the class of the parameter.
`String`	`getName()`	Returns the name of the parameter.
`boolean`	`isOptional()`	Returns whether the parameter is optional.
`static InputParameter.Builder`	`newInputParameter(String name, IOClass parameterClass)`	Returns a new input parameter builder initialized with the specified input name and class.

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

- Method Detail
  - newInputParameter
```
public static InputParameter.Builder newInputParameter(String name,
                                                       IOClass parameterClass)
```
    Returns a new input parameter builder initialized with the specified input name and class.
    
    Parameters:
    
    name - name of the input to be created
    
    parameterClass - class of the input to be created
    
    Returns:
    
    an input parameter builder
  - getIOClass
```
public IOClass getIOClass()
```
    Returns the class of the parameter.
    
    Returns:
    
    class name
  - getName
```
public String getName()
```
    Returns the name of the parameter.
    
    Returns:
    
    parameter name
  - isOptional
```
public boolean isOptional()
```
    Returns whether the parameter is optional.
    
    Returns:
    
    true if optional