Class FileSource

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

A physical table type that contains the schema and upload settings for a file-based data source.

See Also:

  • Method Details

    • dataSourceArn

      public final String dataSourceArn()

      The Amazon Resource Name (ARN) for the data source.

      Returns:
      The Amazon Resource Name (ARN) for the data source.

    • uploadSettings

      public final UploadSettings uploadSettings()

      Information about the format for the source file.

      Returns:
      Information about the format for the source file.

    • sheetIndex

      public final Integer sheetIndex()

      The zero-based index of the sheet to use within the file. For files that contain multiple sheets, this identifies which sheet to read. Files that contain a single sheet, or that have no concept of sheets, use sheet 0.

      Returns:
      The zero-based index of the sheet to use within the file. For files that contain multiple sheets, this identifies which sheet to read. Files that contain a single sheet, or that have no concept of sheets, use sheet 0.

    • hasInputColumns

      public final boolean hasInputColumns()
      For responses, this returns true if the service returned a value for the InputColumns 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.

    • inputColumns

      public final List<InputColumn> inputColumns()

      The column schema of the file.

      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 hasInputColumns() method.

      Returns:
      The column schema of the file.

    • toBuilder

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

    • builder

      public static FileSource.Builder builder()

    • serializableBuilderClass

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