com.files.models

Class ActionNotificationExport

java.lang.Object

com.files.models.ActionNotificationExport

All Implemented Interfaces:

ModelInterface

public class ActionNotificationExport
extends Object
implements ModelInterface

Field Summary

Fields

Modifier and Type	Field and Description
Date	endAt End date/time of export range.
String	exportVersion Version of the underlying records for the export.
Long	id History Export ID
String	queryFolder Return notifications that were triggered by actions in this folder.
String	queryMessage Error message associated with the request, if any.
String	queryPath Return notifications that were triggered by actions on this specific path.
String	queryRequestMethod The HTTP request method used by the webhook.
String	queryRequestUrl The target webhook URL.
String	queryStatus The HTTP status returned from the server in response to the webhook request.
Boolean	querySuccess true if the webhook request succeeded (i.e. returned a 200 or 204 response status). false otherwise.
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
ActionNotificationExport()
ActionNotificationExport(HashMap<String,Object> parameters)
ActionNotificationExport(HashMap<String,Object> parameters, HashMap<String,Object> options)

Method Summary

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

exportVersion

public String exportVersion

Version of the underlying records 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. Valid values: `building`, `ready`, or `failed`

queryPath

public String queryPath

Return notifications that were triggered by actions on this specific path.

queryFolder

public String queryFolder

Return notifications that were triggered by actions in this folder.

queryMessage

public String queryMessage

Error message associated with the request, if any.

queryRequestMethod

public String queryRequestMethod

The HTTP request method used by the webhook.

queryRequestUrl

public String queryRequestUrl

The target webhook URL.

queryStatus

public String queryStatus

The HTTP status returned from the server in response to the webhook request.

querySuccess

public Boolean querySuccess

true if the webhook request succeeded (i.e. returned a 200 or 204 response status). false otherwise.

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

ActionNotificationExport

public ActionNotificationExport()

ActionNotificationExport

public ActionNotificationExport(HashMap<String,Object> parameters)

ActionNotificationExport

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

Method Detail

save

public void save()
          throws IOException

Throws:

IOException

find

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

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

Throws:

RuntimeException

find

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

Throws:

RuntimeException

find

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

Throws:

RuntimeException

get

public static ActionNotificationExport get()
                                    throws RuntimeException

Throws:

RuntimeException

get

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

Throws:

RuntimeException

create

public static ActionNotificationExport 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_message - string - Error message associated with the request, if any. query_request_method - string - The HTTP request method used by the webhook. query_request_url - string - The target webhook URL. query_status - string - The HTTP status returned from the server in response to the webhook request. query_success - boolean - true if the webhook request succeeded (i.e. returned a 200 or 204 response status). false otherwise. query_path - string - Return notifications that were triggered by actions on this specific path. query_folder - string - Return notifications that were triggered by actions in this folder.

Throws:

RuntimeException

create

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

Throws:

RuntimeException