com.files.models

Class HistoryExportResult

java.lang.Object

com.files.models.HistoryExportResult

All Implemented Interfaces:

ModelInterface

public class HistoryExportResult
extends Object
implements ModelInterface

Field Summary

Fields

Modifier and Type	Field and Description
String	action What action was taken.
Long	createdAt When the action happened
String	createdAtIso8601 When the action happened, in ISO8601 format.
String	destination File moved to this destination folder
String	failureType The type of login failure, if applicable.
Long	fileId File ID related to the action
String	folder Folder in which the action occurred
Long	id Action ID
String	interfaceName Interface through which the action was taken.
String	ip Client IP that performed the action
Long	parentId ID of the parent folder
String	path Path of the related action.
String	src File move originated from this path
Long	targetExpiresAt If searching for Histories about API keys, this is when the API key will expire.
String	targetExpiresAtIso8601 If searching for Histories about API keys, this is when the API key will expire.
Long	targetId ID of the object (such as Users, or API Keys) on which the action was taken
String	targetName Name of the User, Group or other object with a name related to this action
String	targetPermission Permission level of the action
String	targetPermissionSet If searching for Histories about API keys, this represents the permission set of the associated API key
String	targetPlatform If searching for Histories about API keys, this is the platform on which the action was taken
Boolean	targetRecursive Whether or not the action was recursive
Long	targetUserId If searching for Histories about API keys, this is the User ID on which the action was taken
String	targetUsername If searching for Histories about API keys, this is the username on which the action was taken
Long	userId User ID
Boolean	userIsFromParentSite true if this change was performed by a user on a parent site.
String	username Username of the user that performed the action

Constructor Summary

Constructors

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

Method Summary

Modifier and Type	Method and Description
static ListIterator<HistoryExportResult>	all()
static ListIterator<HistoryExportResult>	all(HashMap<String,Object> parameters, HashMap<String,Object> options)
static ListIterator<HistoryExportResult>	list() Parameters: user_id - int64 - User ID.
static ListIterator<HistoryExportResult>	list(HashMap<String,Object> parameters)
static ListIterator<HistoryExportResult>	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

id

public Long id

Action ID

createdAt

public Long createdAt

When the action happened

createdAtIso8601

public String createdAtIso8601

When the action happened, in ISO8601 format.

userId

public Long userId

User ID

fileId

public Long fileId

File ID related to the action

parentId

public Long parentId

ID of the parent folder

path

public String path

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

folder

public String folder

Folder in which the action occurred

src

public String src

File move originated from this path

destination

public String destination

File moved to this destination folder

ip

public String ip

Client IP that performed the action

username

public String username

Username of the user that performed the action

userIsFromParentSite

public Boolean userIsFromParentSite

true if this change was performed by a user on a parent site.

action

public String action

What action was taken. Valid values: `create`, `read`, `update`, `destroy`, `move`, `login`, `failedlogin`, `copy`, `user_create`, `user_update`, `user_destroy`, `group_create`, `group_update`, `group_destroy`, `permission_create`, `permission_destroy`, `api_key_create`, `api_key_update`, `api_key_destroy`

failureType

public String failureType

The type of login failure, if applicable. Valid values: `expired_trial`, `account_overdue`, `locked_out`, `ip_mismatch`, `password_mismatch`, `site_mismatch`, `username_not_found`, `none`, `no_ftp_permission`, `no_web_permission`, `no_directory`, `errno_enoent`, `no_sftp_permission`, `no_dav_permission`, `no_restapi_permission`, `key_mismatch`, `region_mismatch`, `expired_access`, `desktop_ip_mismatch`, `desktop_api_key_not_used_quickly_enough`, `disabled`, `country_mismatch`, `insecure_ftp`, `insecure_cipher`, `rate_limited`

interfaceName

public String interfaceName

Interface through which the action was taken. Valid values: `web`, `ftp`, `robot`, `jsapi`, `webdesktopapi`, `sftp`, `dav`, `desktop`, `restapi`, `scim`, `office`, `mobile`, `as2`, `inbound_email`, `remote`

targetId

public Long targetId

ID of the object (such as Users, or API Keys) on which the action was taken

targetName

public String targetName

Name of the User, Group or other object with a name related to this action

targetPermission

public String targetPermission

Permission level of the action

targetRecursive

public Boolean targetRecursive

Whether or not the action was recursive

targetExpiresAt

public Long targetExpiresAt

If searching for Histories about API keys, this is when the API key will expire. Represented as a Unix timestamp.

targetExpiresAtIso8601

public String targetExpiresAtIso8601

If searching for Histories about API keys, this is when the API key will expire. Represented in ISO8601 format.

targetPermissionSet

public String targetPermissionSet

If searching for Histories about API keys, this represents the permission set of the associated API key

targetPlatform

public String targetPlatform

If searching for Histories about API keys, this is the platform on which the action was taken

targetUsername

public String targetUsername

If searching for Histories about API keys, this is the username on which the action was taken

targetUserId

public Long targetUserId

If searching for Histories about API keys, this is the User ID on which the action was taken

Constructor Detail

HistoryExportResult

public HistoryExportResult()

HistoryExportResult

public HistoryExportResult(HashMap<String,Object> parameters)

HistoryExportResult

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

Method Detail

list

public static ListIterator<HistoryExportResult> 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). history_export_id (required) - int64 - ID of the associated history export.

Throws:

RuntimeException

list

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

Throws:

RuntimeException

list

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

Throws:

RuntimeException

all

public static ListIterator<HistoryExportResult> all()
                                             throws RuntimeException

Throws:

RuntimeException

all

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

Throws:

RuntimeException