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:

  • Method Details

    • 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()
      Description copied from interface: ToCopyableBuilder
      Take this object and create a builder that contains all of the current property values of this object.
      Specified by:
      toBuilder in interface ToCopyableBuilder<ExcelOptions.Builder,ExcelOptions>
      Returns:
      a builder for type T

    • 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)
      Description copied from interface: SdkPojo
      Indicates whether some other object is "equal to" this one by SDK fields. An SDK field is a modeled, non-inherited field in an SdkPojo class, and is generated based on a service model.

      If an SdkPojo class does not have any inherited fields, equalsBySdkFields and equals are essentially the same.

      Specified by:
      equalsBySdkFields in interface SdkPojo
      Parameters:
      obj - the object to be compared with
      Returns:
      true if the other object equals to this object by sdk fields, false otherwise.

    • 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
      Returns:
      List of SdkField in this POJO. May be empty list but should never be null.