Class V1DocketParams.Body
-
- All Implemented Interfaces:
public final class V1DocketParams.Body
-
-
Nested Class Summary
Nested Classes Modifier and Type Class Description public final classV1DocketParams.Body.BuilderA builder for Body.
-
Method Summary
Modifier and Type Method Description final V1DocketParams.Typetype()Search dockets or look up a docket by ID final Optional<Boolean>acknowledgePacerFees()Required when live: true. final Optional<String>court()Optional court slug for filtering (e.g. final Optional<LocalDate>dateFiledAfter()Optional lower bound for filing date (YYYY-MM-DD) final Optional<LocalDate>dateFiledBefore()Optional upper bound for filing date (YYYY-MM-DD) final Optional<String>docketId()Docket ID (required for lookup) final Optional<Boolean>includeEntries()Include docket entries/filings in lookup responses. final Optional<Long>limit()Page size for search results or entry list (default 25 for search, 50 for lookup) final Optional<Boolean>live()Trigger a live PACER fetch for dockets not yet in the RECAP archive. final Optional<Long>offset()Offset for search results or entry list final Optional<String>query()Case name or party name search query (required for search) final JsonField<V1DocketParams.Type>_type()Returns the raw JSON value of type. final JsonField<Boolean>_acknowledgePacerFees()Returns the raw JSON value of acknowledgePacerFees. final JsonField<String>_court()Returns the raw JSON value of court. final JsonField<LocalDate>_dateFiledAfter()Returns the raw JSON value of dateFiledAfter. final JsonField<LocalDate>_dateFiledBefore()Returns the raw JSON value of dateFiledBefore. final JsonField<String>_docketId()Returns the raw JSON value of docketId. final JsonField<Boolean>_includeEntries()Returns the raw JSON value of includeEntries. final JsonField<Long>_limit()Returns the raw JSON value of limit. final JsonField<Boolean>_live()Returns the raw JSON value of live. final JsonField<Long>_offset()Returns the raw JSON value of offset. final JsonField<String>_query()Returns the raw JSON value of query. final Map<String, JsonValue>_additionalProperties()final V1DocketParams.Body.BuildertoBuilder()final V1DocketParams.Bodyvalidate()Validates that the types of all values in this object match their expected types recursively. final BooleanisValid()Booleanequals(Object other)IntegerhashCode()StringtoString()final static V1DocketParams.Body.Builderbuilder()Returns a mutable builder for constructing an instance of Body. -
-
Method Detail
-
type
final V1DocketParams.Type type()
Search dockets or look up a docket by ID
-
acknowledgePacerFees
final Optional<Boolean> acknowledgePacerFees()
Required when live: true. Acknowledges that PACER fees (up to
$3.00 per docket) plus a $
0.05 service fee will be charged to your account.
-
court
final Optional<String> court()
Optional court slug for filtering (e.g. "nysd", "ca9", "cafc"). Use legal.listCourts() to find slugs.
-
dateFiledAfter
final Optional<LocalDate> dateFiledAfter()
Optional lower bound for filing date (YYYY-MM-DD)
-
dateFiledBefore
final Optional<LocalDate> dateFiledBefore()
Optional upper bound for filing date (YYYY-MM-DD)
-
includeEntries
final Optional<Boolean> includeEntries()
Include docket entries/filings in lookup responses. Coming soon — currently returns 501. The parameter is accepted for forward compatibility.
-
limit
final Optional<Long> limit()
Page size for search results or entry list (default 25 for search, 50 for lookup)
-
live
final Optional<Boolean> live()
Trigger a live PACER fetch for dockets not yet in the RECAP archive. Requires acknowledgePacerFees: true. PACER charges up to
$3.00 per docket sheet plus a $
0.05 service fee. Only valid with type: "lookup".
-
_type
final JsonField<V1DocketParams.Type> _type()
Returns the raw JSON value of type.
Unlike type, this method doesn't throw if the JSON field has an unexpected type.
-
_acknowledgePacerFees
final JsonField<Boolean> _acknowledgePacerFees()
Returns the raw JSON value of acknowledgePacerFees.
Unlike acknowledgePacerFees, this method doesn't throw if the JSON field has an unexpected type.
-
_court
final JsonField<String> _court()
Returns the raw JSON value of court.
Unlike court, this method doesn't throw if the JSON field has an unexpected type.
-
_dateFiledAfter
final JsonField<LocalDate> _dateFiledAfter()
Returns the raw JSON value of dateFiledAfter.
Unlike dateFiledAfter, this method doesn't throw if the JSON field has an unexpected type.
-
_dateFiledBefore
final JsonField<LocalDate> _dateFiledBefore()
Returns the raw JSON value of dateFiledBefore.
Unlike dateFiledBefore, this method doesn't throw if the JSON field has an unexpected type.
-
_docketId
final JsonField<String> _docketId()
Returns the raw JSON value of docketId.
Unlike docketId, this method doesn't throw if the JSON field has an unexpected type.
-
_includeEntries
final JsonField<Boolean> _includeEntries()
Returns the raw JSON value of includeEntries.
Unlike includeEntries, this method doesn't throw if the JSON field has an unexpected type.
-
_limit
final JsonField<Long> _limit()
Returns the raw JSON value of limit.
Unlike limit, this method doesn't throw if the JSON field has an unexpected type.
-
_live
final JsonField<Boolean> _live()
Returns the raw JSON value of live.
Unlike live, this method doesn't throw if the JSON field has an unexpected type.
-
_offset
final JsonField<Long> _offset()
Returns the raw JSON value of offset.
Unlike offset, this method doesn't throw if the JSON field has an unexpected type.
-
_query
final JsonField<String> _query()
Returns the raw JSON value of query.
Unlike query, this method doesn't throw if the JSON field has an unexpected type.
-
_additionalProperties
final Map<String, JsonValue> _additionalProperties()
-
toBuilder
final V1DocketParams.Body.Builder toBuilder()
-
validate
final V1DocketParams.Body validate()
Validates that the types of all values in this object match their expected types recursively.
This method is not forwards compatible with new types from the API for existing fields.
-
builder
final static V1DocketParams.Body.Builder builder()
Returns a mutable builder for constructing an instance of Body.
The following fields are required:
.type()
-
-
-
-