Class ApiConstants

java.lang.Object

com.bluebell.greenhouse.planter.constants.ApiConstants

public final class ApiConstants
extends Object

Constants used for the planter and related modules.

Version:

3.0.6

Author:

Stephen Prizio

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static final class	ApiConstants.Names	API names and descriptions used in OpenAPI metadata.
static final class	ApiConstants.QueryParameters	Query parameter names used by both planter and the testing module.
static final class	ApiConstants.StatusResponseMessages	Common status/response message templates for API results and errors.

Field Summary

Fields

Modifier and Type	Field	Description
static final String	CATCH_ALL_ENUM_VALUE	Used as the "include all" code for enums.
static final String	DEFAULT_LOOKBACK_DAYS	Default lookback period in days for summary/report endpoints.
static final String	DEFAULT_PAGE	Default page number for paginated endpoints.
static final String	DEFAULT_PAGE_SIZE	Default page size for paginated endpoints.
static final String	DEFAULT_SORT	Default sort direction for paginated endpoints.
static final String	DEFAULT_TRADE_RECORD_COLLECTION_SIZE	Default size for trade records.
static final int	DISK_READ_LIMIT	Defines the disk chunk size for file reads from disk.

Method Summary

Methods inherited from class Object

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

Field Details

DISK_READ_LIMIT

public static final int DISK_READ_LIMIT

Defines the disk chunk size for file reads from disk.

See Also:

• Constant Field Values

DEFAULT_TRADE_RECORD_COLLECTION_SIZE

public static final String DEFAULT_TRADE_RECORD_COLLECTION_SIZE

Default size for trade records.

See Also:

• Constant Field Values

DEFAULT_PAGE

public static final String DEFAULT_PAGE

Default page number for paginated endpoints.

See Also:

• Constant Field Values

DEFAULT_PAGE_SIZE

public static final String DEFAULT_PAGE_SIZE

Default page size for paginated endpoints.

See Also:

• Constant Field Values

DEFAULT_LOOKBACK_DAYS

public static final String DEFAULT_LOOKBACK_DAYS

Default lookback period in days for summary/report endpoints.

See Also:

• Constant Field Values

DEFAULT_SORT

public static final String DEFAULT_SORT

Default sort direction for paginated endpoints.

See Also:

• Constant Field Values

CATCH_ALL_ENUM_VALUE

public static final String CATCH_ALL_ENUM_VALUE

Used as the "include all" code for enums.

See Also:

• Constant Field Values