ReadOptions (AWS SDK for Java

java.lang.Object
- com.amazonaws.services.omics.model.ReadOptions

All Implemented Interfaces:: StructuredPojo, Serializable, Cloneable

@Generated(value="com.amazonaws:aws-java-sdk-code-generator")
public class ReadOptions
extends Object
implements Serializable, Cloneable, StructuredPojo

Read options for an annotation import job.

See Also:: AWS API Documentation, Serialized Form

Constructor Summary

Constructors
Constructor and Description

ReadOptions()

Constructors
Constructor and Description
`ReadOptions()`

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`ReadOptions`	`clone()`
`boolean`	`equals(Object obj)`
`String`	`getComment()` The file's comment character.
`String`	`getEncoding()` The file's encoding.
`String`	`getEscape()` A character for escaping quotes in the file.
`Boolean`	`getEscapeQuotes()` Whether quotes need to be escaped in the file.
`Boolean`	`getHeader()` Whether the file has a header row.
`String`	`getLineSep()` A line separator for the file.
`String`	`getQuote()` The file's quote character.
`Boolean`	`getQuoteAll()` Whether all values need to be quoted, or just those that contain quotes.
`String`	`getSep()` The file's field separator.
`int`	`hashCode()`
`Boolean`	`isEscapeQuotes()` Whether quotes need to be escaped in the file.
`Boolean`	`isHeader()` Whether the file has a header row.
`Boolean`	`isQuoteAll()` Whether all values need to be quoted, or just those that contain quotes.
`void`	`marshall(ProtocolMarshaller protocolMarshaller)` Marshalls this structured data using the given `ProtocolMarshaller`.
`void`	`setComment(String comment)` The file's comment character.
`void`	`setEncoding(String encoding)` The file's encoding.
`void`	`setEscape(String escape)` A character for escaping quotes in the file.
`void`	`setEscapeQuotes(Boolean escapeQuotes)` Whether quotes need to be escaped in the file.
`void`	`setHeader(Boolean header)` Whether the file has a header row.
`void`	`setLineSep(String lineSep)` A line separator for the file.
`void`	`setQuote(String quote)` The file's quote character.
`void`	`setQuoteAll(Boolean quoteAll)` Whether all values need to be quoted, or just those that contain quotes.
`void`	`setSep(String sep)` The file's field separator.
`String`	`toString()` Returns a string representation of this object.
`ReadOptions`	`withComment(String comment)` The file's comment character.
`ReadOptions`	`withEncoding(String encoding)` The file's encoding.
`ReadOptions`	`withEscape(String escape)` A character for escaping quotes in the file.
`ReadOptions`	`withEscapeQuotes(Boolean escapeQuotes)` Whether quotes need to be escaped in the file.
`ReadOptions`	`withHeader(Boolean header)` Whether the file has a header row.
`ReadOptions`	`withLineSep(String lineSep)` A line separator for the file.
`ReadOptions`	`withQuote(String quote)` The file's quote character.
`ReadOptions`	`withQuoteAll(Boolean quoteAll)` Whether all values need to be quoted, or just those that contain quotes.
`ReadOptions`	`withSep(String sep)` The file's field separator.

Methods inherited from class java.lang.Object
getClass, notify, notifyAll, wait, wait, wait

- Constructor Detail
  - ReadOptions
```
public ReadOptions()
```
- Method Detail
  - setComment
```
public void setComment(String comment)
```
    The file's comment character.
    
    Parameters:
    
    comment - The file's comment character.
  - getComment
```
public String getComment()
```
    The file's comment character.
    
    Returns:
    
    The file's comment character.
  - withComment
```
public ReadOptions withComment(String comment)
```
    The file's comment character.
    
    Parameters:
    
    comment - The file's comment character.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setEncoding
```
public void setEncoding(String encoding)
```
    The file's encoding.
    
    Parameters:
    
    encoding - The file's encoding.
  - getEncoding
```
public String getEncoding()
```
    The file's encoding.
    
    Returns:
    
    The file's encoding.
  - withEncoding
```
public ReadOptions withEncoding(String encoding)
```
    The file's encoding.
    
    Parameters:
    
    encoding - The file's encoding.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setEscape
```
public void setEscape(String escape)
```
    A character for escaping quotes in the file.
    
    Parameters:
    
    escape - A character for escaping quotes in the file.
  - getEscape
```
public String getEscape()
```
    A character for escaping quotes in the file.
    
    Returns:
    
    A character for escaping quotes in the file.
  - withEscape
```
public ReadOptions withEscape(String escape)
```
    A character for escaping quotes in the file.
    
    Parameters:
    
    escape - A character for escaping quotes in the file.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setEscapeQuotes
```
public void setEscapeQuotes(Boolean escapeQuotes)
```
    Whether quotes need to be escaped in the file.
    
    Parameters:
    
    escapeQuotes - Whether quotes need to be escaped in the file.
  - getEscapeQuotes
```
public Boolean getEscapeQuotes()
```
    Whether quotes need to be escaped in the file.
    
    Returns:
    
    Whether quotes need to be escaped in the file.
  - withEscapeQuotes
```
public ReadOptions withEscapeQuotes(Boolean escapeQuotes)
```
    Whether quotes need to be escaped in the file.
    
    Parameters:
    
    escapeQuotes - Whether quotes need to be escaped in the file.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - isEscapeQuotes
```
public Boolean isEscapeQuotes()
```
    Whether quotes need to be escaped in the file.
    
    Returns:
    
    Whether quotes need to be escaped in the file.
  - setHeader
```
public void setHeader(Boolean header)
```
    Whether the file has a header row.
    
    Parameters:
    
    header - Whether the file has a header row.
  - getHeader
```
public Boolean getHeader()
```
    Whether the file has a header row.
    
    Returns:
    
    Whether the file has a header row.
  - withHeader
```
public ReadOptions withHeader(Boolean header)
```
    Whether the file has a header row.
    
    Parameters:
    
    header - Whether the file has a header row.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - isHeader
```
public Boolean isHeader()
```
    Whether the file has a header row.
    
    Returns:
    
    Whether the file has a header row.
  - setLineSep
```
public void setLineSep(String lineSep)
```
    A line separator for the file.
    
    Parameters:
    
    lineSep - A line separator for the file.
  - getLineSep
```
public String getLineSep()
```
    A line separator for the file.
    
    Returns:
    
    A line separator for the file.
  - withLineSep
```
public ReadOptions withLineSep(String lineSep)
```
    A line separator for the file.
    
    Parameters:
    
    lineSep - A line separator for the file.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setQuote
```
public void setQuote(String quote)
```
    The file's quote character.
    
    Parameters:
    
    quote - The file's quote character.
  - getQuote
```
public String getQuote()
```
    The file's quote character.
    
    Returns:
    
    The file's quote character.
  - withQuote
```
public ReadOptions withQuote(String quote)
```
    The file's quote character.
    
    Parameters:
    
    quote - The file's quote character.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setQuoteAll
```
public void setQuoteAll(Boolean quoteAll)
```
    Whether all values need to be quoted, or just those that contain quotes.
    
    Parameters:
    
    quoteAll - Whether all values need to be quoted, or just those that contain quotes.
  - getQuoteAll
```
public Boolean getQuoteAll()
```
    Whether all values need to be quoted, or just those that contain quotes.
    
    Returns:
    
    Whether all values need to be quoted, or just those that contain quotes.
  - withQuoteAll
```
public ReadOptions withQuoteAll(Boolean quoteAll)
```
    Whether all values need to be quoted, or just those that contain quotes.
    
    Parameters:
    
    quoteAll - Whether all values need to be quoted, or just those that contain quotes.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - isQuoteAll
```
public Boolean isQuoteAll()
```
    Whether all values need to be quoted, or just those that contain quotes.
    
    Returns:
    
    Whether all values need to be quoted, or just those that contain quotes.
  - setSep
```
public void setSep(String sep)
```
    The file's field separator.
    
    Parameters:
    
    sep - The file's field separator.
  - getSep
```
public String getSep()
```
    The file's field separator.
    
    Returns:
    
    The file's field separator.
  - withSep
```
public ReadOptions withSep(String sep)
```
    The file's field separator.
    
    Parameters:
    
    sep - The file's field separator.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - toString
```
public String toString()
```
    Returns a string representation of this object. This is useful for testing and debugging. Sensitive data will be redacted from this string using a placeholder value.
    
    Overrides:
    
    toString in class Object
    
    Returns:
    
    A string representation of this object.
    
    See Also:
    
    Object.toString()
  - equals
```
public boolean equals(Object obj)
```
    Overrides:
    
    equals in class Object
  - hashCode
```
public int hashCode()
```
    Overrides:
    
    hashCode in class Object
  - clone
```
public ReadOptions clone()
```
    Overrides:
    
    clone in class Object
  - marshall
```
public void marshall(ProtocolMarshaller protocolMarshaller)
```
    Description copied from interface: StructuredPojo
    
    Marshalls this structured data using the given ProtocolMarshaller.
    
    Specified by:
    
    marshall in interface StructuredPojo
    
    Parameters:
    
    protocolMarshaller - Implementation of ProtocolMarshaller used to marshall this object's data.

Did this page help you?

Class ReadOptions

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

ReadOptions

Method Detail

setComment

getComment

withComment

setEncoding

getEncoding

withEncoding

setEscape

getEscape

withEscape

setEscapeQuotes

getEscapeQuotes

withEscapeQuotes

isEscapeQuotes

setHeader

getHeader

withHeader

isHeader

setLineSep

getLineSep

withLineSep

setQuote

getQuote

withQuote

setQuoteAll

getQuoteAll

withQuoteAll

isQuoteAll

setSep

getSep

withSep

toString

equals

hashCode

clone

marshall