com.appiancorp.suiteapi.process.history.options

Class AuditHistoryProcessOptionsBuilder

java.lang.Object

com.appiancorp.suiteapi.process.history.options.AuditHistoryOptionsBuilder

com.appiancorp.suiteapi.process.history.options.AuditHistoryProcessOptionsBuilder

public class AuditHistoryProcessOptionsBuilder
extends AuditHistoryOptionsBuilder

AuditHistoryProcessOptionsBuilder

Method Summary

Modifier and Type	Method and Description
AuditHistoryProcessOptions	build()
AuditHistoryProcessOptionsBuilder	setLocale(java.util.Locale locale)
AuditHistoryProcessOptionsBuilder	setMaximumTimestamp(java.sql.Timestamp timestamp) The maximum timestamp of process audit history to be searched for return.
AuditHistoryProcessOptionsBuilder	setMaximumTransientBatchSize(int maximumTransientBatchSize) Maximum transient batch size, used for internal batching purposes when a source does not support streaming.
AuditHistoryProcessOptionsBuilder	setMaxJsonByteSize(long maxJsonByteSize) Maximum JSON byte size helps prevent creating row data with excessively large payloads (e.g., a process variable array with excessively large size) from throwing OOM in being created.
AuditHistoryProcessOptionsBuilder	setMinimumTimestamp(java.sql.Timestamp timestamp) The minimum timestamp of process audit history to be searched for return.

Methods inherited from class com.appiancorp.suiteapi.process.history.options.AuditHistoryOptionsBuilder

process, processModel, processModel

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Method Detail

setLocale

public AuditHistoryProcessOptionsBuilder setLocale(java.util.Locale locale)

Parameters:

locale - for casting purposes (e.g., timestamp to String)

Returns:

AuditHistoryProcessOptionsBuilder to continue building

setMinimumTimestamp

public AuditHistoryProcessOptionsBuilder setMinimumTimestamp(java.sql.Timestamp timestamp)

The minimum timestamp of process audit history to be searched for return.

Parameters:

timestamp -

Returns:

AuditHistoryProcessOptionsBuilder to continue building

setMaximumTimestamp

public AuditHistoryProcessOptionsBuilder setMaximumTimestamp(java.sql.Timestamp timestamp)

The maximum timestamp of process audit history to be searched for return.

Parameters:

timestamp -

Returns:

AuditHistoryProcessOptionsBuilder to continue building

setMaximumTransientBatchSize

public AuditHistoryProcessOptionsBuilder setMaximumTransientBatchSize(int maximumTransientBatchSize)

Maximum transient batch size, used for internal batching purposes when a source does not support streaming.

Parameters:

maximumTransientBatchSize -

Returns:

AuditHistoryProcessOptionsBuilder to continue building

setMaxJsonByteSize

public AuditHistoryProcessOptionsBuilder setMaxJsonByteSize(long maxJsonByteSize)

Maximum JSON byte size helps prevent creating row data with excessively large payloads (e.g., a process variable array with excessively large size) from throwing OOM in being created.

Parameters:

maxJsonByteSize - currently only unsigned values less than Integer.MAX_VALUE are applied; must be >=AuditHistoryOptions.MINIMUM_SIZE_FOR_MAX_JSON_BYTE_SIZE or IllegalArgumentException

Returns:

AuditHistoryProcessModelOptionsBuilder to continue building

build

public AuditHistoryProcessOptions build()

Specified by:

build in class AuditHistoryOptionsBuilder

Returns:

AuditHistoryProcessOptions fully built