com.files.models

Class Export

java.lang.Object

com.files.models.Export

All Implemented Interfaces:

ModelInterface

public class Export
extends Object
implements ModelInterface

Field Summary

Fields

Modifier and Type	Field and Description
String	downloadUri Link to download Export file.
Long	exportRows Number of rows exported
String	exportStatus Status of the Export
String	exportType Type of data being exported
Map<String,String>	filter If set, return records where the specified field is equal to the supplied value.
Map<String,String>	filterPrefix If set, return records where the specified field is prefixed by the supplied value.
Long	id ID for this Export
String	message Export message
Map<String,String>	sortBy If set, sort records by the specified field in either `asc` or `desc` direction.
Long	userId User ID.

Constructor Summary

Constructors

Constructor and Description
Export()
Export(HashMap<String,Object> parameters)
Export(HashMap<String,Object> parameters, HashMap<String,Object> options)

Method Summary

Modifier and Type	Method and Description
static ListIterator<Export>	all()
static ListIterator<Export>	all(HashMap<String,Object> parameters, HashMap<String,Object> options)
static Export	create() Parameters: user_id - int64 - User ID.
static Export	create(HashMap<String,Object> parameters)
static Export	create(HashMap<String,Object> parameters, HashMap<String,Object> options)
static Export	find(HashMap<String,Object> parameters, HashMap<String,Object> options)
static Export	find(Long id, HashMap<String,Object> parameters) Parameters: id (required) - int64 - Export ID.
static Export	find(Long id, HashMap<String,Object> parameters, HashMap<String,Object> options)
static Export	get()
static Export	get(Long id, HashMap<String,Object> parameters, HashMap<String,Object> options)
static ListIterator<Export>	list() Parameters: user_id - int64 - User ID.
static ListIterator<Export>	list(HashMap<String,Object> parameters)
static ListIterator<Export>	list(HashMap<String,Object> parameters, HashMap<String,Object> options)
void	save()

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface com.files.models.ModelInterface

setOptions

Field Detail

id

public Long id

ID for this Export

exportStatus

public String exportStatus

Status of the Export

exportType

public String exportType

Type of data being exported

exportRows

public Long exportRows

Number of rows exported

downloadUri

public String downloadUri

Link to download Export file.

message

public String message

Export message

userId

public Long userId

User ID. Provide a value of `0` to operate the current session's user.

sortBy

public Map<String,String> sortBy

If set, sort records by the specified field in either `asc` or `desc` direction. Valid fields are `export_status` and `export_type`.

filter

public Map<String,String> filter

If set, return records where the specified field is equal to the supplied value. Valid fields are `export_status` and `export_type`.

filterPrefix

public Map<String,String> filterPrefix

If set, return records where the specified field is prefixed by the supplied value. Valid fields are `export_type`.

Constructor Detail

Export

public Export()

Export

public Export(HashMap<String,Object> parameters)

Export

public Export(HashMap<String,Object> parameters,
              HashMap<String,Object> options)

Method Detail

save

public void save()
          throws IOException

Throws:

IOException

list

public static ListIterator<Export> list()
                                 throws RuntimeException

Parameters: user_id - int64 - User ID. Provide a value of `0` to operate the current session's user. cursor - string - Used for pagination. When a list request has more records available, cursors are provided in the response headers `X-Files-Cursor-Next` and `X-Files-Cursor-Prev`. Send one of those cursor value here to resume an existing list from the next available record. Note: many of our SDKs have iterator methods that will automatically handle cursor-based pagination. per_page - int64 - Number of records to show per page. (Max: 10,000, 1,000 or less is recommended). sort_by - object - If set, sort records by the specified field in either `asc` or `desc` direction. Valid fields are `export_status` and `export_type`. filter - object - If set, return records where the specified field is equal to the supplied value. Valid fields are `export_status` and `export_type`. filter_prefix - object - If set, return records where the specified field is prefixed by the supplied value. Valid fields are `export_type`.

Throws:

RuntimeException

list

public static ListIterator<Export> list(HashMap<String,Object> parameters)
                                 throws RuntimeException

Throws:

RuntimeException

list

public static ListIterator<Export> list(HashMap<String,Object> parameters,
                                        HashMap<String,Object> options)
                                 throws RuntimeException

Throws:

RuntimeException

all

public static ListIterator<Export> all()
                                throws RuntimeException

Throws:

RuntimeException

all

public static ListIterator<Export> all(HashMap<String,Object> parameters,
                                       HashMap<String,Object> options)
                                throws RuntimeException

Throws:

RuntimeException

find

public static Export find(Long id,
                          HashMap<String,Object> parameters)
                   throws RuntimeException

Parameters: id (required) - int64 - Export ID.

Throws:

RuntimeException

find

public static Export find(HashMap<String,Object> parameters,
                          HashMap<String,Object> options)
                   throws RuntimeException

Throws:

RuntimeException

find

public static Export find(Long id,
                          HashMap<String,Object> parameters,
                          HashMap<String,Object> options)
                   throws RuntimeException

Throws:

RuntimeException

get

public static Export get()
                  throws RuntimeException

Throws:

RuntimeException

get

public static Export get(Long id,
                         HashMap<String,Object> parameters,
                         HashMap<String,Object> options)
                  throws RuntimeException

Throws:

RuntimeException

create

public static Export create()
                     throws RuntimeException

Parameters: user_id - int64 - User ID. Provide a value of `0` to operate the current session's user. sort_by - object - If set, sort records by the specified field in either `asc` or `desc` direction. Valid fields are `export_status` and `export_type`. filter - object - If set, return records where the specified field is equal to the supplied value. Valid fields are `export_status` and `export_type`. filter_prefix - object - If set, return records where the specified field is prefixed by the supplied value. Valid fields are `export_type`.

Throws:

RuntimeException

create

public static Export create(HashMap<String,Object> parameters)
                     throws RuntimeException

Throws:

RuntimeException

create

public static Export create(HashMap<String,Object> parameters,
                            HashMap<String,Object> options)
                     throws RuntimeException

Throws:

RuntimeException