Class UploadSettings

java.lang.Object
software.amazon.awssdk.services.quicksight.model.UploadSettings
All Implemented Interfaces:
Serializable, SdkPojo, ToCopyableBuilder<UploadSettings.Builder,UploadSettings>
@Generated("software.amazon.awssdk:codegen") public final class UploadSettings extends Object implements SdkPojo, Serializable, ToCopyableBuilder<UploadSettings.Builder,UploadSettings>

Information about the format for a source file or files.

See Also:

  • Method Details

    • format

      public final FileFormat format()

      File format.

      If the service returns an enum value that is not available in the current SDK version, format will return FileFormat.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from formatAsString().

      Returns:
      File format.
      See Also:

    • formatAsString

      public final String formatAsString()

      File format.

      If the service returns an enum value that is not available in the current SDK version, format will return FileFormat.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from formatAsString().

      Returns:
      File format.
      See Also:

    • startFromRow

      public final Integer startFromRow()

      A row number to start reading data from.

      Returns:
      A row number to start reading data from.

    • containsHeader

      public final Boolean containsHeader()

      Whether the file has a header row, or the files each have a header row.

      Returns:
      Whether the file has a header row, or the files each have a header row.

    • textQualifier

      public final TextQualifier textQualifier()

      Text qualifier.

      If the service returns an enum value that is not available in the current SDK version, textQualifier will return TextQualifier.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from textQualifierAsString().

      Returns:
      Text qualifier.
      See Also:

    • textQualifierAsString

      public final String textQualifierAsString()

      Text qualifier.

      If the service returns an enum value that is not available in the current SDK version, textQualifier will return TextQualifier.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from textQualifierAsString().

      Returns:
      Text qualifier.
      See Also:

    • delimiter

      public final String delimiter()

      The delimiter between values in the file.

      Returns:
      The delimiter between values in the file.

    • customCellAddressRange

      public final String customCellAddressRange()

      A custom cell address range for Excel files, specifying which cells to import from the spreadsheet.

      Returns:
      A custom cell address range for Excel files, specifying which cells to import from the spreadsheet.

    • toBuilder

      public UploadSettings.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<UploadSettings.Builder,UploadSettings>
      Returns:
      a builder for type T

    • builder

      public static UploadSettings.Builder builder()

    • serializableBuilderClass

      public static Class<? extends UploadSettings.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.

    • sdkFieldNameToField

      public final Map<String,SdkField<?>> sdkFieldNameToField()
      Specified by:
      sdkFieldNameToField in interface SdkPojo
      Returns:
      The mapping between the field name and its corresponding field.