Class ScheduleCreateParams.Body.Builder
-
- All Implemented Interfaces:
public final class ScheduleCreateParams.Body.BuilderA builder for Body.
-
-
Method Summary
-
-
Method Detail
-
recipients
final ScheduleCreateParams.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 ScheduleCreateParams.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 ScheduleCreateParams.Body.Builder addRecipient(RecipientRequest recipient)
Adds a single RecipientRequest to recipients.
-
addRecipient
final ScheduleCreateParams.Body.Builder addRecipient(String userRecipient)
Alias for calling addRecipient with
RecipientRequest.ofUserRecipient(userRecipient).
-
addRecipient
final ScheduleCreateParams.Body.Builder addRecipient(InlineIdentifyUserRequest inlineIdentifyUser)
Alias for calling addRecipient with
RecipientRequest.ofInlineIdentifyUser(inlineIdentifyUser).
-
addRecipient
final ScheduleCreateParams.Body.Builder addRecipient(InlineObjectRequest inlineObject)
Alias for calling addRecipient with
RecipientRequest.ofInlineObject(inlineObject).
-
repeats
final ScheduleCreateParams.Body.Builder repeats(List<ScheduleRepeatRule> repeats)
The repeat rule for the schedule.
-
repeats
final ScheduleCreateParams.Body.Builder repeats(JsonField<List<ScheduleRepeatRule>> repeats)
Sets Builder.repeats to an arbitrary JSON value.
You should usually call Builder.repeats with a well-typed
List<ScheduleRepeatRule>value instead. This method is primarily for setting the field to an undocumented or not yet supported value.
-
addRepeat
final ScheduleCreateParams.Body.Builder addRepeat(ScheduleRepeatRule repeat)
Adds a single ScheduleRepeatRule to repeats.
-
workflow
final ScheduleCreateParams.Body.Builder workflow(String workflow)
The key of the workflow.
-
workflow
final ScheduleCreateParams.Body.Builder workflow(JsonField<String> workflow)
Sets Builder.workflow to an arbitrary JSON value.
You should usually call Builder.workflow 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 ScheduleCreateParams.Body.Builder data(ScheduleCreateParams.Data data)
An optional map of data to pass into the workflow execution.
-
data
final ScheduleCreateParams.Body.Builder data(Optional<ScheduleCreateParams.Data> data)
Alias for calling Builder.data with
data.orElse(null).
-
data
final ScheduleCreateParams.Body.Builder data(JsonField<ScheduleCreateParams.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.
-
endingAt
final ScheduleCreateParams.Body.Builder endingAt(OffsetDateTime endingAt)
The ending date and time for the schedule.
-
endingAt
final ScheduleCreateParams.Body.Builder endingAt(Optional<OffsetDateTime> endingAt)
Alias for calling Builder.endingAt with
endingAt.orElse(null).
-
endingAt
final ScheduleCreateParams.Body.Builder endingAt(JsonField<OffsetDateTime> endingAt)
Sets Builder.endingAt to an arbitrary JSON value.
You should usually call Builder.endingAt with a well-typed OffsetDateTime value instead. This method is primarily for setting the field to an undocumented or not yet supported value.
-
scheduledAt
final ScheduleCreateParams.Body.Builder scheduledAt(OffsetDateTime scheduledAt)
The starting date and time for the schedule.
-
scheduledAt
final ScheduleCreateParams.Body.Builder scheduledAt(Optional<OffsetDateTime> scheduledAt)
Alias for calling Builder.scheduledAt with
scheduledAt.orElse(null).
-
scheduledAt
final ScheduleCreateParams.Body.Builder scheduledAt(JsonField<OffsetDateTime> scheduledAt)
Sets Builder.scheduledAt to an arbitrary JSON value.
You should usually call Builder.scheduledAt with a well-typed OffsetDateTime value instead. This method is primarily for setting the field to an undocumented or not yet supported value.
-
tenant
final ScheduleCreateParams.Body.Builder tenant(InlineTenantRequest tenant)
An request to set a tenant inline.
-
tenant
final ScheduleCreateParams.Body.Builder tenant(Optional<InlineTenantRequest> tenant)
Alias for calling Builder.tenant with
tenant.orElse(null).
-
tenant
final ScheduleCreateParams.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 ScheduleCreateParams.Body.Builder tenant(String string)
Alias for calling tenant with
InlineTenantRequest.ofString(string).
-
tenant
final ScheduleCreateParams.Body.Builder tenant(TenantRequest tenantRequest)
Alias for calling tenant with
InlineTenantRequest.ofTenantRequest(tenantRequest).
-
additionalProperties
final ScheduleCreateParams.Body.Builder additionalProperties(Map<String, JsonValue> additionalProperties)
-
putAdditionalProperty
final ScheduleCreateParams.Body.Builder putAdditionalProperty(String key, JsonValue value)
-
putAllAdditionalProperties
final ScheduleCreateParams.Body.Builder putAllAdditionalProperties(Map<String, JsonValue> additionalProperties)
-
removeAdditionalProperty
final ScheduleCreateParams.Body.Builder removeAdditionalProperty(String key)
-
removeAllAdditionalProperties
final ScheduleCreateParams.Body.Builder removeAllAdditionalProperties(Set<String> keys)
-
build
final ScheduleCreateParams.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() .repeats() .workflow()
-
-
-
-