com.files.models

Class ExavaultApiRequestLog

java.lang.Object

com.files.models.ExavaultApiRequestLog

All Implemented Interfaces:

ModelInterface

public class ExavaultApiRequestLog
extends Object
implements ModelInterface

Field Summary

Fields

Modifier and Type	Field and Description
Long	durationMs Duration (in milliseconds)
String	endpoint Name of API Endpoint
String	errorMessage Error message, if applicable
String	errorType Error type, if applicable
String	requestIp IP of requesting client
String	requestMethod HTTP Method
Long	responseCode HTTP Response Code
Boolean	success `false` if HTTP Response Code is 4xx or 5xx
Date	timestamp Start Time of Action
String	userAgent User-Agent
String	version Exavault API Version

Constructor Summary

Constructors

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

Method Summary

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

timestamp

public Date timestamp

Start Time of Action

endpoint

public String endpoint

Name of API Endpoint

version

public String version

Exavault API Version

requestIp

public String requestIp

IP of requesting client

requestMethod

public String requestMethod

HTTP Method

errorType

public String errorType

Error type, if applicable

errorMessage

public String errorMessage

Error message, if applicable

userAgent

public String userAgent

User-Agent

responseCode

public Long responseCode

HTTP Response Code

success

public Boolean success

`false` if HTTP Response Code is 4xx or 5xx

durationMs

public Long durationMs

Duration (in milliseconds)

Constructor Detail

ExavaultApiRequestLog

public ExavaultApiRequestLog()

ExavaultApiRequestLog

public ExavaultApiRequestLog(HashMap<String,Object> parameters)

ExavaultApiRequestLog

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

Method Detail

list

public static ListIterator<ExavaultApiRequestLog> 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). filter - object - If set, return records where the specified field is equal to the supplied value. Valid fields are `start_date`, `end_date`, `request_ip`, `request_method` or `success`. Valid field combinations are `[ start_date ]`, `[ end_date ]`, `[ request_ip ]`, `[ request_method ]`, `[ success ]`, `[ start_date, end_date ]`, `[ start_date, request_ip ]`, `[ start_date, request_method ]`, `[ start_date, success ]`, `[ end_date, request_ip ]`, `[ end_date, request_method ]`, `[ end_date, success ]`, `[ request_ip, request_method ]`, `[ request_ip, success ]`, `[ request_method, success ]`, `[ start_date, end_date, request_ip ]`, `[ start_date, end_date, request_method ]`, `[ start_date, end_date, success ]`, `[ start_date, request_ip, request_method ]`, `[ start_date, request_ip, success ]`, `[ start_date, request_method, success ]`, `[ end_date, request_ip, request_method ]`, `[ end_date, request_ip, success ]`, `[ end_date, request_method, success ]`, `[ request_ip, request_method, success ]`, `[ start_date, end_date, request_ip, request_method ]`, `[ start_date, end_date, request_ip, success ]`, `[ start_date, end_date, request_method, success ]`, `[ start_date, request_ip, request_method, success ]` or `[ end_date, request_ip, request_method, success ]`. filter_prefix - object - If set, return records where the specified field is prefixed by the supplied value. Valid fields are `request_ip` and `request_method`. Valid field combinations are `[ start_date ]`, `[ end_date ]`, `[ request_ip ]`, `[ request_method ]`, `[ success ]`, `[ start_date, end_date ]`, `[ start_date, request_ip ]`, `[ start_date, request_method ]`, `[ start_date, success ]`, `[ end_date, request_ip ]`, `[ end_date, request_method ]`, `[ end_date, success ]`, `[ request_ip, request_method ]`, `[ request_ip, success ]`, `[ request_method, success ]`, `[ start_date, end_date, request_ip ]`, `[ start_date, end_date, request_method ]`, `[ start_date, end_date, success ]`, `[ start_date, request_ip, request_method ]`, `[ start_date, request_ip, success ]`, `[ start_date, request_method, success ]`, `[ end_date, request_ip, request_method ]`, `[ end_date, request_ip, success ]`, `[ end_date, request_method, success ]`, `[ request_ip, request_method, success ]`, `[ start_date, end_date, request_ip, request_method ]`, `[ start_date, end_date, request_ip, success ]`, `[ start_date, end_date, request_method, success ]`, `[ start_date, request_ip, request_method, success ]` or `[ end_date, request_ip, request_method, success ]`.

Throws:

RuntimeException

list

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

Throws:

RuntimeException

list

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

Throws:

RuntimeException

all

public static ListIterator<ExavaultApiRequestLog> all()
                                               throws RuntimeException

Throws:

RuntimeException

all

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

Throws:

RuntimeException