Constructor Detail

Method Detail

• body

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

  • repeats

  • workflow

  • data

  • endingAt

  • etc.

• recipients

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

  Adds a single RecipientRequest to recipients.

• addRecipient

   final ScheduleCreateParams.Builder addRecipient(String userRecipient)

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

• addRecipient

   final ScheduleCreateParams.Builder addRecipient(InlineIdentifyUserRequest inlineIdentifyUser)

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

• addRecipient

   final ScheduleCreateParams.Builder addRecipient(InlineObjectRequest inlineObject)

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

• repeats

   final ScheduleCreateParams.Builder repeats(List<ScheduleRepeatRule> repeats)

  The repeat rule for the schedule.

• repeats

   final ScheduleCreateParams.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.Builder addRepeat(ScheduleRepeatRule repeat)

  Adds a single ScheduleRepeatRule to repeats.

• workflow

   final ScheduleCreateParams.Builder workflow(String workflow)

  The key of the workflow.

• workflow

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

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

• data

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

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

• data

   final ScheduleCreateParams.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.Builder endingAt(OffsetDateTime endingAt)

  The ending date and time for the schedule.

• endingAt

   final ScheduleCreateParams.Builder endingAt(Optional<OffsetDateTime> endingAt)

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

• endingAt

   final ScheduleCreateParams.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.Builder scheduledAt(OffsetDateTime scheduledAt)

  The starting date and time for the schedule.

• scheduledAt

   final ScheduleCreateParams.Builder scheduledAt(Optional<OffsetDateTime> scheduledAt)

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

• scheduledAt

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

  An request to set a tenant inline.

• tenant

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

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

• tenant

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

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

• tenant

   final ScheduleCreateParams.Builder tenant(TenantRequest tenantRequest)

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

• additionalBodyProperties

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

• putAdditionalBodyProperty

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

• putAllAdditionalBodyProperties

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

• removeAdditionalBodyProperty

   final ScheduleCreateParams.Builder removeAdditionalBodyProperty(String key)

• removeAllAdditionalBodyProperties

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

• additionalHeaders

   final ScheduleCreateParams.Builder additionalHeaders(Headers additionalHeaders)

• additionalHeaders

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

• putAdditionalHeader

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

• putAdditionalHeaders

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

• putAllAdditionalHeaders

   final ScheduleCreateParams.Builder putAllAdditionalHeaders(Headers additionalHeaders)

• putAllAdditionalHeaders

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

• replaceAdditionalHeaders

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

• replaceAdditionalHeaders

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

• replaceAllAdditionalHeaders

   final ScheduleCreateParams.Builder replaceAllAdditionalHeaders(Headers additionalHeaders)

• replaceAllAdditionalHeaders

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

• removeAdditionalHeaders

   final ScheduleCreateParams.Builder removeAdditionalHeaders(String name)

• removeAllAdditionalHeaders

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

• additionalQueryParams

   final ScheduleCreateParams.Builder additionalQueryParams(QueryParams additionalQueryParams)

• additionalQueryParams

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

• putAdditionalQueryParam

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

• putAdditionalQueryParams

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

• putAllAdditionalQueryParams

   final ScheduleCreateParams.Builder putAllAdditionalQueryParams(QueryParams additionalQueryParams)

• putAllAdditionalQueryParams

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

• replaceAdditionalQueryParams

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

• replaceAdditionalQueryParams

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

• replaceAllAdditionalQueryParams

   final ScheduleCreateParams.Builder replaceAllAdditionalQueryParams(QueryParams additionalQueryParams)

• replaceAllAdditionalQueryParams

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

• removeAdditionalQueryParams

   final ScheduleCreateParams.Builder removeAdditionalQueryParams(String key)

• removeAllAdditionalQueryParams

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

• build

   final ScheduleCreateParams build()

  Returns an immutable instance of ScheduleCreateParams.

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

  The following fields are required:

  .recipients()
  .repeats()
  .workflow()