All Implemented Interfaces:

app.knock.api.core.Params
```
public final class WorkflowCancelParams
 implements Params
                    
```
When invoked for a workflow using a specific workflow key and cancellation key, will cancel any queued workflow runs associated with that key/cancellation key pair. Can optionally be provided one or more recipients to scope the request to.

Nested Class Summary

Nested Classes
Modifier and Type	Class	Description
`public final class`	`WorkflowCancelParams.Builder`	A builder for WorkflowCancelParams.
`public final class`	`WorkflowCancelParams.Body`	When invoked using a specific workflow key and cancellation key, will cancel any queued workflow runs associated with that key/cancellation key pair. Can optionally provide one or more recipients to scope the request to.

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>`	`key()`
`final String`	`cancellationKey()`	An optional key that is used to reference a specific workflow trigger request when issuing a /send-notifications/canceling-workflows request.
`final Optional<List<RecipientReference>>`	`recipients()`	A list of recipients to cancel the notification for.
`final JsonField<String>`	`_cancellationKey()`	Returns the raw JSON value of cancellationKey.
`final JsonField<List<RecipientReference>>`	`_recipients()`	Returns the raw JSON value of recipients.
`final Map<String, JsonValue>`	`_additionalBodyProperties()`
`final Headers`	`_additionalHeaders()`
`final QueryParams`	`_additionalQueryParams()`
`final WorkflowCancelParams.Builder`	`toBuilder()`
`final WorkflowCancelParams.Body`	`_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 WorkflowCancelParams.Builder`	`builder()`	Returns a mutable builder for constructing an instance of WorkflowCancelParams.

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

- Constructor Detail
- Method Detail
  - key
```
 final Optional<String> key()
```
  - cancellationKey
```
 final String cancellationKey()
```
    An optional key that is used to reference a specific workflow trigger request when issuing a /send-notifications/canceling-workflows request. Must be provided while triggering a workflow in order to enable subsequent cancellation. Should be unique across trigger requests to avoid unintentional cancellations.
  - recipients
```
 final Optional<List<RecipientReference>> recipients()
```
    A list of recipients to cancel the notification for. If omitted, cancels for all recipients associated with the cancellation key.
  - _cancellationKey
```
 final JsonField<String> _cancellationKey()
```
    Returns the raw JSON value of cancellationKey.
    Unlike cancellationKey, this method doesn't throw if the JSON field has an unexpected type.
  - _recipients
```
 final JsonField<List<RecipientReference>> _recipients()
```
    Returns the raw JSON value of recipients.
    Unlike recipients, this method doesn't throw if the JSON field has an unexpected type.
  - _additionalBodyProperties
```
 final Map<String, JsonValue> _additionalBodyProperties()
```
  - _additionalHeaders
```
 final Headers _additionalHeaders()
```
  - _additionalQueryParams
```
 final QueryParams _additionalQueryParams()
```
  - toBuilder
```
 final WorkflowCancelParams.Builder toBuilder()
```
  - _body
```
 final WorkflowCancelParams.Body _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()
```
  - builder
```
 final static WorkflowCancelParams.Builder builder()
```
    Returns a mutable builder for constructing an instance of WorkflowCancelParams.
    The following fields are required:
    .cancellationKey()

Class WorkflowCancelParams

Nested Class Summary

Field Summary

Constructor Summary

Enum Constant Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

Method Detail

key

cancellationKey

recipients

_cancellationKey

_recipients

_additionalBodyProperties

_additionalHeaders

_additionalQueryParams

toBuilder

_body

_pathParam

_headers

_queryParams

equals

hashCode

toString

builder