Class V1SimilarParams
-
- All Implemented Interfaces:
-
dev.case.api.core.Params
public final class V1SimilarParams implements Params
Find cases and documents similar to a given legal source. Useful for finding citing cases, related precedents, or similar statutes.
-
-
Nested Class Summary
Nested Classes Modifier and Type Class Description public final classV1SimilarParams.BuilderA builder for V1SimilarParams.
public final classV1SimilarParams.Body
-
Method Summary
Modifier and Type Method Description final Stringurl()URL of a legal document to find similar sources for final Optional<String>jurisdiction()Optional jurisdiction ID to filter results final Optional<Long>numResults()Number of results 1-25 (default: 10) final Optional<LocalDate>startPublishedDate()Optional ISO date to find only newer documents (e.g. final JsonField<String>_url()Returns the raw JSON value of url. final JsonField<String>_jurisdiction()Returns the raw JSON value of jurisdiction. final JsonField<Long>_numResults()Returns the raw JSON value of numResults. final JsonField<LocalDate>_startPublishedDate()Returns the raw JSON value of startPublishedDate. 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 V1SimilarParams.BuildertoBuilder()final V1SimilarParams.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 V1SimilarParams.Builderbuilder()Returns a mutable builder for constructing an instance of V1SimilarParams. -
-
Method Detail
-
jurisdiction
final Optional<String> jurisdiction()
Optional jurisdiction ID to filter results
-
numResults
final Optional<Long> numResults()
Number of results 1-25 (default: 10)
-
startPublishedDate
final Optional<LocalDate> startPublishedDate()
Optional ISO date to find only newer documents (e.g., "2020-01-01")
-
_url
final JsonField<String> _url()
Returns the raw JSON value of url.
Unlike url, this method doesn't throw if the JSON field has an unexpected type.
-
_jurisdiction
final JsonField<String> _jurisdiction()
Returns the raw JSON value of jurisdiction.
Unlike jurisdiction, this method doesn't throw if the JSON field has an unexpected type.
-
_numResults
final JsonField<Long> _numResults()
Returns the raw JSON value of numResults.
Unlike numResults, this method doesn't throw if the JSON field has an unexpected type.
-
_startPublishedDate
final JsonField<LocalDate> _startPublishedDate()
Returns the raw JSON value of startPublishedDate.
Unlike startPublishedDate, 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 V1SimilarParams.Builder toBuilder()
-
_body
final V1SimilarParams.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 V1SimilarParams.Builder builder()
Returns a mutable builder for constructing an instance of V1SimilarParams.
The following fields are required:
.url()
-
-
-
-