com.files.models

Class HistoryExport

java.lang.Object

com.files.models.HistoryExport

All Implemented Interfaces:

ModelInterface

public class HistoryExport
extends Object
implements ModelInterface

Field Summary

Fields

Modifier and Type	Field and Description
Date	endAt End date/time of export range.
String	historyVersion Version of the history for the export.
Long	id History Export ID
String	queryAction Filter results by this this action type.
String	queryDestination Return results that are file moves with paths matching this pattern as destination.
String	queryFailureType If searching for Histories about login failures, this parameter restricts results to failures of this specific type.
String	queryFileId Return results that are file actions related to the file indicated by this File ID
String	queryFolder Return results that are file actions related to files or folders inside folder paths matching this pattern.
String	queryInterface Filter results by this this interface type.
String	queryIp Filter results by this IP address.
String	queryParentId Return results that are file actions inside the parent folder specified by this folder ID
String	queryPath Return results that are file actions related to paths matching this pattern.
String	querySrc Return results that are file moves originating from paths matching this pattern.
String	queryTargetId If searching for Histories about specific objects (such as Users, or API Keys), this paremeter restricts results to objects that match this ID.
String	queryTargetName If searching for Histories about Users, Groups or other objects with names, this parameter restricts results to objects with this name/username.
String	queryTargetPermission If searching for Histories about Permisisons, this parameter restricts results to permissions of this level.
String	queryTargetPermissionSet If searching for Histories about API keys, this parameter restricts results to API keys with this permission set.
String	queryTargetPlatform If searching for Histories about API keys, this parameter restricts results to API keys associated with this platform.
String	queryTargetUserId If searching for Histories about API keys, this parameter restricts results to API keys created by/for this user ID.
String	queryTargetUsername If searching for Histories about API keys, this parameter restricts results to API keys created by/for this username.
String	queryUserId Return results that are actions performed by the user indiciated by this User ID
String	queryUsername Filter results by this username.
String	resultsUrl If `status` is `ready`, this will be a URL where all the results can be downloaded at once as a CSV.
Date	startAt Start date/time of export range.
String	status Status of export.
Long	userId User ID.

Constructor Summary

Constructors

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

Method Summary

Modifier and Type	Method and Description
static HistoryExport	create(HashMap<String,Object> parameters) Parameters: user_id - int64 - User ID.
static HistoryExport	create(HashMap<String,Object> parameters, HashMap<String,Object> options)
static HistoryExport	find(HashMap<String,Object> parameters, HashMap<String,Object> options)
static HistoryExport	find(Long id, HashMap<String,Object> parameters) Parameters: id (required) - int64 - History Export ID.
static HistoryExport	find(Long id, HashMap<String,Object> parameters, HashMap<String,Object> options)
static HistoryExport	get()
static HistoryExport	get(Long id, 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

History Export ID

historyVersion

public String historyVersion

Version of the history for the export.

startAt

public Date startAt

Start date/time of export range.

endAt

public Date endAt

End date/time of export range.

status

public String status

Status of export. Will be: `building`, `ready`, or `failed`

queryAction

public String queryAction

Filter results by this this action type. 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`

queryInterface

public String queryInterface

Filter results by this this interface type. Valid values: `web`, `ftp`, `robot`, `jsapi`, `webdesktopapi`, `sftp`, `dav`, `desktop`, `restapi`, `scim`, `office`, `mobile`, `as2`, `inbound_email`, `remote`

queryUserId

public String queryUserId

Return results that are actions performed by the user indiciated by this User ID

queryFileId

public String queryFileId

Return results that are file actions related to the file indicated by this File ID

queryParentId

public String queryParentId

Return results that are file actions inside the parent folder specified by this folder ID

queryPath

public String queryPath

Return results that are file actions related to paths matching this pattern.

queryFolder

public String queryFolder

Return results that are file actions related to files or folders inside folder paths matching this pattern.

querySrc

public String querySrc

Return results that are file moves originating from paths matching this pattern.

queryDestination

public String queryDestination

Return results that are file moves with paths matching this pattern as destination.

queryIp

public String queryIp

Filter results by this IP address.

queryUsername

public String queryUsername

Filter results by this username.

queryFailureType

public String queryFailureType

If searching for Histories about login failures, this parameter restricts results to failures of this specific type. 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`

queryTargetId

public String queryTargetId

If searching for Histories about specific objects (such as Users, or API Keys), this paremeter restricts results to objects that match this ID.

queryTargetName

public String queryTargetName

If searching for Histories about Users, Groups or other objects with names, this parameter restricts results to objects with this name/username.

queryTargetPermission

public String queryTargetPermission

If searching for Histories about Permisisons, this parameter restricts results to permissions of this level.

queryTargetUserId

public String queryTargetUserId

If searching for Histories about API keys, this parameter restricts results to API keys created by/for this user ID.

queryTargetUsername

public String queryTargetUsername

If searching for Histories about API keys, this parameter restricts results to API keys created by/for this username.

queryTargetPlatform

public String queryTargetPlatform

If searching for Histories about API keys, this parameter restricts results to API keys associated with this platform.

queryTargetPermissionSet

public String queryTargetPermissionSet

If searching for Histories about API keys, this parameter restricts results to API keys with this permission set.

resultsUrl

public String resultsUrl

If `status` is `ready`, this will be a URL where all the results can be downloaded at once as a CSV.

userId

public Long userId

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

Constructor Detail

HistoryExport

public HistoryExport()

HistoryExport

public HistoryExport(HashMap<String,Object> parameters)

HistoryExport

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

Method Detail

save

public void save()
          throws IOException

Throws:

IOException

find

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

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

Throws:

RuntimeException

find

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

Throws:

RuntimeException

find

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

Throws:

RuntimeException

get

public static HistoryExport get()
                         throws RuntimeException

Throws:

RuntimeException

get

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

Throws:

RuntimeException

create

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

Parameters: user_id - int64 - User ID. Provide a value of `0` to operate the current session's user. start_at - string - Start date/time of export range. end_at - string - End date/time of export range. query_action - string - Filter results by this this action type. 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` query_interface - string - Filter results by this this interface type. Valid values: `web`, `ftp`, `robot`, `jsapi`, `webdesktopapi`, `sftp`, `dav`, `desktop`, `restapi`, `scim`, `office`, `mobile`, `as2`, `inbound_email`, `remote` query_user_id - string - Return results that are actions performed by the user indiciated by this User ID query_file_id - string - Return results that are file actions related to the file indicated by this File ID query_parent_id - string - Return results that are file actions inside the parent folder specified by this folder ID query_path - string - Return results that are file actions related to paths matching this pattern. query_folder - string - Return results that are file actions related to files or folders inside folder paths matching this pattern. query_src - string - Return results that are file moves originating from paths matching this pattern. query_destination - string - Return results that are file moves with paths matching this pattern as destination. query_ip - string - Filter results by this IP address. query_username - string - Filter results by this username. query_failure_type - string - If searching for Histories about login failures, this parameter restricts results to failures of this specific type. 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` query_target_id - string - If searching for Histories about specific objects (such as Users, or API Keys), this paremeter restricts results to objects that match this ID. query_target_name - string - If searching for Histories about Users, Groups or other objects with names, this parameter restricts results to objects with this name/username. query_target_permission - string - If searching for Histories about Permisisons, this parameter restricts results to permissions of this level. query_target_user_id - string - If searching for Histories about API keys, this parameter restricts results to API keys created by/for this user ID. query_target_username - string - If searching for Histories about API keys, this parameter restricts results to API keys created by/for this username. query_target_platform - string - If searching for Histories about API keys, this parameter restricts results to API keys associated with this platform. query_target_permission_set - string - If searching for Histories about API keys, this parameter restricts results to API keys with this permission set.

Throws:

RuntimeException

create

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

Throws:

RuntimeException