com.files.models

Class AutomationRun

java.lang.Object

com.files.models.AutomationRun

All Implemented Interfaces:

ModelInterface

public class AutomationRun
extends Object
implements ModelInterface

Field Summary

Fields

Modifier and Type	Field and Description
Long	automationId ID of the associated Automation.
Date	completedAt Automation run completion/failure date/time.
Date	createdAt Automation run start date/time.
Long	failedOperations Count of failed operations.
Long	id ID.
Double	runtime Automation run runtime.
String	status The success status of the AutomationRun.
String	statusMessagesUrl Link to status messages log file.
Long	successfulOperations Count of successful operations.

Constructor Summary

Constructors

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

Method Summary

Modifier and Type	Method and Description
static ListIterator<AutomationRun>	all()
static ListIterator<AutomationRun>	all(HashMap<String,Object> parameters, HashMap<String,Object> options)
static AutomationRun	find(HashMap<String,Object> parameters, HashMap<String,Object> options)
static AutomationRun	find(Long id, HashMap<String,Object> parameters) Parameters: id (required) - int64 - Automation Run ID.
static AutomationRun	find(Long id, HashMap<String,Object> parameters, HashMap<String,Object> options)
static AutomationRun	get()
static AutomationRun	get(Long id, HashMap<String,Object> parameters, HashMap<String,Object> options)
static ListIterator<AutomationRun>	list() Parameters: cursor - string - Used for pagination.
static ListIterator<AutomationRun>	list(HashMap<String,Object> parameters)
static ListIterator<AutomationRun>	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

ID.

automationId

public Long automationId

ID of the associated Automation.

completedAt

public Date completedAt

Automation run completion/failure date/time.

createdAt

public Date createdAt

Automation run start date/time.

runtime

public Double runtime

Automation run runtime.

status

public String status

The success status of the AutomationRun. One of `running`, `success`, `partial_failure`, or `failure`.

successfulOperations

public Long successfulOperations

Count of successful operations.

failedOperations

public Long failedOperations

Count of failed operations.

statusMessagesUrl

public String statusMessagesUrl

Link to status messages log file.

Constructor Detail

AutomationRun

public AutomationRun()

AutomationRun

public AutomationRun(HashMap<String,Object> parameters)

AutomationRun

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

Method Detail

list

public static ListIterator<AutomationRun> 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 `automation_id`, `created_at` or `status`. filter - object - If set, return records where the specified field is equal to the supplied value. Valid fields are `status` and `automation_id`. Valid field combinations are `[ status, automation_id ]`. automation_id (required) - int64 - ID of the associated Automation.

Throws:

RuntimeException

list

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

Throws:

RuntimeException

list

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

Throws:

RuntimeException

all

public static ListIterator<AutomationRun> all()
                                       throws RuntimeException

Throws:

RuntimeException

all

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

Throws:

RuntimeException

find

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

Parameters: id (required) - int64 - Automation Run ID.

Throws:

RuntimeException

find

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

Throws:

RuntimeException

find

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

Throws:

RuntimeException

get

public static AutomationRun get()
                         throws RuntimeException

Throws:

RuntimeException

get

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

Throws:

RuntimeException