@Generated(value="com.amazonaws:aws-java-sdk-code-generator") public class ExcelOptions extends Object implements Serializable, Cloneable, StructuredPojo
Represents a set of options that define how DataBrew will interpret a Microsoft Excel file when creating a dataset from that file.
Constructor and Description |
---|
ExcelOptions() |
Modifier and Type | Method and Description |
---|---|
ExcelOptions |
clone() |
boolean |
equals(Object obj) |
Boolean |
getHeaderRow()
A variable that specifies whether the first row in the file is parsed as the header.
|
List<Integer> |
getSheetIndexes()
One or more sheet numbers in the Excel file that will be included in the dataset.
|
List<String> |
getSheetNames()
One or more named sheets in the Excel file that will be included in the dataset.
|
int |
hashCode() |
Boolean |
isHeaderRow()
A variable that specifies whether the first row in the file is parsed as the header.
|
void |
marshall(ProtocolMarshaller protocolMarshaller)
Marshalls this structured data using the given
ProtocolMarshaller . |
void |
setHeaderRow(Boolean headerRow)
A variable that specifies whether the first row in the file is parsed as the header.
|
void |
setSheetIndexes(Collection<Integer> sheetIndexes)
One or more sheet numbers in the Excel file that will be included in the dataset.
|
void |
setSheetNames(Collection<String> sheetNames)
One or more named sheets in the Excel file that will be included in the dataset.
|
String |
toString()
Returns a string representation of this object.
|
ExcelOptions |
withHeaderRow(Boolean headerRow)
A variable that specifies whether the first row in the file is parsed as the header.
|
ExcelOptions |
withSheetIndexes(Collection<Integer> sheetIndexes)
One or more sheet numbers in the Excel file that will be included in the dataset.
|
ExcelOptions |
withSheetIndexes(Integer... sheetIndexes)
One or more sheet numbers in the Excel file that will be included in the dataset.
|
ExcelOptions |
withSheetNames(Collection<String> sheetNames)
One or more named sheets in the Excel file that will be included in the dataset.
|
ExcelOptions |
withSheetNames(String... sheetNames)
One or more named sheets in the Excel file that will be included in the dataset.
|
public List<String> getSheetNames()
One or more named sheets in the Excel file that will be included in the dataset.
public void setSheetNames(Collection<String> sheetNames)
One or more named sheets in the Excel file that will be included in the dataset.
sheetNames
- One or more named sheets in the Excel file that will be included in the dataset.public ExcelOptions withSheetNames(String... sheetNames)
One or more named sheets in the Excel file that will be included in the dataset.
NOTE: This method appends the values to the existing list (if any). Use
setSheetNames(java.util.Collection)
or withSheetNames(java.util.Collection)
if you want to
override the existing values.
sheetNames
- One or more named sheets in the Excel file that will be included in the dataset.public ExcelOptions withSheetNames(Collection<String> sheetNames)
One or more named sheets in the Excel file that will be included in the dataset.
sheetNames
- One or more named sheets in the Excel file that will be included in the dataset.public List<Integer> getSheetIndexes()
One or more sheet numbers in the Excel file that will be included in the dataset.
public void setSheetIndexes(Collection<Integer> sheetIndexes)
One or more sheet numbers in the Excel file that will be included in the dataset.
sheetIndexes
- One or more sheet numbers in the Excel file that will be included in the dataset.public ExcelOptions withSheetIndexes(Integer... sheetIndexes)
One or more sheet numbers in the Excel file that will be included in the dataset.
NOTE: This method appends the values to the existing list (if any). Use
setSheetIndexes(java.util.Collection)
or withSheetIndexes(java.util.Collection)
if you want to
override the existing values.
sheetIndexes
- One or more sheet numbers in the Excel file that will be included in the dataset.public ExcelOptions withSheetIndexes(Collection<Integer> sheetIndexes)
One or more sheet numbers in the Excel file that will be included in the dataset.
sheetIndexes
- One or more sheet numbers in the Excel file that will be included in the dataset.public void setHeaderRow(Boolean headerRow)
A variable that specifies whether the first row in the file is parsed as the header. If this value is false, column names are auto-generated.
headerRow
- A variable that specifies whether the first row in the file is parsed as the header. If this value is
false, column names are auto-generated.public Boolean getHeaderRow()
A variable that specifies whether the first row in the file is parsed as the header. If this value is false, column names are auto-generated.
public ExcelOptions withHeaderRow(Boolean headerRow)
A variable that specifies whether the first row in the file is parsed as the header. If this value is false, column names are auto-generated.
headerRow
- A variable that specifies whether the first row in the file is parsed as the header. If this value is
false, column names are auto-generated.public Boolean isHeaderRow()
A variable that specifies whether the first row in the file is parsed as the header. If this value is false, column names are auto-generated.
public String toString()
toString
in class Object
Object.toString()
public ExcelOptions clone()
public void marshall(ProtocolMarshaller protocolMarshaller)
StructuredPojo
ProtocolMarshaller
.marshall
in interface StructuredPojo
protocolMarshaller
- Implementation of ProtocolMarshaller
used to marshall this object's data.