com.amazonaws.services.gluedatabrew.model

Class ExcelOptions

java.lang.Object

com.amazonaws.services.gluedatabrew.model.ExcelOptions

All Implemented Interfaces:

StructuredPojo, Serializable, Cloneable

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

Options that define how DataBrew will interpret a Microsoft Excel file, when creating a dataset from that file.

See Also:

AWS API Documentation, Serialized Form

Constructor Summary

Constructors

Constructor and Description
ExcelOptions()

Method Summary

Modifier and Type	Method and Description
ExcelOptions	clone()
boolean	equals(Object obj)
List<Integer>	getSheetIndexes() Specifies one or more sheet numbers in the Excel file, which will be included in the dataset.
List<String>	getSheetNames() Specifies one or more named sheets in the Excel file, which will be included in the dataset.
int	hashCode()
void	marshall(ProtocolMarshaller protocolMarshaller) Marshalls this structured data using the given ProtocolMarshaller.
void	setSheetIndexes(Collection<Integer> sheetIndexes) Specifies one or more sheet numbers in the Excel file, which will be included in the dataset.
void	setSheetNames(Collection<String> sheetNames) Specifies one or more named sheets in the Excel file, which will be included in the dataset.
String	toString() Returns a string representation of this object.
ExcelOptions	withSheetIndexes(Collection<Integer> sheetIndexes) Specifies one or more sheet numbers in the Excel file, which will be included in the dataset.
ExcelOptions	withSheetIndexes(Integer... sheetIndexes) Specifies one or more sheet numbers in the Excel file, which will be included in the dataset.
ExcelOptions	withSheetNames(Collection<String> sheetNames) Specifies one or more named sheets in the Excel file, which will be included in the dataset.
ExcelOptions	withSheetNames(String... sheetNames) Specifies one or more named sheets in the Excel file, which will be included in the dataset.

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Constructor Detail

ExcelOptions

public ExcelOptions()

Method Detail

getSheetNames

public List<String> getSheetNames()

Specifies one or more named sheets in the Excel file, which will be included in the dataset.

Returns:

Specifies one or more named sheets in the Excel file, which will be included in the dataset.

setSheetNames

public void setSheetNames(Collection<String> sheetNames)

Specifies one or more named sheets in the Excel file, which will be included in the dataset.

Parameters:

sheetNames - Specifies one or more named sheets in the Excel file, which will be included in the dataset.

withSheetNames

public ExcelOptions withSheetNames(String... sheetNames)

Specifies one or more named sheets in the Excel file, which 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.

Parameters:

sheetNames - Specifies one or more named sheets in the Excel file, which will be included in the dataset.

Returns:

Returns a reference to this object so that method calls can be chained together.

withSheetNames

public ExcelOptions withSheetNames(Collection<String> sheetNames)

Specifies one or more named sheets in the Excel file, which will be included in the dataset.

Parameters:

sheetNames - Specifies one or more named sheets in the Excel file, which will be included in the dataset.

Returns:

Returns a reference to this object so that method calls can be chained together.

getSheetIndexes

public List<Integer> getSheetIndexes()

Specifies one or more sheet numbers in the Excel file, which will be included in the dataset.

Returns:

Specifies one or more sheet numbers in the Excel file, which will be included in the dataset.

setSheetIndexes

public void setSheetIndexes(Collection<Integer> sheetIndexes)

Specifies one or more sheet numbers in the Excel file, which will be included in the dataset.

Parameters:

sheetIndexes - Specifies one or more sheet numbers in the Excel file, which will be included in the dataset.

withSheetIndexes

public ExcelOptions withSheetIndexes(Integer... sheetIndexes)

Specifies one or more sheet numbers in the Excel file, which 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.

Parameters:

sheetIndexes - Specifies one or more sheet numbers in the Excel file, which will be included in the dataset.

Returns:

Returns a reference to this object so that method calls can be chained together.

withSheetIndexes

public ExcelOptions withSheetIndexes(Collection<Integer> sheetIndexes)

Specifies one or more sheet numbers in the Excel file, which will be included in the dataset.

Parameters:

sheetIndexes - Specifies one or more sheet numbers in the Excel file, which will be included in the dataset.

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 ExcelOptions 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.