com.files.models

Class Request

java.lang.Object

com.files.models.Request

All Implemented Interfaces:

ModelInterface

public class Request
extends Object
implements ModelInterface

Field Summary

Fields

Modifier and Type	Field and Description
String	automationId ID of automation that created request
String	destination Destination filename
String	groupIds A list of group IDs to request the file from.
Long	id Request ID
String	path Folder path.
String	source Source filename, if applicable
String	userDisplayName User making the request (if applicable)
String	userIds A list of user IDs to request the file from.

Constructor Summary

Constructors

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

Method Summary

Modifier and Type	Method and Description
static ListIterator<Request>	all()
static ListIterator<Request>	all(HashMap<String,Object> parameters, HashMap<String,Object> options)
static Request	create(HashMap<String,Object> parameters) Parameters: path (required) - string - Folder path on which to request the file.
static Request	create(HashMap<String,Object> parameters, HashMap<String,Object> options)
void	delete()
static void	delete(HashMap<String,Object> parameters, HashMap<String,Object> options)
static void	delete(Long id, HashMap<String,Object> parameters)
static void	delete(Long id, HashMap<String,Object> parameters, HashMap<String,Object> options)
static void	destroy()
void	destroy(HashMap<String,Object> parameters)
static void	destroy(Long id, HashMap<String,Object> parameters, HashMap<String,Object> options)
static Request	getFolder() Parameters: cursor - string - Used for pagination.
static Request	getFolder(HashMap<String,Object> parameters, HashMap<String,Object> options)
static Request	getFolder(String path, HashMap<String,Object> parameters)
static Request	getFolder(String path, HashMap<String,Object> parameters, HashMap<String,Object> options)
static ListIterator<Request>	list() Parameters: cursor - string - Used for pagination.
static ListIterator<Request>	list(HashMap<String,Object> parameters)
static ListIterator<Request>	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

Request ID

path

public String path

Folder path. This must be slash-delimited, but it must neither start nor end with a slash. Maximum of 5000 characters.

source

public String source

Source filename, if applicable

destination

public String destination

Destination filename

automationId

public String automationId

ID of automation that created request

userDisplayName

public String userDisplayName

User making the request (if applicable)

userIds

public String userIds

A list of user IDs to request the file from. If sent as a string, it should be comma-delimited.

groupIds

public String groupIds

A list of group IDs to request the file from. If sent as a string, it should be comma-delimited.

Constructor Detail

Request

public Request()

Request

public Request(HashMap<String,Object> parameters)

Request

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

Method Detail

delete

public void delete()
            throws IOException

Throws:

IOException

destroy

public void destroy(HashMap<String,Object> parameters)
             throws IOException

Throws:

IOException

save

public void save()
          throws IOException

Throws:

IOException

list

public static ListIterator<Request> list()
                                  throws RuntimeException

Parameters: 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 . mine - boolean - Only show requests of the current user? (Defaults to true if current user is not a site admin.) path - string - Path to show requests for. If omitted, shows all paths. Send `/` to represent the root directory.

Throws:

RuntimeException

list

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

Throws:

RuntimeException

list

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

Throws:

RuntimeException

all

public static ListIterator<Request> all()
                                 throws RuntimeException

Throws:

RuntimeException

all

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

Throws:

RuntimeException

getFolder

public static Request getFolder()
                         throws RuntimeException

Parameters: 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 . mine - boolean - Only show requests of the current user? (Defaults to true if current user is not a site admin.) path (required) - string - Path to show requests for. If omitted, shows all paths. Send `/` to represent the root directory.

Throws:

RuntimeException

getFolder

public static Request getFolder(String path,
                                HashMap<String,Object> parameters)
                         throws RuntimeException

Throws:

RuntimeException

getFolder

public static Request getFolder(HashMap<String,Object> parameters,
                                HashMap<String,Object> options)
                         throws RuntimeException

Throws:

RuntimeException

getFolder

public static Request getFolder(String path,
                                HashMap<String,Object> parameters,
                                HashMap<String,Object> options)
                         throws RuntimeException

Throws:

RuntimeException

create

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

Parameters: path (required) - string - Folder path on which to request the file. destination (required) - string - Destination filename (without extension) to request. user_ids - string - A list of user IDs to request the file from. If sent as a string, it should be comma-delimited. group_ids - string - A list of group IDs to request the file from. If sent as a string, it should be comma-delimited.

Throws:

RuntimeException

create

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

Throws:

RuntimeException

delete

public static void delete(Long id,
                          HashMap<String,Object> parameters)
                   throws RuntimeException

Throws:

RuntimeException

delete

public static void delete(HashMap<String,Object> parameters,
                          HashMap<String,Object> options)
                   throws RuntimeException

Throws:

RuntimeException

delete

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

Throws:

RuntimeException

destroy

public static void destroy()
                    throws RuntimeException

Throws:

RuntimeException

destroy

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

Throws:

RuntimeException