CsvFormatDescriptor (AWS SDK for Java

java.lang.Object
- com.amazonaws.services.lookoutmetrics.model.CsvFormatDescriptor

All Implemented Interfaces:

StructuredPojo, Serializable, Cloneable
```
@Generated(value="com.amazonaws:aws-java-sdk-code-generator")
public class CsvFormatDescriptor
extends Object
implements Serializable, Cloneable, StructuredPojo
```
Contains information about how a source CSV data file should be analyzed.

See Also:

AWS API Documentation, Serialized Form

Constructor Summary

Constructors
Constructor and Description

CsvFormatDescriptor()

Constructors
Constructor and Description
`CsvFormatDescriptor()`

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`CsvFormatDescriptor`	`clone()`
`boolean`	`equals(Object obj)`
`String`	`getCharset()` The character set in which the source CSV file is written.
`Boolean`	`getContainsHeader()` Whether or not the source CSV file contains a header.
`String`	`getDelimiter()` The character used to delimit the source CSV file.
`String`	`getFileCompression()` The level of compression of the source CSV file.
`List<String>`	`getHeaderList()` A list of the source CSV file's headers, if any.
`String`	`getQuoteSymbol()` The character used as a quote character.
`int`	`hashCode()`
`Boolean`	`isContainsHeader()` Whether or not the source CSV file contains a header.
`void`	`marshall(ProtocolMarshaller protocolMarshaller)` Marshalls this structured data using the given `ProtocolMarshaller`.
`void`	`setCharset(String charset)` The character set in which the source CSV file is written.
`void`	`setContainsHeader(Boolean containsHeader)` Whether or not the source CSV file contains a header.
`void`	`setDelimiter(String delimiter)` The character used to delimit the source CSV file.
`void`	`setFileCompression(String fileCompression)` The level of compression of the source CSV file.
`void`	`setHeaderList(Collection<String> headerList)` A list of the source CSV file's headers, if any.
`void`	`setQuoteSymbol(String quoteSymbol)` The character used as a quote character.
`String`	`toString()` Returns a string representation of this object.
`CsvFormatDescriptor`	`withCharset(String charset)` The character set in which the source CSV file is written.
`CsvFormatDescriptor`	`withContainsHeader(Boolean containsHeader)` Whether or not the source CSV file contains a header.
`CsvFormatDescriptor`	`withDelimiter(String delimiter)` The character used to delimit the source CSV file.
`CsvFormatDescriptor`	`withFileCompression(CSVFileCompression fileCompression)` The level of compression of the source CSV file.
`CsvFormatDescriptor`	`withFileCompression(String fileCompression)` The level of compression of the source CSV file.
`CsvFormatDescriptor`	`withHeaderList(Collection<String> headerList)` A list of the source CSV file's headers, if any.
`CsvFormatDescriptor`	`withHeaderList(String... headerList)` A list of the source CSV file's headers, if any.
`CsvFormatDescriptor`	`withQuoteSymbol(String quoteSymbol)` The character used as a quote character.

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

- Constructor Detail
  - CsvFormatDescriptor
```
public CsvFormatDescriptor()
```
- Method Detail
  - setFileCompression
```
public void setFileCompression(String fileCompression)
```
    The level of compression of the source CSV file.
    
    Parameters:
    
    fileCompression - The level of compression of the source CSV file.
    
    See Also:
    
    CSVFileCompression
  - getFileCompression
```
public String getFileCompression()
```
    The level of compression of the source CSV file.
    
    Returns:
    
    The level of compression of the source CSV file.
    
    See Also:
    
    CSVFileCompression
  - withFileCompression
```
public CsvFormatDescriptor withFileCompression(String fileCompression)
```
    The level of compression of the source CSV file.
    
    Parameters:
    
    fileCompression - The level of compression of the source CSV file.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
    
    See Also:
    
    CSVFileCompression
  - withFileCompression
```
public CsvFormatDescriptor withFileCompression(CSVFileCompression fileCompression)
```
    The level of compression of the source CSV file.
    
    Parameters:
    
    fileCompression - The level of compression of the source CSV file.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
    
    See Also:
    
    CSVFileCompression
  - setCharset
```
public void setCharset(String charset)
```
    The character set in which the source CSV file is written.
    
    Parameters:
    
    charset - The character set in which the source CSV file is written.
  - getCharset
```
public String getCharset()
```
    The character set in which the source CSV file is written.
    
    Returns:
    
    The character set in which the source CSV file is written.
  - withCharset
```
public CsvFormatDescriptor withCharset(String charset)
```
    The character set in which the source CSV file is written.
    
    Parameters:
    
    charset - The character set in which the source CSV file is written.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setContainsHeader
```
public void setContainsHeader(Boolean containsHeader)
```
    Whether or not the source CSV file contains a header.
    
    Parameters:
    
    containsHeader - Whether or not the source CSV file contains a header.
  - getContainsHeader
```
public Boolean getContainsHeader()
```
    Whether or not the source CSV file contains a header.
    
    Returns:
    
    Whether or not the source CSV file contains a header.
  - withContainsHeader
```
public CsvFormatDescriptor withContainsHeader(Boolean containsHeader)
```
    Whether or not the source CSV file contains a header.
    
    Parameters:
    
    containsHeader - Whether or not the source CSV file contains a header.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - isContainsHeader
```
public Boolean isContainsHeader()
```
    Whether or not the source CSV file contains a header.
    
    Returns:
    
    Whether or not the source CSV file contains a header.
  - setDelimiter
```
public void setDelimiter(String delimiter)
```
    The character used to delimit the source CSV file.
    
    Parameters:
    
    delimiter - The character used to delimit the source CSV file.
  - getDelimiter
```
public String getDelimiter()
```
    The character used to delimit the source CSV file.
    
    Returns:
    
    The character used to delimit the source CSV file.
  - withDelimiter
```
public CsvFormatDescriptor withDelimiter(String delimiter)
```
    The character used to delimit the source CSV file.
    
    Parameters:
    
    delimiter - The character used to delimit the source CSV file.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - getHeaderList
```
public List<String> getHeaderList()
```
    A list of the source CSV file's headers, if any.
    
    Returns:
    
    A list of the source CSV file's headers, if any.
  - setHeaderList
```
public void setHeaderList(Collection<String> headerList)
```
    A list of the source CSV file's headers, if any.
    
    Parameters:
    
    headerList - A list of the source CSV file's headers, if any.
  - withHeaderList
```
public CsvFormatDescriptor withHeaderList(String... headerList)
```
    A list of the source CSV file's headers, if any.
    
    NOTE: This method appends the values to the existing list (if any). Use setHeaderList(java.util.Collection) or withHeaderList(java.util.Collection) if you want to override the existing values.
    
    Parameters:
    
    headerList - A list of the source CSV file's headers, if any.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - withHeaderList
```
public CsvFormatDescriptor withHeaderList(Collection<String> headerList)
```
    A list of the source CSV file's headers, if any.
    
    Parameters:
    
    headerList - A list of the source CSV file's headers, if any.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setQuoteSymbol
```
public void setQuoteSymbol(String quoteSymbol)
```
    The character used as a quote character.
    
    Parameters:
    
    quoteSymbol - The character used as a quote character.
  - getQuoteSymbol
```
public String getQuoteSymbol()
```
    The character used as a quote character.
    
    Returns:
    
    The character used as a quote character.
  - withQuoteSymbol
```
public CsvFormatDescriptor withQuoteSymbol(String quoteSymbol)
```
    The character used as a quote character.
    
    Parameters:
    
    quoteSymbol - The character used as a quote character.
    
    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 CsvFormatDescriptor 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 CsvFormatDescriptor

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

CsvFormatDescriptor

Method Detail

setFileCompression

getFileCompression

withFileCompression

withFileCompression

setCharset

getCharset

withCharset

setContainsHeader

getContainsHeader

withContainsHeader

isContainsHeader

setDelimiter

getDelimiter

withDelimiter

getHeaderList

setHeaderList

withHeaderList

withHeaderList

setQuoteSymbol

getQuoteSymbol

withQuoteSymbol

toString

equals

hashCode

clone

marshall