Constructor Detail

Method Detail

• body

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

  • scheduleIds

  • actor

  • data

  • endingAt

  • repeats

  • etc.

• scheduleIds

   final ScheduleUpdateParams.Builder scheduleIds(List<String> scheduleIds)

  A list of schedule IDs.

• scheduleIds

   final ScheduleUpdateParams.Builder scheduleIds(JsonField<List<String>> scheduleIds)

  Sets Builder.scheduleIds to an arbitrary JSON value.

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

• addScheduleId

   final ScheduleUpdateParams.Builder addScheduleId(String scheduleId)

  Adds a single String to scheduleIds.

• actor

   final ScheduleUpdateParams.Builder actor(RecipientReference actor)

  A reference to a recipient, either a user identifier (string) or an object reference (ID, collection).

• actor

   final ScheduleUpdateParams.Builder actor(Optional<RecipientReference> actor)

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

• actor

   final ScheduleUpdateParams.Builder actor(JsonField<RecipientReference> actor)

  Sets Builder.actor to an arbitrary JSON value.

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

• actor

   final ScheduleUpdateParams.Builder actor(String user)

  Alias for calling actor with RecipientReference.ofUser(user).

• actor

   final ScheduleUpdateParams.Builder actor(RecipientReference.ObjectReference objectReference)

  Alias for calling actor with RecipientReference.ofObjectReference(objectReference).

• data

   final ScheduleUpdateParams.Builder data(ScheduleUpdateParams.Data data)

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

• data

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

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

• data

   final ScheduleUpdateParams.Builder data(JsonField<ScheduleUpdateParams.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 ScheduleUpdateParams.Builder endingAt(OffsetDateTime endingAt)

  The ending date and time for the schedule.

• endingAt

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

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

• endingAt

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

• repeats

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

  The repeat rule for the schedule.

• repeats

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

  Adds a single ScheduleRepeatRule to repeats.

• scheduledAt

   final ScheduleUpdateParams.Builder scheduledAt(OffsetDateTime scheduledAt)

  The starting date and time for the schedule.

• scheduledAt

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

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

• scheduledAt

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

  An request to set a tenant inline.

• tenant

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

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

• tenant

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

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

• tenant

   final ScheduleUpdateParams.Builder tenant(TenantRequest tenantRequest)

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

• additionalBodyProperties

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

• putAdditionalBodyProperty

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

• putAllAdditionalBodyProperties

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

• removeAdditionalBodyProperty

   final ScheduleUpdateParams.Builder removeAdditionalBodyProperty(String key)

• removeAllAdditionalBodyProperties

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

• additionalHeaders

   final ScheduleUpdateParams.Builder additionalHeaders(Headers additionalHeaders)

• additionalHeaders

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

• putAdditionalHeader

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

• putAdditionalHeaders

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

• putAllAdditionalHeaders

   final ScheduleUpdateParams.Builder putAllAdditionalHeaders(Headers additionalHeaders)

• putAllAdditionalHeaders

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

• replaceAdditionalHeaders

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

• replaceAdditionalHeaders

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

• replaceAllAdditionalHeaders

   final ScheduleUpdateParams.Builder replaceAllAdditionalHeaders(Headers additionalHeaders)

• replaceAllAdditionalHeaders

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

• removeAdditionalHeaders

   final ScheduleUpdateParams.Builder removeAdditionalHeaders(String name)

• removeAllAdditionalHeaders

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

• additionalQueryParams

   final ScheduleUpdateParams.Builder additionalQueryParams(QueryParams additionalQueryParams)

• additionalQueryParams

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

• putAdditionalQueryParam

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

• putAdditionalQueryParams

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

• putAllAdditionalQueryParams

   final ScheduleUpdateParams.Builder putAllAdditionalQueryParams(QueryParams additionalQueryParams)

• putAllAdditionalQueryParams

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

• replaceAdditionalQueryParams

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

• replaceAdditionalQueryParams

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

• replaceAllAdditionalQueryParams

   final ScheduleUpdateParams.Builder replaceAllAdditionalQueryParams(QueryParams additionalQueryParams)

• replaceAllAdditionalQueryParams

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

• removeAdditionalQueryParams

   final ScheduleUpdateParams.Builder removeAdditionalQueryParams(String key)

• removeAllAdditionalQueryParams

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

• build

   final ScheduleUpdateParams build()

  Returns an immutable instance of ScheduleUpdateParams.

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

  The following fields are required:

  .scheduleIds()