Class BulkCreateParams.Schedule
-
- All Implemented Interfaces:
public final class BulkCreateParams.ScheduleA schedule represents a recurring workflow execution.
-
-
Nested Class Summary
Nested Classes Modifier and Type Class Description public final classBulkCreateParams.Schedule.BuilderA builder for Schedule.
public final classBulkCreateParams.Schedule.DataAn optional map of data to pass into the workflow execution.
-
Method Summary
Modifier and Type Method Description final Stringworkflow()The key of the workflow. final Optional<RecipientRequest>actor()Specifies a recipient in a request. final Optional<BulkCreateParams.Schedule.Data>data()An optional map of data to pass into the workflow execution. final Optional<OffsetDateTime>endingAt()The ending date and time for the schedule. final Optional<RecipientRequest>recipient()Specifies a recipient in a request. final Optional<List<ScheduleRepeatRule>>repeats()The repeat rule for the schedule. final Optional<OffsetDateTime>scheduledAt()The starting date and time for the schedule. final Optional<InlineTenantRequest>tenant()An request to set a tenant inline. final JsonField<String>_workflow()Returns the raw JSON value of workflow. final JsonField<RecipientRequest>_actor()Returns the raw JSON value of actor. final JsonField<BulkCreateParams.Schedule.Data>_data()Returns the raw JSON value of data. final JsonField<OffsetDateTime>_endingAt()Returns the raw JSON value of endingAt. final JsonField<RecipientRequest>_recipient()Returns the raw JSON value of recipient. final JsonField<List<ScheduleRepeatRule>>_repeats()Returns the raw JSON value of repeats. final JsonField<OffsetDateTime>_scheduledAt()Returns the raw JSON value of scheduledAt. final JsonField<InlineTenantRequest>_tenant()Returns the raw JSON value of tenant. final Map<String, JsonValue>_additionalProperties()final BulkCreateParams.Schedule.BuildertoBuilder()final BulkCreateParams.Schedulevalidate()final BooleanisValid()Booleanequals(Object other)IntegerhashCode()StringtoString()final static BulkCreateParams.Schedule.Builderbuilder()Returns a mutable builder for constructing an instance of Schedule. -
-
Method Detail
-
actor
final Optional<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
collectionproperty.
-
data
final Optional<BulkCreateParams.Schedule.Data> data()
An optional map of data to pass into the workflow execution.
-
endingAt
final Optional<OffsetDateTime> endingAt()
The ending date and time for the schedule.
-
recipient
final Optional<RecipientRequest> recipient()
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
collectionproperty.
-
repeats
final Optional<List<ScheduleRepeatRule>> repeats()
The repeat rule for the schedule.
-
scheduledAt
final Optional<OffsetDateTime> scheduledAt()
The starting date and time for the schedule.
-
tenant
final Optional<InlineTenantRequest> tenant()
An request to set a tenant inline.
-
_workflow
final JsonField<String> _workflow()
Returns the raw JSON value of workflow.
Unlike workflow, this method doesn't throw if the JSON field has an unexpected type.
-
_actor
final JsonField<RecipientRequest> _actor()
Returns the raw JSON value of actor.
Unlike actor, this method doesn't throw if the JSON field has an unexpected type.
-
_data
final JsonField<BulkCreateParams.Schedule.Data> _data()
Returns the raw JSON value of data.
Unlike data, this method doesn't throw if the JSON field has an unexpected type.
-
_endingAt
final JsonField<OffsetDateTime> _endingAt()
Returns the raw JSON value of endingAt.
Unlike endingAt, this method doesn't throw if the JSON field has an unexpected type.
-
_recipient
final JsonField<RecipientRequest> _recipient()
Returns the raw JSON value of recipient.
Unlike recipient, this method doesn't throw if the JSON field has an unexpected type.
-
_repeats
final JsonField<List<ScheduleRepeatRule>> _repeats()
Returns the raw JSON value of repeats.
Unlike repeats, this method doesn't throw if the JSON field has an unexpected type.
-
_scheduledAt
final JsonField<OffsetDateTime> _scheduledAt()
Returns the raw JSON value of scheduledAt.
Unlike scheduledAt, this method doesn't throw if the JSON field has an unexpected type.
-
_tenant
final JsonField<InlineTenantRequest> _tenant()
Returns the raw JSON value of tenant.
Unlike tenant, this method doesn't throw if the JSON field has an unexpected type.
-
_additionalProperties
final Map<String, JsonValue> _additionalProperties()
-
toBuilder
final BulkCreateParams.Schedule.Builder toBuilder()
-
validate
final BulkCreateParams.Schedule validate()
-
builder
final static BulkCreateParams.Schedule.Builder builder()
Returns a mutable builder for constructing an instance of Schedule.
The following fields are required:
.workflow()
-
-
-
-