Class WorkflowTriggerParams.Body
-
- All Implemented Interfaces:
public final class WorkflowTriggerParams.BodyA request to trigger a notification workflow.
-
-
Nested Class Summary
Nested Classes Modifier and Type Class Description public final classWorkflowTriggerParams.Body.BuilderA builder for Body.
-
Method Summary
Modifier and Type Method Description final List<RecipientRequest>recipients()The recipients to trigger the workflow for. final Optional<RecipientRequest>actor()Specifies a recipient in a request. final Optional<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<WorkflowTriggerParams.Data>data()An optional map of data to pass into the workflow execution. final Optional<InlineTenantRequest>tenant()An request to set a tenant inline. final JsonField<List<RecipientRequest>>_recipients()Returns the raw JSON value of recipients. final JsonField<RecipientRequest>_actor()Returns the raw JSON value of actor. final JsonField<String>_cancellationKey()Returns the raw JSON value of cancellationKey. final JsonField<WorkflowTriggerParams.Data>_data()Returns the raw JSON value of data. final JsonField<InlineTenantRequest>_tenant()Returns the raw JSON value of tenant. final Map<String, JsonValue>_additionalProperties()final WorkflowTriggerParams.Body.BuildertoBuilder()final WorkflowTriggerParams.Bodyvalidate()final BooleanisValid()Booleanequals(Object other)IntegerhashCode()StringtoString()final static WorkflowTriggerParams.Body.Builderbuilder()Returns a mutable builder for constructing an instance of Body. -
-
Method Detail
-
recipients
final List<RecipientRequest> recipients()
The recipients to trigger the workflow for. Can inline identify users, objects, or use a list of user IDs. Limited to 1,000 recipients.
-
actor
final Optional<RecipientRequest> actor()
Specifies a recipient in a request. This can either be a user identifier (string), an inline user request (object), or an inline object request, which is determined by the presence of a
collectionproperty.
-
cancellationKey
final Optional<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.
-
data
final Optional<WorkflowTriggerParams.Data> data()
An optional map of data to pass into the workflow execution.
-
tenant
final Optional<InlineTenantRequest> tenant()
An request to set a tenant inline.
-
_recipients
final JsonField<List<RecipientRequest>> _recipients()
Returns the raw JSON value of recipients.
Unlike recipients, this method doesn't throw if the JSON field has an unexpected type.
-
_actor
final JsonField<RecipientRequest> _actor()
Returns the raw JSON value of actor.
Unlike actor, this method doesn't throw if the JSON field has an unexpected type.
-
_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.
-
_data
final JsonField<WorkflowTriggerParams.Data> _data()
Returns the raw JSON value of data.
Unlike data, this method doesn't throw if the JSON field has an unexpected type.
-
_tenant
final JsonField<InlineTenantRequest> _tenant()
Returns the raw JSON value of tenant.
Unlike tenant, this method doesn't throw if the JSON field has an unexpected type.
-
_additionalProperties
final Map<String, JsonValue> _additionalProperties()
-
toBuilder
final WorkflowTriggerParams.Body.Builder toBuilder()
-
validate
final WorkflowTriggerParams.Body validate()
-
builder
final static WorkflowTriggerParams.Body.Builder builder()
Returns a mutable builder for constructing an instance of Body.
The following fields are required:
.recipients()
-
-
-
-