Class MessageListParams
-
- All Implemented Interfaces:
-
com.openai.core.Params
public final class MessageListParams implements Params
Returns a list of messages for a given thread.
-
-
Nested Class Summary
Nested Classes Modifier and Type Class Description public final classMessageListParams.BuilderA builder for MessageListParams.
public final classMessageListParams.OrderSort order by the
created_attimestamp of the objects.ascfor ascending order anddescfor descending order.
-
Method Summary
Modifier and Type Method Description final StringthreadId()final Optional<String>after()A cursor for use in pagination. final Optional<String>before()A cursor for use in pagination. final Optional<Long>limit()A limit on the number of objects to be returned. final Optional<MessageListParams.Order>order()Sort order by the created_attimestamp of the objects.final Optional<String>runId()Filter messages by the run ID that generated them. 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 StringgetPathParam(Integer index)final MessageListParams.BuildertoBuilder()Booleanequals(Object other)IntegerhashCode()StringtoString()final static MessageListParams.Builderbuilder()Returns a mutable builder for constructing an instance of MessageListParams. -
-
Method Detail
-
after
final Optional<String> after()
A cursor for use in pagination.
afteris an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, ending with obj_foo, your subsequent call can include after=obj_foo in order to fetch the next page of the list.
-
before
final Optional<String> before()
A cursor for use in pagination.
beforeis an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, starting with obj_foo, your subsequent call can include before=obj_foo in order to fetch the previous page of the list.
-
limit
final Optional<Long> limit()
A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 20.
-
order
final Optional<MessageListParams.Order> order()
Sort order by the
created_attimestamp of the objects.ascfor ascending order anddescfor descending order.
-
_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 MessageListParams.Builder toBuilder()
-
builder
final static MessageListParams.Builder builder()
Returns a mutable builder for constructing an instance of MessageListParams.
The following fields are required:
.threadId()
-
-
-
-