All Implemented Interfaces:


public final class WorkflowCancelParams.Body.Builder

A builder for Body.

Nested Class Summary

Nested Classes
Modifier and Type	Class	Description

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 WorkflowCancelParams.Body.Builder`	`cancellationKey(String cancellationKey)`	An optional key that is used to reference a specific workflow trigger request when issuing a /send-notifications/canceling-workflows request.
`final WorkflowCancelParams.Body.Builder`	`cancellationKey(JsonField<String> cancellationKey)`	Sets Builder.cancellationKey to an arbitrary JSON value.
`final WorkflowCancelParams.Body.Builder`	`recipients(List<RecipientReference> recipients)`	A list of recipients to cancel the notification for.
`final WorkflowCancelParams.Body.Builder`	`recipients(Optional<List<RecipientReference>> recipients)`	Alias for calling Builder.recipients with `recipients.orElse(null)`.
`final WorkflowCancelParams.Body.Builder`	`recipients(JsonField<List<RecipientReference>> recipients)`	Sets Builder.recipients to an arbitrary JSON value.
`final WorkflowCancelParams.Body.Builder`	`addRecipient(RecipientReference recipient)`	Adds a single RecipientReference to recipients.
`final WorkflowCancelParams.Body.Builder`	`addRecipient(String user)`	Alias for calling addRecipient with `RecipientReference.ofUser(user)`.
`final WorkflowCancelParams.Body.Builder`	`addRecipient(RecipientReference.ObjectReference objectReference)`	Alias for calling addRecipient with `RecipientReference.ofObjectReference(objectReference)`.
`final WorkflowCancelParams.Body.Builder`	`additionalProperties(Map<String, JsonValue> additionalProperties)`
`final WorkflowCancelParams.Body.Builder`	`putAdditionalProperty(String key, JsonValue value)`
`final WorkflowCancelParams.Body.Builder`	`putAllAdditionalProperties(Map<String, JsonValue> additionalProperties)`
`final WorkflowCancelParams.Body.Builder`	`removeAdditionalProperty(String key)`
`final WorkflowCancelParams.Body.Builder`	`removeAllAdditionalProperties(Set<String> keys)`
`final WorkflowCancelParams.Body`	`build()`	Returns an immutable instance of Body.

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

- Constructor Detail
- Method Detail
  - cancellationKey
```
 final WorkflowCancelParams.Body.Builder cancellationKey(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.
  - cancellationKey
```
 final WorkflowCancelParams.Body.Builder cancellationKey(JsonField<String> cancellationKey)
```
    Sets Builder.cancellationKey to an arbitrary JSON value.
    You should usually call Builder.cancellationKey with a well-typed String value instead. This method is primarily for setting the field to an undocumented or not yet supported value.
  - recipients
```
 final WorkflowCancelParams.Body.Builder recipients(List<RecipientReference> recipients)
```
    A list of recipients to cancel the notification for. If omitted, cancels for all recipients associated with the cancellation key.
  - recipients
```
 final WorkflowCancelParams.Body.Builder recipients(Optional<List<RecipientReference>> recipients)
```
    Alias for calling Builder.recipients with recipients.orElse(null).
  - recipients
```
 final WorkflowCancelParams.Body.Builder recipients(JsonField<List<RecipientReference>> recipients)
```
    Sets Builder.recipients to an arbitrary JSON value.
    You should usually call Builder.recipients with a well-typed List<RecipientReference> value instead. This method is primarily for setting the field to an undocumented or not yet supported value.
  - addRecipient
```
 final WorkflowCancelParams.Body.Builder addRecipient(RecipientReference recipient)
```
    Adds a single RecipientReference to recipients.
  - addRecipient
```
 final WorkflowCancelParams.Body.Builder addRecipient(String user)
```
    Alias for calling addRecipient with RecipientReference.ofUser(user).
  - addRecipient
```
 final WorkflowCancelParams.Body.Builder addRecipient(RecipientReference.ObjectReference objectReference)
```
    Alias for calling addRecipient with RecipientReference.ofObjectReference(objectReference).
  - additionalProperties
```
 final WorkflowCancelParams.Body.Builder additionalProperties(Map<String, JsonValue> additionalProperties)
```
  - putAdditionalProperty
```
 final WorkflowCancelParams.Body.Builder putAdditionalProperty(String key, JsonValue value)
```
  - putAllAdditionalProperties
```
 final WorkflowCancelParams.Body.Builder putAllAdditionalProperties(Map<String, JsonValue> additionalProperties)
```
  - removeAdditionalProperty
```
 final WorkflowCancelParams.Body.Builder removeAdditionalProperty(String key)
```
  - removeAllAdditionalProperties
```
 final WorkflowCancelParams.Body.Builder removeAllAdditionalProperties(Set<String> keys)
```
  - build
```
 final WorkflowCancelParams.Body build()
```
    Returns an immutable instance of Body.
    Further updates to this Builder will not mutate the returned instance.
    The following fields are required:
    .cancellationKey()

Class WorkflowCancelParams.Body.Builder

Nested Class Summary

Field Summary

Constructor Summary

Enum Constant Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

Method Detail

cancellationKey

cancellationKey

recipients

recipients

recipients

addRecipient

addRecipient

addRecipient

additionalProperties

putAdditionalProperty

putAllAdditionalProperties

removeAdditionalProperty

removeAllAdditionalProperties

build