Constructor Detail

Method Detail

• key

   final WorkflowCancelParams.Builder key(String key)

• key

   final WorkflowCancelParams.Builder key(Optional<String> key)

  Alias for calling Builder.key with key.orElse(null).

• body

   final WorkflowCancelParams.Builder body(WorkflowCancelParams.Body body)

  Sets the entire request body.

  This is generally only useful if you are already constructing the body separately. Otherwise, it's more convenient to use the top-level setters instead:

  • cancellationKey

  • recipients

• cancellationKey

   final WorkflowCancelParams.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.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.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.Builder recipients(Optional<List<RecipientReference>> recipients)

  Alias for calling Builder.recipients with recipients.orElse(null).

• recipients

   final WorkflowCancelParams.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.Builder addRecipient(RecipientReference recipient)

  Adds a single RecipientReference to recipients.

• addRecipient

   final WorkflowCancelParams.Builder addRecipient(String user)

  Alias for calling addRecipient with RecipientReference.ofUser(user).

• addRecipient

   final WorkflowCancelParams.Builder addRecipient(RecipientReference.ObjectReference objectReference)

  Alias for calling addRecipient with RecipientReference.ofObjectReference(objectReference).

• additionalBodyProperties

   final WorkflowCancelParams.Builder additionalBodyProperties(Map<String, JsonValue> additionalBodyProperties)

• putAdditionalBodyProperty

   final WorkflowCancelParams.Builder putAdditionalBodyProperty(String key, JsonValue value)

• putAllAdditionalBodyProperties

   final WorkflowCancelParams.Builder putAllAdditionalBodyProperties(Map<String, JsonValue> additionalBodyProperties)

• removeAdditionalBodyProperty

   final WorkflowCancelParams.Builder removeAdditionalBodyProperty(String key)

• removeAllAdditionalBodyProperties

   final WorkflowCancelParams.Builder removeAllAdditionalBodyProperties(Set<String> keys)

• additionalHeaders

   final WorkflowCancelParams.Builder additionalHeaders(Headers additionalHeaders)

• additionalHeaders

   final WorkflowCancelParams.Builder additionalHeaders(Map<String, Iterable<String>> additionalHeaders)

• putAdditionalHeader

   final WorkflowCancelParams.Builder putAdditionalHeader(String name, String value)

• putAdditionalHeaders

   final WorkflowCancelParams.Builder putAdditionalHeaders(String name, Iterable<String> values)

• putAllAdditionalHeaders

   final WorkflowCancelParams.Builder putAllAdditionalHeaders(Headers additionalHeaders)

• putAllAdditionalHeaders

   final WorkflowCancelParams.Builder putAllAdditionalHeaders(Map<String, Iterable<String>> additionalHeaders)

• replaceAdditionalHeaders

   final WorkflowCancelParams.Builder replaceAdditionalHeaders(String name, String value)

• replaceAdditionalHeaders

   final WorkflowCancelParams.Builder replaceAdditionalHeaders(String name, Iterable<String> values)

• replaceAllAdditionalHeaders

   final WorkflowCancelParams.Builder replaceAllAdditionalHeaders(Headers additionalHeaders)

• replaceAllAdditionalHeaders

   final WorkflowCancelParams.Builder replaceAllAdditionalHeaders(Map<String, Iterable<String>> additionalHeaders)

• removeAdditionalHeaders

   final WorkflowCancelParams.Builder removeAdditionalHeaders(String name)

• removeAllAdditionalHeaders

   final WorkflowCancelParams.Builder removeAllAdditionalHeaders(Set<String> names)

• additionalQueryParams

   final WorkflowCancelParams.Builder additionalQueryParams(QueryParams additionalQueryParams)

• additionalQueryParams

   final WorkflowCancelParams.Builder additionalQueryParams(Map<String, Iterable<String>> additionalQueryParams)

• putAdditionalQueryParam

   final WorkflowCancelParams.Builder putAdditionalQueryParam(String key, String value)

• putAdditionalQueryParams

   final WorkflowCancelParams.Builder putAdditionalQueryParams(String key, Iterable<String> values)

• putAllAdditionalQueryParams

   final WorkflowCancelParams.Builder putAllAdditionalQueryParams(QueryParams additionalQueryParams)

• putAllAdditionalQueryParams

   final WorkflowCancelParams.Builder putAllAdditionalQueryParams(Map<String, Iterable<String>> additionalQueryParams)

• replaceAdditionalQueryParams

   final WorkflowCancelParams.Builder replaceAdditionalQueryParams(String key, String value)

• replaceAdditionalQueryParams

   final WorkflowCancelParams.Builder replaceAdditionalQueryParams(String key, Iterable<String> values)

• replaceAllAdditionalQueryParams

   final WorkflowCancelParams.Builder replaceAllAdditionalQueryParams(QueryParams additionalQueryParams)

• replaceAllAdditionalQueryParams

   final WorkflowCancelParams.Builder replaceAllAdditionalQueryParams(Map<String, Iterable<String>> additionalQueryParams)

• removeAdditionalQueryParams

   final WorkflowCancelParams.Builder removeAdditionalQueryParams(String key)

• removeAllAdditionalQueryParams

   final WorkflowCancelParams.Builder removeAllAdditionalQueryParams(Set<String> keys)

• build

   final WorkflowCancelParams build()

  Returns an immutable instance of WorkflowCancelParams.

  Further updates to this Builder will not mutate the returned instance.

  The following fields are required:

  .cancellationKey()