Class WorkflowCancelParams.Body
-
- All Implemented Interfaces:
public final class WorkflowCancelParams.BodyWhen 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.
-
-
Nested Class Summary
Nested Classes Modifier and Type Class Description public final classWorkflowCancelParams.Body.BuilderA builder for Body.
-
Method Summary
Modifier and Type Method Description final StringcancellationKey()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>_additionalProperties()final WorkflowCancelParams.Body.BuildertoBuilder()final WorkflowCancelParams.Bodyvalidate()final BooleanisValid()Booleanequals(Object other)IntegerhashCode()StringtoString()final static WorkflowCancelParams.Body.Builderbuilder()Returns a mutable builder for constructing an instance of Body. -
-
Method Detail
-
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.
-
_additionalProperties
final Map<String, JsonValue> _additionalProperties()
-
toBuilder
final WorkflowCancelParams.Body.Builder toBuilder()
-
validate
final WorkflowCancelParams.Body validate()
-
builder
final static WorkflowCancelParams.Body.Builder builder()
Returns a mutable builder for constructing an instance of Body.
The following fields are required:
.cancellationKey()
-
-
-
-