com.files.models

Class BundleAction

java.lang.Object

com.files.models.BundleAction

All Implemented Interfaces:

ModelInterface

public class BundleAction
extends Object
implements ModelInterface

Field Summary

Fields

Modifier and Type	Field and Description
String	action Type of action
BundleRegistration	bundleRegistration Object that contains bundle registration information
Date	createdAt Action occurrence date/time
String	destination The destination path for this bundle action, if applicable
String	path Path.
String	source The source path for this bundle action, if applicable

Constructor Summary

Constructors

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

Method Summary

Modifier and Type	Method and Description
static ListIterator<BundleAction>	all()
static ListIterator<BundleAction>	all(HashMap<String,Object> parameters, HashMap<String,Object> options)
static ListIterator<BundleAction>	list() Parameters: cursor - string - Used for pagination.
static ListIterator<BundleAction>	list(HashMap<String,Object> parameters)
static ListIterator<BundleAction>	list(HashMap<String,Object> parameters, HashMap<String,Object> options)

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

action

public String action

Type of action

bundleRegistration

public BundleRegistration bundleRegistration

Object that contains bundle registration information

createdAt

public Date createdAt

Action occurrence date/time

destination

public String destination

The destination path for this bundle action, if applicable

path

public String path

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

source

public String source

The source path for this bundle action, if applicable

Constructor Detail

BundleAction

public BundleAction()

BundleAction

public BundleAction(HashMap<String,Object> parameters)

BundleAction

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

Method Detail

list

public static ListIterator<BundleAction> 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 `created_at`. filter - object - If set, return records where the specified field is equal to the supplied value. Valid fields are `created_at`, `bundle_id` or `bundle_registration_id`. Valid field combinations are `[ created_at, bundle_id ]`, `[ created_at, bundle_registration_id ]`, `[ bundle_id, bundle_registration_id ]` or `[ created_at, bundle_id, bundle_registration_id ]`. filter_gt - object - If set, return records where the specified field is greater than the supplied value. Valid fields are `created_at`. filter_gteq - object - If set, return records where the specified field is greater than or equal the supplied value. Valid fields are `created_at`. filter_lt - object - If set, return records where the specified field is less than the supplied value. Valid fields are `created_at`. filter_lteq - object - If set, return records where the specified field is less than or equal the supplied value. Valid fields are `created_at`.

Throws:

RuntimeException

list

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

Throws:

RuntimeException

list

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

Throws:

RuntimeException

all

public static ListIterator<BundleAction> all()
                                      throws RuntimeException

Throws:

RuntimeException

all

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

Throws:

RuntimeException