Class BulkCreateJobParams
-
- All Implemented Interfaces:
-
com.courier.core.Params
public final class BulkCreateJobParams implements Params
Creates a new bulk job for sending messages to multiple recipients.
Required:
message.event(event ID or notification ID)Optional (V2 format):
message.template(notification ID) ormessage.content(Elemental content) can be provided to override the notification associated with the event.
-
-
Nested Class Summary
Nested Classes Modifier and Type Class Description public final classBulkCreateJobParams.BuilderA builder for BulkCreateJobParams.
public final classBulkCreateJobParams.Body
-
Method Summary
Modifier and Type Method Description final InboundBulkMessagemessage()Bulk message definition. final JsonField<InboundBulkMessage>_message()Returns the raw JSON value of message. final Map<String, JsonValue>_additionalBodyProperties()final Headers_additionalHeaders()Additional headers to send with the request. final QueryParams_additionalQueryParams()Additional query param to send with the request. final BulkCreateJobParams.BuildertoBuilder()final BulkCreateJobParams.Body_body()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. Booleanequals(Object other)IntegerhashCode()StringtoString()final static BulkCreateJobParams.Builderbuilder()Returns a mutable builder for constructing an instance of BulkCreateJobParams. -
-
Method Detail
-
message
final InboundBulkMessage message()
Bulk message definition. Supports two formats:
V1 format: Requires
eventfield (event ID or notification ID)V2 format: Optionally use
template(notification ID) orcontent(Elemental content) in addition toevent
-
_message
final JsonField<InboundBulkMessage> _message()
Returns the raw JSON value of message.
Unlike message, this method doesn't throw if the JSON field has an unexpected type.
-
_additionalBodyProperties
final Map<String, JsonValue> _additionalBodyProperties()
-
_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 BulkCreateJobParams.Builder toBuilder()
-
_body
final BulkCreateJobParams.Body _body()
-
_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.
-
builder
final static BulkCreateJobParams.Builder builder()
Returns a mutable builder for constructing an instance of BulkCreateJobParams.
The following fields are required:
.message()
-
-
-
-