Class ExportInfo


  • public class ExportInfo
    extends java.lang.Object
    Export information for a file.
    • Field Summary

      Fields 
      Modifier and Type Field Description
      protected java.lang.String exportAs  
      protected java.util.List<java.lang.String> exportOptions  
    • Constructor Summary

      Constructors 
      Constructor Description
      ExportInfo()
      Export information for a file.
      ExportInfo​(java.lang.String exportAs, java.util.List<java.lang.String> exportOptions)
      Export information for a file.
    • Method Summary

      All Methods Static Methods Instance Methods Concrete Methods 
      Modifier and Type Method Description
      boolean equals​(java.lang.Object obj)  
      java.lang.String getExportAs()
      Format to which the file can be exported to.
      java.util.List<java.lang.String> getExportOptions()
      Additional formats to which the file can be exported.
      int hashCode()  
      static ExportInfo.Builder newBuilder()
      Returns a new builder for creating an instance of this class.
      java.lang.String toString()  
      java.lang.String toStringMultiline()
      Returns a String representation of this object formatted for easier readability.
      • Methods inherited from class java.lang.Object

        clone, finalize, getClass, notify, notifyAll, wait, wait, wait
    • Field Detail

      • exportAs

        protected final java.lang.String exportAs
      • exportOptions

        protected final java.util.List<java.lang.String> exportOptions
    • Constructor Detail

      • ExportInfo

        public ExportInfo​(java.lang.String exportAs,
                          java.util.List<java.lang.String> exportOptions)
        Export information for a file.

        Use newBuilder() to create instances of this class without specifying values for all optional fields.

        Parameters:
        exportAs - Format to which the file can be exported to.
        exportOptions - Additional formats to which the file can be exported. These values can be specified as the export_format in /files/export. Must not contain a null item.
        Throws:
        java.lang.IllegalArgumentException - If any argument does not meet its preconditions.
      • ExportInfo

        public ExportInfo()
        Export information for a file.

        The default values for unset fields will be used.

    • Method Detail

      • getExportAs

        public java.lang.String getExportAs()
        Format to which the file can be exported to.
        Returns:
        value for this field, or null if not present.
      • getExportOptions

        public java.util.List<java.lang.String> getExportOptions()
        Additional formats to which the file can be exported. These values can be specified as the export_format in /files/export.
        Returns:
        value for this field, or null if not present.
      • newBuilder

        public static ExportInfo.Builder newBuilder()
        Returns a new builder for creating an instance of this class.
        Returns:
        builder for this class.
      • hashCode

        public int hashCode()
        Overrides:
        hashCode in class java.lang.Object
      • equals

        public boolean equals​(java.lang.Object obj)
        Overrides:
        equals in class java.lang.Object
      • toString

        public java.lang.String toString()
        Overrides:
        toString in class java.lang.Object
      • toStringMultiline

        public java.lang.String toStringMultiline()
        Returns a String representation of this object formatted for easier readability.

        The returned String may contain newlines.

        Returns:
        Formatted, multiline String representation of this object