Class ObjectListMessagesParams.Builder
-
- All Implemented Interfaces:
public final class ObjectListMessagesParams.BuilderA builder for ObjectListMessagesParams.
-
-
Method Summary
-
-
Method Detail
-
collection
final ObjectListMessagesParams.Builder collection(String collection)
-
collection
final ObjectListMessagesParams.Builder collection(Optional<String> collection)
Alias for calling Builder.collection with
collection.orElse(null).
-
id
final ObjectListMessagesParams.Builder id(String id)
-
id
final ObjectListMessagesParams.Builder id(Optional<String> id)
Alias for calling Builder.id with
id.orElse(null).
-
after
final ObjectListMessagesParams.Builder after(String after)
The cursor to fetch entries after.
-
after
final ObjectListMessagesParams.Builder after(Optional<String> after)
Alias for calling Builder.after with
after.orElse(null).
-
before
final ObjectListMessagesParams.Builder before(String before)
The cursor to fetch entries before.
-
before
final ObjectListMessagesParams.Builder before(Optional<String> before)
Alias for calling Builder.before with
before.orElse(null).
-
channelId
final ObjectListMessagesParams.Builder channelId(String channelId)
Limits the results to items with the corresponding channel ID.
-
channelId
final ObjectListMessagesParams.Builder channelId(Optional<String> channelId)
Alias for calling Builder.channelId with
channelId.orElse(null).
-
engagementStatus
final ObjectListMessagesParams.Builder engagementStatus(List<ObjectListMessagesParams.EngagementStatus> engagementStatus)
Limits the results to messages with the given engagement status.
-
engagementStatus
final ObjectListMessagesParams.Builder engagementStatus(Optional<List<ObjectListMessagesParams.EngagementStatus>> engagementStatus)
Alias for calling Builder.engagementStatus with
engagementStatus.orElse(null).
-
addEngagementStatus
final ObjectListMessagesParams.Builder addEngagementStatus(ObjectListMessagesParams.EngagementStatus engagementStatus)
Adds a single EngagementStatus to Builder.engagementStatus.
-
insertedAt
final ObjectListMessagesParams.Builder insertedAt(ObjectListMessagesParams.InsertedAt insertedAt)
-
insertedAt
final ObjectListMessagesParams.Builder insertedAt(Optional<ObjectListMessagesParams.InsertedAt> insertedAt)
Alias for calling Builder.insertedAt with
insertedAt.orElse(null).
-
messageIds
final ObjectListMessagesParams.Builder messageIds(List<String> messageIds)
Limits the results to only the message IDs given (max 50). Note: when using this option, the results will be subject to any other filters applied to the query.
-
messageIds
final ObjectListMessagesParams.Builder messageIds(Optional<List<String>> messageIds)
Alias for calling Builder.messageIds with
messageIds.orElse(null).
-
addMessageId
final ObjectListMessagesParams.Builder addMessageId(String messageId)
Adds a single String to messageIds.
-
pageSize
final ObjectListMessagesParams.Builder pageSize(Long pageSize)
The number of items per page.
-
pageSize
final ObjectListMessagesParams.Builder pageSize(Long pageSize)
Alias for Builder.pageSize.
This unboxed primitive overload exists for backwards compatibility.
-
pageSize
final ObjectListMessagesParams.Builder pageSize(Optional<Long> pageSize)
Alias for calling Builder.pageSize with
pageSize.orElse(null).
-
source
final ObjectListMessagesParams.Builder source(String source)
Limits the results to messages triggered by the given workflow key.
-
source
final ObjectListMessagesParams.Builder source(Optional<String> source)
Alias for calling Builder.source with
source.orElse(null).
-
status
final ObjectListMessagesParams.Builder status(List<ObjectListMessagesParams.Status> status)
Limits the results to messages with the given delivery status.
-
status
final ObjectListMessagesParams.Builder status(Optional<List<ObjectListMessagesParams.Status>> status)
Alias for calling Builder.status with
status.orElse(null).
-
addStatus
final ObjectListMessagesParams.Builder addStatus(ObjectListMessagesParams.Status status)
Adds a single Status to Builder.status.
-
tenant
final ObjectListMessagesParams.Builder tenant(String tenant)
Limits the results to items with the corresponding tenant.
-
tenant
final ObjectListMessagesParams.Builder tenant(Optional<String> tenant)
Alias for calling Builder.tenant with
tenant.orElse(null).
-
triggerData
final ObjectListMessagesParams.Builder triggerData(String triggerData)
Limits the results to only messages that were generated with the given data. See /api-reference/overview/trigger-data-filtering for more information.
-
triggerData
final ObjectListMessagesParams.Builder triggerData(Optional<String> triggerData)
Alias for calling Builder.triggerData with
triggerData.orElse(null).
-
workflowCategories
final ObjectListMessagesParams.Builder workflowCategories(List<String> workflowCategories)
Limits the results to messages related to any of the provided categories.
-
workflowCategories
final ObjectListMessagesParams.Builder workflowCategories(Optional<List<String>> workflowCategories)
Alias for calling Builder.workflowCategories with
workflowCategories.orElse(null).
-
addWorkflowCategory
final ObjectListMessagesParams.Builder addWorkflowCategory(String workflowCategory)
Adds a single String to workflowCategories.
-
workflowRecipientRunId
final ObjectListMessagesParams.Builder workflowRecipientRunId(String workflowRecipientRunId)
Limits the results to messages for a specific recipient's workflow run.
-
workflowRecipientRunId
final ObjectListMessagesParams.Builder workflowRecipientRunId(Optional<String> workflowRecipientRunId)
Alias for calling Builder.workflowRecipientRunId with
workflowRecipientRunId.orElse(null).
-
workflowRunId
final ObjectListMessagesParams.Builder workflowRunId(String workflowRunId)
Limits the results to messages associated with the top-level workflow run ID returned by the workflow trigger request.
-
workflowRunId
final ObjectListMessagesParams.Builder workflowRunId(Optional<String> workflowRunId)
Alias for calling Builder.workflowRunId with
workflowRunId.orElse(null).
-
additionalHeaders
final ObjectListMessagesParams.Builder additionalHeaders(Headers additionalHeaders)
-
additionalHeaders
final ObjectListMessagesParams.Builder additionalHeaders(Map<String, Iterable<String>> additionalHeaders)
-
putAdditionalHeader
final ObjectListMessagesParams.Builder putAdditionalHeader(String name, String value)
-
putAdditionalHeaders
final ObjectListMessagesParams.Builder putAdditionalHeaders(String name, Iterable<String> values)
-
putAllAdditionalHeaders
final ObjectListMessagesParams.Builder putAllAdditionalHeaders(Headers additionalHeaders)
-
putAllAdditionalHeaders
final ObjectListMessagesParams.Builder putAllAdditionalHeaders(Map<String, Iterable<String>> additionalHeaders)
-
replaceAdditionalHeaders
final ObjectListMessagesParams.Builder replaceAdditionalHeaders(String name, String value)
-
replaceAdditionalHeaders
final ObjectListMessagesParams.Builder replaceAdditionalHeaders(String name, Iterable<String> values)
-
replaceAllAdditionalHeaders
final ObjectListMessagesParams.Builder replaceAllAdditionalHeaders(Headers additionalHeaders)
-
replaceAllAdditionalHeaders
final ObjectListMessagesParams.Builder replaceAllAdditionalHeaders(Map<String, Iterable<String>> additionalHeaders)
-
removeAdditionalHeaders
final ObjectListMessagesParams.Builder removeAdditionalHeaders(String name)
-
removeAllAdditionalHeaders
final ObjectListMessagesParams.Builder removeAllAdditionalHeaders(Set<String> names)
-
additionalQueryParams
final ObjectListMessagesParams.Builder additionalQueryParams(QueryParams additionalQueryParams)
-
additionalQueryParams
final ObjectListMessagesParams.Builder additionalQueryParams(Map<String, Iterable<String>> additionalQueryParams)
-
putAdditionalQueryParam
final ObjectListMessagesParams.Builder putAdditionalQueryParam(String key, String value)
-
putAdditionalQueryParams
final ObjectListMessagesParams.Builder putAdditionalQueryParams(String key, Iterable<String> values)
-
putAllAdditionalQueryParams
final ObjectListMessagesParams.Builder putAllAdditionalQueryParams(QueryParams additionalQueryParams)
-
putAllAdditionalQueryParams
final ObjectListMessagesParams.Builder putAllAdditionalQueryParams(Map<String, Iterable<String>> additionalQueryParams)
-
replaceAdditionalQueryParams
final ObjectListMessagesParams.Builder replaceAdditionalQueryParams(String key, String value)
-
replaceAdditionalQueryParams
final ObjectListMessagesParams.Builder replaceAdditionalQueryParams(String key, Iterable<String> values)
-
replaceAllAdditionalQueryParams
final ObjectListMessagesParams.Builder replaceAllAdditionalQueryParams(QueryParams additionalQueryParams)
-
replaceAllAdditionalQueryParams
final ObjectListMessagesParams.Builder replaceAllAdditionalQueryParams(Map<String, Iterable<String>> additionalQueryParams)
-
removeAdditionalQueryParams
final ObjectListMessagesParams.Builder removeAdditionalQueryParams(String key)
-
removeAllAdditionalQueryParams
final ObjectListMessagesParams.Builder removeAllAdditionalQueryParams(Set<String> keys)
-
build
final ObjectListMessagesParams build()
Returns an immutable instance of ObjectListMessagesParams.
Further updates to this Builder will not mutate the returned instance.
-
-
-
-