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

Interface AccountObjectsRequestParams

All Superinterfaces:

XrplRequestParams

All Known Implementing Classes:

ImmutableAccountObjectsRequestParams

@Immutable
public interface AccountObjectsRequestParams
extends XrplRequestParams

Represents the request parameters for an "account_objects" rippled API call.

Nested Class Summary

Nested Classes

Modifier and Type	Interface	Description
static class	AccountObjectsRequestParams.AccountObjectType	The enum Account object type.

Method Summary

Modifier and Type	Method	Description
Address	account()	The unique XRPL Address for the account.
static ImmutableAccountObjectsRequestParams.Builder	builder()	Construct a builder for this class.
default boolean	deletionBlockersOnly()	If true, the response only includes LedgerObjects that would block this account from being deleted.
Optional<Hash256>	ledgerHash()	Deprecated. Ledger hash should be specified in ledgerSpecifier().
LedgerIndex	ledgerIndex()	Deprecated. Ledger index and any shortcut values should be specified in ledgerSpecifier().
default LedgerSpecifier	ledgerSpecifier()	Specifies the ledger version to request.
Optional<com.google.common.primitives.UnsignedInteger>	limit()	The maximum number of LedgerObjects to include in the resulting AccountObjectsResult.accountObjects().
Optional<Marker>	marker()	Value from a previous paginated response.
static AccountObjectsRequestParams	of(Address classicAddress)	Construct an AccountObjectsRequestParams for a given account and otherwise default parameters.
Optional<AccountObjectsRequestParams.AccountObjectType>	type()	If included, filter results to include only this type of ledger object.

Method Detail

builder

static ImmutableAccountObjectsRequestParams.Builder builder()

Construct a builder for this class.

Returns:

An ImmutableAccountObjectsRequestParams.Builder.

of

static AccountObjectsRequestParams of(Address classicAddress)

Construct an AccountObjectsRequestParams for a given account and otherwise default parameters.

Parameters:

classicAddress - The classic Address of the account to request objects for.

Returns:

An AccountObjectsRequestParams for the given Address.

account

Address account()

The unique XRPL Address for the account.

Returns:

The unique XRPL Address for the account.

type

Optional<AccountObjectsRequestParams.AccountObjectType> type()

If included, filter results to include only this type of ledger object.

Returns:

An optionally-present AccountObjectsRequestParams.AccountObjectType to filter by.

deletionBlockersOnly

@Default
default boolean deletionBlockersOnly()

If true, the response only includes LedgerObjects that would block this account from being deleted. The default is false.

Returns:

true if requesting only ledger objects that would block this account from being deleted, otherwise false.

ledgerHash

@Deprecated
@Auxiliary
Optional<Hash256> ledgerHash()

Deprecated.

Ledger hash should be specified in ledgerSpecifier().

A 20-byte hex string for the ledger version to use.

Returns:

An optionally-present Hash256.

ledgerIndex

@Deprecated
@Nullable
@Auxiliary
LedgerIndex ledgerIndex()

Deprecated.

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

The ledger index of the ledger to use, or a shortcut string to choose a ledger automatically.

Returns:

A LedgerIndex. Defaults to LedgerIndex.CURRENT.

ledgerSpecifier

@Default
default LedgerSpecifier ledgerSpecifier()

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

Returns:

A LedgerSpecifier specifying the ledger version to request.

limit

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

The maximum number of LedgerObjects to include in the resulting AccountObjectsResult.accountObjects(). Must be within the inclusive range 10 to 400 on non-admin connections. The default is 200.

Returns:

An optionally-present UnsignedInteger denoting the response limit.

marker

Optional<Marker> marker()

Value from a previous paginated response. Resume retrieving data where that response left off.

Returns:

An optionally-present String containing the marker.