Package org.xrpl.xrpl4j.model.client.accounts

Interface AccountTransactionsRequestParams

All Superinterfaces:

XrplRequestParams

All Known Implementing Classes:

ImmutableAccountTransactionsRequestParams

@Immutable
public interface AccountTransactionsRequestParams
extends XrplRequestParams

Request parameters for the account_tx rippled method.

Method Summary

Modifier and Type	Method	Description
Address	account()	A unique Address for the account.
default boolean	binary()	Whether or not to return transactions as JSON or binary-encoded hex strings.
static ImmutableAccountTransactionsRequestParams.Builder	builder()	Construct a builder for this class.
default AccountTransactionsRequestParams	emptyBoundedParametersIfSpecifierPresent()	Nullifies ledgerIndexMinimum() and ledgerIndexMaximum() if ledgerSpecifier() is present.
default boolean	forward()	If set to true, returns values indexed with the oldest ledger first.
Optional<Hash256>	ledgerHash()	Deprecated. Ledger hash should be specified in ledgerSpecifier().
Optional<LedgerIndex>	ledgerIndex()	Deprecated. Ledger index and any shortcut values should be specified in ledgerSpecifier().
Optional<LedgerIndex>	ledgerIndexMax()	Deprecated. ledger_index_max field should be specified by ledgerIndexMaximum().
default LedgerIndexBound	ledgerIndexMaximum()	The most recent ledger to include transactions from.
Optional<LedgerIndex>	ledgerIndexMin()	Deprecated. ledger_index_min field should be specified by ledgerIndexMinimum()
default LedgerIndexBound	ledgerIndexMinimum()	The earliest ledger to include transactions from.
default Optional<LedgerSpecifier>	ledgerSpecifier()	Specifies the ledger version to request.
Optional<com.google.common.primitives.UnsignedInteger>	limit()	Limit the number of transactions to retrieve.
Optional<Marker>	marker()	Value from a previous paginated response.
default void	validateSpecifierNotCurrentOrClosed()	Validates that if LedgerSpecifier.ledgerIndexShortcut() is present, its value is LedgerIndexShortcut.VALIDATED.

Method Detail

builder

static ImmutableAccountTransactionsRequestParams.Builder builder()

Construct a builder for this class.

Returns:

An ImmutableAccountTransactionsRequestParams.Builder.

account

Address account()

A unique Address for the account.

Returns:

The Address of the account.

ledgerIndexMin

@Deprecated
@Auxiliary
Optional<LedgerIndex> ledgerIndexMin()

Deprecated.

ledger_index_min field should be specified by ledgerIndexMinimum()

The earliest ledger to include transactions from. A value of -1 instructs the server to use the earliest validated ledger version available.

Returns:

A LedgerIndex with a default of empty.

ledgerIndexMax

@Deprecated
@Auxiliary
Optional<LedgerIndex> ledgerIndexMax()

Deprecated.

ledger_index_max field should be specified by ledgerIndexMaximum().

The most recent ledger to include transactions from. A value of -1 instructs the server to use the most recent validated ledger version available.

Returns:

A LedgerIndex with a default of empty.

ledgerIndexMinimum

@Default
@Nullable
default LedgerIndexBound ledgerIndexMinimum()

The earliest ledger to include transactions from. A value of -1 instructs the server to use the earliest validated ledger version available.

Returns:

A LedgerIndexBound with a default of empty.

ledgerIndexMaximum

@Default
@Nullable
default LedgerIndexBound ledgerIndexMaximum()

The most recent ledger to include transactions from. A value of -1 instructs the server to use the most recent validated ledger version available.

Returns:

A LedgerIndexBound with a default of empty.

ledgerHash

@Deprecated
@Auxiliary
Optional<Hash256> ledgerHash()

Deprecated.

Ledger hash should be specified in ledgerSpecifier().

Return transactions from the ledger with this hash only.

Returns:

An optionally-present Hash256 containing the ledger hash.

ledgerIndex

@Deprecated
@Auxiliary
Optional<LedgerIndex> ledgerIndex()

Deprecated.

Ledger index and any shortcut values should be specified in ledgerSpecifier().

Return transactions from the ledger with this index only.

Returns:

A LedgerIndex containing the ledger index, defaults to "current".

ledgerSpecifier

@Default
default Optional<LedgerSpecifier> ledgerSpecifier()

Specifies the ledger version to request. A ledger version can be specified by ledger hash, numerical ledger index, or a shortcut value.

The only valid ledger index shortcut for this request object is LedgerIndexShortcut.VALIDATED.

Setting this value will nullify and take precedence over ledgerIndexMinimum() and ledgerIndexMaximum()

Returns:

A LedgerSpecifier specifying the ledger version to request.

binary

@Derived
default boolean binary()

Whether or not to return transactions as JSON or binary-encoded hex strings. Always false.

Returns:

Always false.

forward

@Default
default boolean forward()

If set to true, returns values indexed with the oldest ledger first. Otherwise, the results are indexed with the newest ledger first. (Each page of results may not be internally ordered, but the pages are overall ordered.)

Returns:

true if values should be indexed with the oldest ledger first, otherwise false. Defaults to false.

limit

Optional<com.google.common.primitives.UnsignedInteger> limit()

Limit the number of transactions to retrieve. The server is not required to honor this value.

Returns:

An optionally-present UnsignedInteger representing the number of transactions to return.

marker

Optional<Marker> marker()

Value from a previous paginated response. Resume retrieving data where that response left off. This value is stable even if there is a change in the server's range of available ledgers.

Returns:

An optionally-present String containing the marker.

validateSpecifierNotCurrentOrClosed

@Check
default void validateSpecifierNotCurrentOrClosed()

Validates that if LedgerSpecifier.ledgerIndexShortcut() is present, its value is LedgerIndexShortcut.VALIDATED.

emptyBoundedParametersIfSpecifierPresent

@Check
default AccountTransactionsRequestParams emptyBoundedParametersIfSpecifierPresent()

Nullifies ledgerIndexMinimum() and ledgerIndexMaximum() if ledgerSpecifier() is present.

Returns:

An AccountTransactionsRequestParams.