Class SnapshotFile

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

A structure that contains the information for the snapshot that you want to generate. This information is provided by you when you start a new snapshot job.

See Also:

  • Method Details

    • hasSheetSelections

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

    • sheetSelections

      public final List<SnapshotFileSheetSelection> sheetSelections()

      A list of SnapshotFileSheetSelection objects that contain information on the dashboard sheet that is exported. These objects provide information about the snapshot artifacts that are generated during the job. This structure can hold a maximum of 5 CSV configurations, 5 Excel configurations, or 1 configuration for PDF.

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

      Returns:
      A list of SnapshotFileSheetSelection objects that contain information on the dashboard sheet that is exported. These objects provide information about the snapshot artifacts that are generated during the job. This structure can hold a maximum of 5 CSV configurations, 5 Excel configurations, or 1 configuration for PDF.

    • formatType

      public final SnapshotFileFormatType formatType()

      The format of the snapshot file to be generated. You can choose between CSV, Excel, or PDF.

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

      Returns:
      The format of the snapshot file to be generated. You can choose between CSV, Excel, or PDF.
      See Also:

    • formatTypeAsString

      public final String formatTypeAsString()

      The format of the snapshot file to be generated. You can choose between CSV, Excel, or PDF.

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

      Returns:
      The format of the snapshot file to be generated. You can choose between CSV, Excel, or PDF.
      See Also:

    • toBuilder

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

    • builder

      public static SnapshotFile.Builder builder()

    • serializableBuilderClass

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