Constructor Detail

Method Detail

• recipients

   final WorkflowTriggerParams.Body.Builder recipients(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.

• recipients

   final WorkflowTriggerParams.Body.Builder recipients(JsonField<List<RecipientRequest>> recipients)

  Sets Builder.recipients to an arbitrary JSON value.

  You should usually call Builder.recipients with a well-typed List<RecipientRequest> value instead. This method is primarily for setting the field to an undocumented or not yet supported value.

• addRecipient

   final WorkflowTriggerParams.Body.Builder addRecipient(RecipientRequest recipient)

  Adds a single RecipientRequest to recipients.

• addRecipient

   final WorkflowTriggerParams.Body.Builder addRecipient(String userRecipient)

  Alias for calling addRecipient with RecipientRequest.ofUserRecipient(userRecipient).

• addRecipient

   final WorkflowTriggerParams.Body.Builder addRecipient(InlineIdentifyUserRequest inlineIdentifyUser)

  Alias for calling addRecipient with RecipientRequest.ofInlineIdentifyUser(inlineIdentifyUser).

• addRecipient

   final WorkflowTriggerParams.Body.Builder addRecipient(InlineObjectRequest inlineObject)

  Alias for calling addRecipient with RecipientRequest.ofInlineObject(inlineObject).

• actor

   final WorkflowTriggerParams.Body.Builder actor(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 collection property.

• actor

   final WorkflowTriggerParams.Body.Builder actor(Optional<RecipientRequest> actor)

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

• actor

   final WorkflowTriggerParams.Body.Builder actor(JsonField<RecipientRequest> actor)

  Sets Builder.actor to an arbitrary JSON value.

  You should usually call Builder.actor with a well-typed RecipientRequest value instead. This method is primarily for setting the field to an undocumented or not yet supported value.

• actor

   final WorkflowTriggerParams.Body.Builder actor(String userRecipient)

  Alias for calling actor with RecipientRequest.ofUserRecipient(userRecipient).

• actor

   final WorkflowTriggerParams.Body.Builder actor(InlineIdentifyUserRequest inlineIdentifyUser)

  Alias for calling actor with RecipientRequest.ofInlineIdentifyUser(inlineIdentifyUser).

• actor

   final WorkflowTriggerParams.Body.Builder actor(InlineObjectRequest inlineObject)

  Alias for calling actor with RecipientRequest.ofInlineObject(inlineObject).

• cancellationKey

   final WorkflowTriggerParams.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 WorkflowTriggerParams.Body.Builder cancellationKey(Optional<String> cancellationKey)

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

• cancellationKey

   final WorkflowTriggerParams.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.

• data

   final WorkflowTriggerParams.Body.Builder data(WorkflowTriggerParams.Data data)

  An optional map of data to pass into the workflow execution.

• data

   final WorkflowTriggerParams.Body.Builder data(Optional<WorkflowTriggerParams.Data> data)

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

• data

   final WorkflowTriggerParams.Body.Builder data(JsonField<WorkflowTriggerParams.Data> data)

  Sets Builder.data to an arbitrary JSON value.

  You should usually call Builder.data with a well-typed Data value instead. This method is primarily for setting the field to an undocumented or not yet supported value.

• tenant

   final WorkflowTriggerParams.Body.Builder tenant(InlineTenantRequest tenant)

  An request to set a tenant inline.

• tenant

   final WorkflowTriggerParams.Body.Builder tenant(Optional<InlineTenantRequest> tenant)

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

• tenant

   final WorkflowTriggerParams.Body.Builder tenant(JsonField<InlineTenantRequest> tenant)

  Sets Builder.tenant to an arbitrary JSON value.

  You should usually call Builder.tenant with a well-typed InlineTenantRequest value instead. This method is primarily for setting the field to an undocumented or not yet supported value.

• tenant

   final WorkflowTriggerParams.Body.Builder tenant(String string)

  Alias for calling tenant with InlineTenantRequest.ofString(string).

• tenant

   final WorkflowTriggerParams.Body.Builder tenant(TenantRequest tenantRequest)

  Alias for calling tenant with InlineTenantRequest.ofTenantRequest(tenantRequest).

• additionalProperties

   final WorkflowTriggerParams.Body.Builder additionalProperties(Map<String, JsonValue> additionalProperties)

• putAdditionalProperty

   final WorkflowTriggerParams.Body.Builder putAdditionalProperty(String key, JsonValue value)

• putAllAdditionalProperties

   final WorkflowTriggerParams.Body.Builder putAllAdditionalProperties(Map<String, JsonValue> additionalProperties)

• removeAdditionalProperty

   final WorkflowTriggerParams.Body.Builder removeAdditionalProperty(String key)

• removeAllAdditionalProperties

   final WorkflowTriggerParams.Body.Builder removeAllAdditionalProperties(Set<String> keys)

• build

   final WorkflowTriggerParams.Body build()

  Returns an immutable instance of Body.

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

  The following fields are required:

  .recipients()