Class MessageListParams.Builder
-
- All Implemented Interfaces:
public final class MessageListParams.Builder
A builder for MessageListParams.
-
-
Method Summary
-
-
Method Detail
-
threadId
final MessageListParams.Builder threadId(String threadId)
-
after
final MessageListParams.Builder after(String after)
A cursor for use in pagination.
after
is 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.
-
after
final MessageListParams.Builder after(Optional<String> after)
Alias for calling Builder.after with
after.orElse(null)
.
-
before
final MessageListParams.Builder before(String before)
A cursor for use in pagination.
before
is 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.
-
before
final MessageListParams.Builder before(Optional<String> before)
Alias for calling Builder.before with
before.orElse(null)
.
-
limit
final MessageListParams.Builder limit(Long limit)
A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 20.
-
limit
final MessageListParams.Builder limit(Long limit)
Alias for Builder.limit.
This unboxed primitive overload exists for backwards compatibility.
-
limit
final MessageListParams.Builder limit(Optional<Long> limit)
Alias for calling Builder.limit with
limit.orElse(null)
.
-
order
final MessageListParams.Builder order(MessageListParams.Order order)
Sort order by the
created_at
timestamp of the objects.asc
for ascending order anddesc
for descending order.
-
order
final MessageListParams.Builder order(Optional<MessageListParams.Order> order)
Alias for calling Builder.order with
order.orElse(null)
.
-
runId
final MessageListParams.Builder runId(String runId)
Filter messages by the run ID that generated them.
-
runId
final MessageListParams.Builder runId(Optional<String> runId)
Alias for calling Builder.runId with
runId.orElse(null)
.
-
additionalHeaders
final MessageListParams.Builder additionalHeaders(Headers additionalHeaders)
-
additionalHeaders
final MessageListParams.Builder additionalHeaders(Map<String, Iterable<String>> additionalHeaders)
-
putAdditionalHeader
final MessageListParams.Builder putAdditionalHeader(String name, String value)
-
putAdditionalHeaders
final MessageListParams.Builder putAdditionalHeaders(String name, Iterable<String> values)
-
putAllAdditionalHeaders
final MessageListParams.Builder putAllAdditionalHeaders(Headers additionalHeaders)
-
putAllAdditionalHeaders
final MessageListParams.Builder putAllAdditionalHeaders(Map<String, Iterable<String>> additionalHeaders)
-
replaceAdditionalHeaders
final MessageListParams.Builder replaceAdditionalHeaders(String name, String value)
-
replaceAdditionalHeaders
final MessageListParams.Builder replaceAdditionalHeaders(String name, Iterable<String> values)
-
replaceAllAdditionalHeaders
final MessageListParams.Builder replaceAllAdditionalHeaders(Headers additionalHeaders)
-
replaceAllAdditionalHeaders
final MessageListParams.Builder replaceAllAdditionalHeaders(Map<String, Iterable<String>> additionalHeaders)
-
removeAdditionalHeaders
final MessageListParams.Builder removeAdditionalHeaders(String name)
-
removeAllAdditionalHeaders
final MessageListParams.Builder removeAllAdditionalHeaders(Set<String> names)
-
additionalQueryParams
final MessageListParams.Builder additionalQueryParams(QueryParams additionalQueryParams)
-
additionalQueryParams
final MessageListParams.Builder additionalQueryParams(Map<String, Iterable<String>> additionalQueryParams)
-
putAdditionalQueryParam
final MessageListParams.Builder putAdditionalQueryParam(String key, String value)
-
putAdditionalQueryParams
final MessageListParams.Builder putAdditionalQueryParams(String key, Iterable<String> values)
-
putAllAdditionalQueryParams
final MessageListParams.Builder putAllAdditionalQueryParams(QueryParams additionalQueryParams)
-
putAllAdditionalQueryParams
final MessageListParams.Builder putAllAdditionalQueryParams(Map<String, Iterable<String>> additionalQueryParams)
-
replaceAdditionalQueryParams
final MessageListParams.Builder replaceAdditionalQueryParams(String key, String value)
-
replaceAdditionalQueryParams
final MessageListParams.Builder replaceAdditionalQueryParams(String key, Iterable<String> values)
-
replaceAllAdditionalQueryParams
final MessageListParams.Builder replaceAllAdditionalQueryParams(QueryParams additionalQueryParams)
-
replaceAllAdditionalQueryParams
final MessageListParams.Builder replaceAllAdditionalQueryParams(Map<String, Iterable<String>> additionalQueryParams)
-
removeAdditionalQueryParams
final MessageListParams.Builder removeAdditionalQueryParams(String key)
-
removeAllAdditionalQueryParams
final MessageListParams.Builder removeAllAdditionalQueryParams(Set<String> keys)
-
build
final MessageListParams build()
Returns an immutable instance of MessageListParams.
Further updates to this Builder will not mutate the returned instance.
The following fields are required:
.threadId()
-
-
-
-