java.lang.Object
- software.amazon.awssdk.services.glue.model.S3ExcelSource

All Implemented Interfaces:: Serializable, SdkPojo, ToCopyableBuilder<S3ExcelSource.Builder,S3ExcelSource>

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

Specifies an S3 Excel data source.

See Also:: Serialized Form

Nested Class Summary

Nested Classes
Modifier and Type Class Description

static interface S3ExcelSource.Builder

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method	Description
`S3DirectSourceAdditionalOptions`	`additionalOptions()`	Additional configuration options for S3 direct source processing.
`static S3ExcelSource.Builder`	`builder()`
`ParquetCompressionType`	`compressionType()`	The compression format used for the Excel files.
`String`	`compressionTypeAsString()`	The compression format used for the Excel files.
`boolean`	`equals(Object obj)`
`boolean`	`equalsBySdkFields(Object obj)`
`List<String>`	`exclusions()`	Patterns to exclude specific files or paths from processing.
`<T> Optional<T>`	`getValueForField(String fieldName, Class<T> clazz)`
`String`	`groupFiles()`	Specifies how files should be grouped for processing.
`String`	`groupSize()`	Defines the size of file groups for batch processing.
`boolean`	`hasExclusions()`	For responses, this returns true if the service returned a value for the Exclusions property.
`int`	`hashCode()`
`boolean`	`hasOutputSchemas()`	For responses, this returns true if the service returned a value for the OutputSchemas property.
`boolean`	`hasPaths()`	For responses, this returns true if the service returned a value for the Paths property.
`Integer`	`maxBand()`	The maximum number of processing bands to use.
`Integer`	`maxFilesInBand()`	The maximum number of files to process in each band.
`String`	`name()`	The name of the S3 Excel data source.
`Long`	`numberRows()`	The number of rows to process from each Excel file.
`List<GlueSchema>`	`outputSchemas()`	The Glue schemas to apply to the processed data.
`List<String>`	`paths()`	The S3 paths where the Excel files are located.
`Boolean`	`recurse()`	Indicates whether to recursively process subdirectories.
`Map<String,SdkField<?>>`	`sdkFieldNameToField()`
`List<SdkField<?>>`	`sdkFields()`
`static Class<? extends S3ExcelSource.Builder>`	`serializableBuilderClass()`
`Integer`	`skipFooter()`	The number of rows to skip at the end of each Excel file.
`S3ExcelSource.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
  - name
```
public final String name()
```
    The name of the S3 Excel data source.
    
    Returns:
    
    The name of the S3 Excel data source.
  - hasPaths
```
public final boolean hasPaths()
```
    For responses, this returns true if the service returned a value for the Paths 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.
  - paths
```
public final List<String> paths()
```
    The S3 paths where the Excel files are located.
    
    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 hasPaths() method.
    
    Returns:
    
    The S3 paths where the Excel files are located.
  - compressionType
```
public final ParquetCompressionType compressionType()
```
    The compression format used for the Excel files.
    
    If the service returns an enum value that is not available in the current SDK version, compressionType will return ParquetCompressionType.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from compressionTypeAsString().
    
    Returns:
    
    The compression format used for the Excel files.
    
    See Also:
    
    ParquetCompressionType
  - compressionTypeAsString
```
public final String compressionTypeAsString()
```
    The compression format used for the Excel files.
    
    If the service returns an enum value that is not available in the current SDK version, compressionType will return ParquetCompressionType.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from compressionTypeAsString().
    
    Returns:
    
    The compression format used for the Excel files.
    
    See Also:
    
    ParquetCompressionType
  - hasExclusions
```
public final boolean hasExclusions()
```
    For responses, this returns true if the service returned a value for the Exclusions 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.
  - exclusions
```
public final List<String> exclusions()
```
    Patterns to exclude specific files or paths from processing.
    
    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 hasExclusions() method.
    
    Returns:
    
    Patterns to exclude specific files or paths from processing.
  - groupSize
```
public final String groupSize()
```
    Defines the size of file groups for batch processing.
    
    Returns:
    
    Defines the size of file groups for batch processing.
  - groupFiles
```
public final String groupFiles()
```
    Specifies how files should be grouped for processing.
    
    Returns:
    
    Specifies how files should be grouped for processing.
  - recurse
```
public final Boolean recurse()
```
    Indicates whether to recursively process subdirectories.
    
    Returns:
    
    Indicates whether to recursively process subdirectories.
  - maxBand
```
public final Integer maxBand()
```
    The maximum number of processing bands to use.
    
    Returns:
    
    The maximum number of processing bands to use.
  - maxFilesInBand
```
public final Integer maxFilesInBand()
```
    The maximum number of files to process in each band.
    
    Returns:
    
    The maximum number of files to process in each band.
  - additionalOptions
```
public final S3DirectSourceAdditionalOptions additionalOptions()
```
    Additional configuration options for S3 direct source processing.
    
    Returns:
    
    Additional configuration options for S3 direct source processing.
  - numberRows
```
public final Long numberRows()
```
    The number of rows to process from each Excel file.
    
    Returns:
    
    The number of rows to process from each Excel file.
  - skipFooter
```
public final Integer skipFooter()
```
    The number of rows to skip at the end of each Excel file.
    
    Returns:
    
    The number of rows to skip at the end of each Excel file.
  - hasOutputSchemas
```
public final boolean hasOutputSchemas()
```
    For responses, this returns true if the service returned a value for the OutputSchemas 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.
  - outputSchemas
```
public final List<GlueSchema> outputSchemas()
```
    The Glue schemas to apply to the processed data.
    
    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 hasOutputSchemas() method.
    
    Returns:
    
    The Glue schemas to apply to the processed data.
  - toBuilder
```
public S3ExcelSource.Builder toBuilder()
```
    Specified by:
    
    toBuilder in interface ToCopyableBuilder<S3ExcelSource.Builder,S3ExcelSource>
  - builder
```
public static S3ExcelSource.Builder builder()
```
  - serializableBuilderClass
```
public static Class<? extends S3ExcelSource.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

Class S3ExcelSource

Nested Class Summary

Method Summary

Methods inherited from class java.lang.Object

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

Method Detail

name

hasPaths

paths

compressionType

compressionTypeAsString

hasExclusions

exclusions

groupSize

groupFiles

recurse

maxBand

maxFilesInBand

additionalOptions

numberRows

skipFooter

hasOutputSchemas

outputSchemas

toBuilder

builder

serializableBuilderClass

hashCode

equals

equalsBySdkFields

toString

getValueForField

sdkFields

sdkFieldNameToField