Package software.amazon.awssdk.services.databrew.model

Class ExcelOptions

java.lang.Object

software.amazon.awssdk.services.databrew.model.ExcelOptions

All Implemented Interfaces:

Serializable, SdkPojo, ToCopyableBuilder<ExcelOptions.Builder,ExcelOptions>

@Generated("software.amazon.awssdk:codegen")
public final class ExcelOptions
extends Object
implements SdkPojo, Serializable, ToCopyableBuilder<ExcelOptions.Builder,ExcelOptions>

Represents a set of options that define how DataBrew will interpret a Microsoft Excel file when creating a dataset from that file.

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static interface	ExcelOptions.Builder

Method Summary

Modifier and Type	Method	Description
static ExcelOptions.Builder	builder()
boolean	equals(Object obj)
boolean	equalsBySdkFields(Object obj)
<T> Optional<T>	getValueForField(String fieldName, Class<T> clazz)
int	hashCode()
boolean	hasSheetIndexes()	For responses, this returns true if the service returned a value for the SheetIndexes property.
boolean	hasSheetNames()	For responses, this returns true if the service returned a value for the SheetNames property.
Boolean	headerRow()	A variable that specifies whether the first row in the file is parsed as the header.
Map<String,SdkField<?>>	sdkFieldNameToField()
List<SdkField<?>>	sdkFields()
static Class<? extends ExcelOptions.Builder>	serializableBuilderClass()
List<Integer>	sheetIndexes()	One or more sheet numbers in the Excel file that will be included in the dataset.
List<String>	sheetNames()	One or more named sheets in the Excel file that will be included in the dataset.
ExcelOptions.Builder	toBuilder()
String	toString()	Returns a string representation of this object.

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface software.amazon.awssdk.utils.builder.ToCopyableBuilder

copy

Method Detail

hasSheetNames

public final boolean hasSheetNames()

For responses, this returns true if the service returned a value for the SheetNames property. This DOES NOT check that the value is non-empty (for which, you should check the isEmpty() method on the property). This is useful because the SDK will never return a null collection or map, but you may need to differentiate between the service returning nothing (or null) and the service returning an empty collection or map. For requests, this returns true if a value for the property was specified in the request builder, and false if a value was not specified.

sheetNames

public final List<String> sheetNames()

One or more named sheets in the Excel file that will be included in the dataset.

Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.

This method will never return null. If you would like to know whether the service returned this field (so that you can differentiate between null and empty), you can use the hasSheetNames() method.

Returns:

One or more named sheets in the Excel file that will be included in the dataset.

hasSheetIndexes

public final boolean hasSheetIndexes()

For responses, this returns true if the service returned a value for the SheetIndexes property. This DOES NOT check that the value is non-empty (for which, you should check the isEmpty() method on the property). This is useful because the SDK will never return a null collection or map, but you may need to differentiate between the service returning nothing (or null) and the service returning an empty collection or map. For requests, this returns true if a value for the property was specified in the request builder, and false if a value was not specified.

sheetIndexes

public final List<Integer> sheetIndexes()

One or more sheet numbers in the Excel file that will be included in the dataset.

Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.

This method will never return null. If you would like to know whether the service returned this field (so that you can differentiate between null and empty), you can use the hasSheetIndexes() method.

Returns:

One or more sheet numbers in the Excel file that will be included in the dataset.

headerRow

public final 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.

Returns:

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.

toBuilder

public ExcelOptions.Builder toBuilder()

Specified by:

toBuilder in interface ToCopyableBuilder<ExcelOptions.Builder,ExcelOptions>

builder

public static ExcelOptions.Builder builder()

serializableBuilderClass

public static Class<? extends ExcelOptions.Builder> serializableBuilderClass()

hashCode

public final int hashCode()

Overrides:

hashCode in class Object

equals

public final boolean equals(Object obj)

Overrides:

equals in class Object

equalsBySdkFields

public final boolean equalsBySdkFields(Object obj)

Specified by:

equalsBySdkFields in interface SdkPojo

toString

public final 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

getValueForField

public final <T> Optional<T> getValueForField(String fieldName,
                                              Class<T> clazz)

sdkFields

public final List<SdkField<?>> sdkFields()

Specified by:

sdkFields in interface SdkPojo

sdkFieldNameToField

public final Map<String,SdkField<?>> sdkFieldNameToField()

Specified by:

sdkFieldNameToField in interface SdkPojo