Class V1PatentSearchParams
-
- All Implemented Interfaces:
-
dev.case.api.core.Params
public final class V1PatentSearchParams implements Params
Search the USPTO Open Data Portal for US patent applications and granted patents. Supports free-text queries, field-specific search, filters by assignee/inventor/status/type, date ranges, and pagination. Covers applications filed on or after January 1, 2001. Data is refreshed daily.
-
-
Nested Class Summary
Nested Classes Modifier and Type Class Description public final classV1PatentSearchParams.BuilderA builder for V1PatentSearchParams.
public final classV1PatentSearchParams.Bodypublic final classV1PatentSearchParams.ApplicationTypeFilter by application type
public final classV1PatentSearchParams.SortByField to sort results by
public final classV1PatentSearchParams.SortOrderSort order (default desc, newest first)
-
Method Summary
Modifier and Type Method Description final Stringquery()Free-text search across all patent fields, or field-specific query (e.g. final Optional<String>applicationStatus()Filter by application status (e.g. final Optional<V1PatentSearchParams.ApplicationType>applicationType()Filter by application type final Optional<String>assignee()Filter by assignee/owner name (e.g. final Optional<LocalDate>filingDateFrom()Start of filing date range (YYYY-MM-DD) final Optional<LocalDate>filingDateTo()End of filing date range (YYYY-MM-DD) final Optional<LocalDate>grantDateFrom()Start of grant date range (YYYY-MM-DD) final Optional<LocalDate>grantDateTo()End of grant date range (YYYY-MM-DD) final Optional<String>inventor()Filter by inventor name final Optional<Long>limit()Number of results to return (default 25, max 100) final Optional<Long>offset()Starting position for pagination final Optional<V1PatentSearchParams.SortBy>sortBy()Field to sort results by final Optional<V1PatentSearchParams.SortOrder>sortOrder()Sort order (default desc, newest first) final JsonField<String>_query()Returns the raw JSON value of query. final JsonField<String>_applicationStatus()Returns the raw JSON value of applicationStatus. final JsonField<V1PatentSearchParams.ApplicationType>_applicationType()Returns the raw JSON value of applicationType. final JsonField<String>_assignee()Returns the raw JSON value of assignee. final JsonField<LocalDate>_filingDateFrom()Returns the raw JSON value of filingDateFrom. final JsonField<LocalDate>_filingDateTo()Returns the raw JSON value of filingDateTo. final JsonField<LocalDate>_grantDateFrom()Returns the raw JSON value of grantDateFrom. final JsonField<LocalDate>_grantDateTo()Returns the raw JSON value of grantDateTo. final JsonField<String>_inventor()Returns the raw JSON value of inventor. final JsonField<Long>_limit()Returns the raw JSON value of limit. final JsonField<Long>_offset()Returns the raw JSON value of offset. final JsonField<V1PatentSearchParams.SortBy>_sortBy()Returns the raw JSON value of sortBy. final JsonField<V1PatentSearchParams.SortOrder>_sortOrder()Returns the raw JSON value of sortOrder. 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 V1PatentSearchParams.BuildertoBuilder()final V1PatentSearchParams.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 V1PatentSearchParams.Builderbuilder()Returns a mutable builder for constructing an instance of V1PatentSearchParams. -
-
Method Detail
-
query
final String query()
Free-text search across all patent fields, or field-specific query (e.g. "applicationMetaData.patentNumber:11234567"). Supports AND, OR, NOT operators.
-
applicationStatus
final Optional<String> applicationStatus()
Filter by application status (e.g. "Patented Case", "Abandoned", "Pending")
-
applicationType
final Optional<V1PatentSearchParams.ApplicationType> applicationType()
Filter by application type
-
filingDateFrom
final Optional<LocalDate> filingDateFrom()
Start of filing date range (YYYY-MM-DD)
-
filingDateTo
final Optional<LocalDate> filingDateTo()
End of filing date range (YYYY-MM-DD)
-
grantDateFrom
final Optional<LocalDate> grantDateFrom()
Start of grant date range (YYYY-MM-DD)
-
grantDateTo
final Optional<LocalDate> grantDateTo()
End of grant date range (YYYY-MM-DD)
-
sortBy
final Optional<V1PatentSearchParams.SortBy> sortBy()
Field to sort results by
-
sortOrder
final Optional<V1PatentSearchParams.SortOrder> sortOrder()
Sort order (default desc, newest first)
-
_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.
-
_applicationStatus
final JsonField<String> _applicationStatus()
Returns the raw JSON value of applicationStatus.
Unlike applicationStatus, this method doesn't throw if the JSON field has an unexpected type.
-
_applicationType
final JsonField<V1PatentSearchParams.ApplicationType> _applicationType()
Returns the raw JSON value of applicationType.
Unlike applicationType, this method doesn't throw if the JSON field has an unexpected type.
-
_assignee
final JsonField<String> _assignee()
Returns the raw JSON value of assignee.
Unlike assignee, this method doesn't throw if the JSON field has an unexpected type.
-
_filingDateFrom
final JsonField<LocalDate> _filingDateFrom()
Returns the raw JSON value of filingDateFrom.
Unlike filingDateFrom, this method doesn't throw if the JSON field has an unexpected type.
-
_filingDateTo
final JsonField<LocalDate> _filingDateTo()
Returns the raw JSON value of filingDateTo.
Unlike filingDateTo, this method doesn't throw if the JSON field has an unexpected type.
-
_grantDateFrom
final JsonField<LocalDate> _grantDateFrom()
Returns the raw JSON value of grantDateFrom.
Unlike grantDateFrom, this method doesn't throw if the JSON field has an unexpected type.
-
_grantDateTo
final JsonField<LocalDate> _grantDateTo()
Returns the raw JSON value of grantDateTo.
Unlike grantDateTo, this method doesn't throw if the JSON field has an unexpected type.
-
_inventor
final JsonField<String> _inventor()
Returns the raw JSON value of inventor.
Unlike inventor, 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.
-
_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.
-
_sortBy
final JsonField<V1PatentSearchParams.SortBy> _sortBy()
Returns the raw JSON value of sortBy.
Unlike sortBy, this method doesn't throw if the JSON field has an unexpected type.
-
_sortOrder
final JsonField<V1PatentSearchParams.SortOrder> _sortOrder()
Returns the raw JSON value of sortOrder.
Unlike sortOrder, 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 V1PatentSearchParams.Builder toBuilder()
-
_body
final V1PatentSearchParams.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 V1PatentSearchParams.Builder builder()
Returns a mutable builder for constructing an instance of V1PatentSearchParams.
The following fields are required:
.query()
-
-
-
-