MessageCancelParams 3.8.0 API

All Implemented Interfaces:

com.courier.core.Params
```
public final class MessageCancelParams
 implements Params
                    
```
Cancel a message that is currently in the process of being delivered. A well-formatted API call to the cancel message API will return either 200 status code for a successful cancellation or 409 status code for an unsuccessful cancellation. Both cases will include the actual message record in the response body (see details below).

Nested Class Summary

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

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 Optional<String>`	`messageId()`
`final Map<String, JsonValue>`	`_additionalBodyProperties()`	Additional body properties to send with the request.
`final Headers`	`_additionalHeaders()`	Additional headers to send with the request.
`final QueryParams`	`_additionalQueryParams()`	Additional query param to send with the request.
`final MessageCancelParams.Builder`	`toBuilder()`
`final Optional<Map<String, JsonValue>>`	`_body()`
`final String`	`_pathParam(Integer index)`
`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.
`Boolean`	`equals(Object other)`
`Integer`	`hashCode()`
`String`	`toString()`
`final static MessageCancelParams`	`none()`
`final static MessageCancelParams.Builder`	`builder()`	Returns a mutable builder for constructing an instance of MessageCancelParams.

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

- Constructor Detail
- Method Detail
  - messageId
```
 final Optional<String> messageId()
```
  - _additionalBodyProperties
```
 final Map<String, JsonValue> _additionalBodyProperties()
```
    Additional body properties to send with the request.
  - _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 MessageCancelParams.Builder toBuilder()
```
  - _body
```
 final Optional<Map<String, JsonValue>> _body()
```
  - _pathParam
```
 final String _pathParam(Integer index)
```
  - _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.
  - equals
```
 Boolean equals(Object other)
```
  - hashCode
```
 Integer hashCode()
```
  - toString
```
 String toString()
```
  - none
```
 final static MessageCancelParams none()
```
  - builder
```
 final static MessageCancelParams.Builder builder()
```
    Returns a mutable builder for constructing an instance of MessageCancelParams.