com.files.models

Class ExternalEvent

java.lang.Object

com.files.models.ExternalEvent

All Implemented Interfaces:

ModelInterface

public class ExternalEvent
extends Object
implements ModelInterface

Field Summary

Fields

Modifier and Type	Field and Description
String	body Event body
String	bodyUrl Link to log file.
Long	bytesSynced For sync events, the total number of bytes synced.
Long	comparedFiles For sync events, the number of files considered for the sync.
Long	comparedFolders For sync events, the number of folders listed and considered for the sync.
Date	createdAt External event create date/time
Long	erroredFiles For sync events, the number of files that encountered errors.
String	eventType Type of event being recorded.
Long	folderBehaviorId Folder Behavior ID
Long	id Event ID
String	remoteServerType Associated Remote Server type, if any
Long	siemHttpDestinationId SIEM HTTP Destination ID.
String	status Status of event.
Long	successfulFiles For sync events, the number of files handled successfully.

Constructor Summary

Constructors

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

Method Summary

Modifier and Type	Method and Description
static ListIterator<ExternalEvent>	all()
static ListIterator<ExternalEvent>	all(HashMap<String,Object> parameters, HashMap<String,Object> options)
static ExternalEvent	create(HashMap<String,Object> parameters) Parameters: status (required) - string - Status of event.
static ExternalEvent	create(HashMap<String,Object> parameters, HashMap<String,Object> options)
static ExternalEvent	find(HashMap<String,Object> parameters, HashMap<String,Object> options)
static ExternalEvent	find(Long id, HashMap<String,Object> parameters) Parameters: id (required) - int64 - External Event ID.
static ExternalEvent	find(Long id, HashMap<String,Object> parameters, HashMap<String,Object> options)
static ExternalEvent	get()
static ExternalEvent	get(Long id, HashMap<String,Object> parameters, HashMap<String,Object> options)
static ListIterator<ExternalEvent>	list() Parameters: cursor - string - Used for pagination.
static ListIterator<ExternalEvent>	list(HashMap<String,Object> parameters)
static ListIterator<ExternalEvent>	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

Event ID

eventType

public String eventType

Type of event being recorded.

status

public String status

Status of event.

body

public String body

Event body

createdAt

public Date createdAt

External event create date/time

bodyUrl

public String bodyUrl

Link to log file.

folderBehaviorId

public Long folderBehaviorId

Folder Behavior ID

siemHttpDestinationId

public Long siemHttpDestinationId

SIEM HTTP Destination ID.

successfulFiles

public Long successfulFiles

For sync events, the number of files handled successfully.

erroredFiles

public Long erroredFiles

For sync events, the number of files that encountered errors.

bytesSynced

public Long bytesSynced

For sync events, the total number of bytes synced.

comparedFiles

public Long comparedFiles

For sync events, the number of files considered for the sync.

comparedFolders

public Long comparedFolders

For sync events, the number of folders listed and considered for the sync.

remoteServerType

public String remoteServerType

Associated Remote Server type, if any

Constructor Detail

ExternalEvent

public ExternalEvent()

ExternalEvent

public ExternalEvent(HashMap<String,Object> parameters)

ExternalEvent

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

Method Detail

save

public void save()
          throws IOException

Throws:

IOException

list

public static ListIterator<ExternalEvent> 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 `remote_server_type`, `site_id`, `folder_behavior_id`, `siem_http_destination_id`, `event_type`, `created_at` or `status`. filter - object - If set, return records where the specified field is equal to the supplied value. Valid fields are `created_at`, `event_type`, `remote_server_type`, `status`, `folder_behavior_id` or `siem_http_destination_id`. Valid field combinations are `[ created_at, event_type, status ]`, `[ created_at, event_type ]` or `[ created_at, status ]`. 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_prefix - object - If set, return records where the specified field is prefixed by the supplied value. Valid fields are `remote_server_type`. 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<ExternalEvent> list(HashMap<String,Object> parameters)
                                        throws RuntimeException

Throws:

RuntimeException

list

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

Throws:

RuntimeException

all

public static ListIterator<ExternalEvent> all()
                                       throws RuntimeException

Throws:

RuntimeException

all

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

Throws:

RuntimeException

find

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

Parameters: id (required) - int64 - External Event ID.

Throws:

RuntimeException

find

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

Throws:

RuntimeException

find

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

Throws:

RuntimeException

get

public static ExternalEvent get()
                         throws RuntimeException

Throws:

RuntimeException

get

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

Throws:

RuntimeException

create

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

Parameters: status (required) - string - Status of event. body (required) - string - Event body

Throws:

RuntimeException

create

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

Throws:

RuntimeException