ObjectGetPagesParams

All Implemented Interfaces:

dev.case.api.core.Params
```
public final class ObjectGetPagesParams
 implements Params
                    
```
Retrieves the raw text of a processed vault object split by page. The object must have completed ingestion before pages can be retrieved — for PDFs this requires the OCR pipeline to have finished writing the per-page sidecar, so freshly uploaded PDFs return 400 with the current ingestionStatus until processing completes. For PDFs this returns the per-page OCR text. For plain text files (txt, md, source code, court reporter transcripts) the text is split using right-aligned page-number markers when present (preserving the original document numbering, including continuations like Volume 2 starting at page 234), falling back to form-feed (\f) page-break characters, and finally a single page if neither signal is present. Use the optional start and end query parameters to fetch a specific inclusive page range. Pages with no text are omitted.

Nested Class Summary

Nested Classes
Modifier and Type	Class	Description
`public final class`	`ObjectGetPagesParams.Builder`	A builder for ObjectGetPagesParams.

Field Summary

Fields
Modifier and Type	Field	Description

Constructor Summary

Constructors
Constructor	Description

Enum Constant Summary

Enum Constants
Enum Constant	Description

Method Summary

Modifier and Type	Method	Description
`final String`	`id()`
`final Optional<String>`	`objectId()`
`final Optional<Long>`	`end()`	Last page to return (inclusive, 1-indexed).
`final Optional<Long>`	`start()`	First page to return (inclusive, 1-indexed).
`final Headers`	`_additionalHeaders()`	Additional headers to send with the request.
`final QueryParams`	`_additionalQueryParams()`	Additional query param to send with the request.
`final ObjectGetPagesParams.Builder`	`toBuilder()`
`final String`	`_pathParam(Integer index)`
`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.
`Boolean`	`equals(Object other)`
`Integer`	`hashCode()`
`String`	`toString()`
`final static ObjectGetPagesParams.Builder`	`builder()`	Returns a mutable builder for constructing an instance of ObjectGetPagesParams.

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Constructor Detail
- Method Detail
  - id
```
 final String id()
```
  - objectId
```
 final Optional<String> objectId()
```
  - end
```
 final Optional<Long> end()
```
    Last page to return (inclusive, 1-indexed). If omitted, returns through the last page with text.
  - start
```
 final Optional<Long> start()
```
    First page to return (inclusive, 1-indexed). If omitted, starts at the first page with text.
  - _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 ObjectGetPagesParams.Builder toBuilder()
```
  - _pathParam
```
 final String _pathParam(Integer index)
```
  - _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.
  - equals
```
 Boolean equals(Object other)
```
  - hashCode
```
 Integer hashCode()
```
  - toString
```
 String toString()
```
  - builder
```
 final static ObjectGetPagesParams.Builder builder()
```
    Returns a mutable builder for constructing an instance of ObjectGetPagesParams.
    The following fields are required:
    .id()