Constructor Detail

Method Detail

• key

   final WorkflowTriggerParams.Builder key(String key)

• key

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

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

• body

   final WorkflowTriggerParams.Builder body(WorkflowTriggerParams.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:

  • recipients

  • actor

  • cancellationKey

  • data

  • tenant

  • etc.

• recipients

   final WorkflowTriggerParams.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.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.Builder addRecipient(RecipientRequest recipient)

  Adds a single RecipientRequest to recipients.

• addRecipient

   final WorkflowTriggerParams.Builder addRecipient(String userRecipient)

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

• addRecipient

   final WorkflowTriggerParams.Builder addRecipient(InlineIdentifyUserRequest inlineIdentifyUser)

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

• addRecipient

   final WorkflowTriggerParams.Builder addRecipient(InlineObjectRequest inlineObject)

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

• actor

   final WorkflowTriggerParams.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.Builder actor(Optional<RecipientRequest> actor)

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

• actor

   final WorkflowTriggerParams.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.Builder actor(String userRecipient)

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

• actor

   final WorkflowTriggerParams.Builder actor(InlineIdentifyUserRequest inlineIdentifyUser)

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

• actor

   final WorkflowTriggerParams.Builder actor(InlineObjectRequest inlineObject)

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

• cancellationKey

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

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

• cancellationKey

   final WorkflowTriggerParams.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.Builder data(WorkflowTriggerParams.Data data)

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

• data

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

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

• data

   final WorkflowTriggerParams.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.Builder tenant(InlineTenantRequest tenant)

  An request to set a tenant inline.

• tenant

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

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

• tenant

   final WorkflowTriggerParams.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.Builder tenant(String string)

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

• tenant

   final WorkflowTriggerParams.Builder tenant(TenantRequest tenantRequest)

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

• additionalBodyProperties

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

• putAdditionalBodyProperty

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

• putAllAdditionalBodyProperties

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

• removeAdditionalBodyProperty

   final WorkflowTriggerParams.Builder removeAdditionalBodyProperty(String key)

• removeAllAdditionalBodyProperties

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

• additionalHeaders

   final WorkflowTriggerParams.Builder additionalHeaders(Headers additionalHeaders)

• additionalHeaders

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

• putAdditionalHeader

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

• putAdditionalHeaders

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

• putAllAdditionalHeaders

   final WorkflowTriggerParams.Builder putAllAdditionalHeaders(Headers additionalHeaders)

• putAllAdditionalHeaders

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

• replaceAdditionalHeaders

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

• replaceAdditionalHeaders

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

• replaceAllAdditionalHeaders

   final WorkflowTriggerParams.Builder replaceAllAdditionalHeaders(Headers additionalHeaders)

• replaceAllAdditionalHeaders

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

• removeAdditionalHeaders

   final WorkflowTriggerParams.Builder removeAdditionalHeaders(String name)

• removeAllAdditionalHeaders

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

• additionalQueryParams

   final WorkflowTriggerParams.Builder additionalQueryParams(QueryParams additionalQueryParams)

• additionalQueryParams

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

• putAdditionalQueryParam

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

• putAdditionalQueryParams

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

• putAllAdditionalQueryParams

   final WorkflowTriggerParams.Builder putAllAdditionalQueryParams(QueryParams additionalQueryParams)

• putAllAdditionalQueryParams

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

• replaceAdditionalQueryParams

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

• replaceAdditionalQueryParams

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

• replaceAllAdditionalQueryParams

   final WorkflowTriggerParams.Builder replaceAllAdditionalQueryParams(QueryParams additionalQueryParams)

• replaceAllAdditionalQueryParams

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

• removeAdditionalQueryParams

   final WorkflowTriggerParams.Builder removeAdditionalQueryParams(String key)

• removeAllAdditionalQueryParams

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

• build

   final WorkflowTriggerParams build()

  Returns an immutable instance of WorkflowTriggerParams.

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

  The following fields are required:

  .recipients()