Class V1DocketParams
-
- All Implemented Interfaces:
-
dev.case.api.core.Params
public final class V1DocketParams implements Params
Search federal court dockets or retrieve a specific docket with optional filing entries via CourtListener RECAP data.
-
-
Nested Class Summary
Nested Classes Modifier and Type Class Description public final classV1DocketParams.BuilderA builder for V1DocketParams.
public final classV1DocketParams.Bodypublic final classV1DocketParams.TypeSearch dockets or look up a docket by ID
-
Method Summary
Modifier and Type Method Description final V1DocketParams.Typetype()Search dockets or look up a docket by ID final Optional<String>court()Optional CourtListener court slug (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()CourtListener 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()Reserved for future PACER live fetch support. 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<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>_additionalBodyProperties()final Headers_additionalHeaders()Additional headers to send with the request. final QueryParams_additionalQueryParams()Additional query param to send with the request. final V1DocketParams.BuildertoBuilder()final V1DocketParams.Body_body()Headers_headers()The full set of headers in the parameters, including both fixed and additional headers. QueryParams_queryParams()The full set of query params in the parameters, including both fixed and additional query params. Booleanequals(Object other)IntegerhashCode()StringtoString()final static V1DocketParams.Builderbuilder()Returns a mutable builder for constructing an instance of V1DocketParams. -
-
Method Detail
-
type
final V1DocketParams.Type type()
Search dockets or look up a docket by ID
-
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
-
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()
Reserved for future PACER live fetch support. Setting true currently returns 400.
-
_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.
-
_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.
-
_additionalBodyProperties
final Map<String, JsonValue> _additionalBodyProperties()
-
_additionalHeaders
final Headers _additionalHeaders()
Additional headers to send with the request.
-
_additionalQueryParams
final QueryParams _additionalQueryParams()
Additional query param to send with the request.
-
toBuilder
final V1DocketParams.Builder toBuilder()
-
_body
final V1DocketParams.Body _body()
-
_headers
Headers _headers()
The full set of headers in the parameters, including both fixed and additional headers.
-
_queryParams
QueryParams _queryParams()
The full set of query params in the parameters, including both fixed and additional query params.
-
builder
final static V1DocketParams.Builder builder()
Returns a mutable builder for constructing an instance of V1DocketParams.
The following fields are required:
.type()
-
-
-
-