BatchRetrieveParams 0.8.0 API

All Implemented Interfaces:

com.anthropic.core.Params
```
public final class BatchRetrieveParams
 implements Params
                    
```
This endpoint is idempotent and can be used to poll for Message Batch completion. To access the results of a Message Batch, make a request to the results_url field in the response.
Learn more about the Message Batches API in our /en/docs/build-with-claude/batch-processing

Nested Class Summary

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

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`	`messageBatchId()`	ID of the Message Batch.
`final Headers`	`_additionalHeaders()`
`final QueryParams`	`_additionalQueryParams()`
`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.
`final String`	`getPathParam(Integer index)`
`final BatchRetrieveParams.Builder`	`toBuilder()`
`Boolean`	`equals(Object other)`
`Integer`	`hashCode()`
`String`	`toString()`
`final static BatchRetrieveParams.Builder`	`builder()`	Returns a mutable builder for constructing an instance of BatchRetrieveParams.

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

- Constructor Detail
- Method Detail
  - messageBatchId
```
 final String messageBatchId()
```
    ID of the Message Batch.
  - _additionalHeaders
```
 final Headers _additionalHeaders()
```
  - _additionalQueryParams
```
 final QueryParams _additionalQueryParams()
```
  - _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.
  - getPathParam
```
 final String getPathParam(Integer index)
```
  - toBuilder
```
 final BatchRetrieveParams.Builder toBuilder()
```
  - equals
```
 Boolean equals(Object other)
```
  - hashCode
```
 Integer hashCode()
```
  - toString
```
 String toString()
```
  - builder
```
 final static BatchRetrieveParams.Builder builder()
```
    Returns a mutable builder for constructing an instance of BatchRetrieveParams.
    The following fields are required:
    .messageBatchId()