Class Schedule
-
- All Implemented Interfaces:
public final class ScheduleA schedule represents a recurring workflow execution.
-
-
Nested Class Summary
Nested Classes Modifier and Type Class Description public final classSchedule.BuilderA builder for Schedule.
public final classSchedule.DataAn optional map of data to pass into the workflow execution.
-
Method Summary
Modifier and Type Method Description final Stringid()Unique identifier for the schedule. final OffsetDateTimeinsertedAt()Timestamp when the resource was created. final Recipientrecipient()A recipient of a notification, which is either a user or an object. final List<ScheduleRepeatRule>repeats()The repeat rule for the schedule. final OffsetDateTimeupdatedAt()The timestamp when the resource was last updated. final Stringworkflow()The workflow the schedule is applied to. final Optional<String>_typename()The typename of the schema. final Optional<Recipient>actor()A recipient of a notification, which is either a user or an object. final Optional<Schedule.Data>data()An optional map of data to pass into the workflow execution. final Optional<OffsetDateTime>lastOccurrenceAt()The last occurrence of the schedule. final Optional<OffsetDateTime>nextOccurrenceAt()The next occurrence of the schedule. final Optional<String>tenant()The tenant to trigger the workflow for. final JsonField<String>_id()Returns the raw JSON value of id. final JsonField<OffsetDateTime>_insertedAt()Returns the raw JSON value of insertedAt. final JsonField<Recipient>_recipient()Returns the raw JSON value of recipient. final JsonField<List<ScheduleRepeatRule>>_repeats()Returns the raw JSON value of repeats. final JsonField<OffsetDateTime>_updatedAt()Returns the raw JSON value of updatedAt. final JsonField<String>_workflow()Returns the raw JSON value of workflow. final JsonField<String>__typename()Returns the raw JSON value of _typename. final JsonField<Recipient>_actor()Returns the raw JSON value of actor. final JsonField<Schedule.Data>_data()Returns the raw JSON value of data. final JsonField<OffsetDateTime>_lastOccurrenceAt()Returns the raw JSON value of lastOccurrenceAt. final JsonField<OffsetDateTime>_nextOccurrenceAt()Returns the raw JSON value of nextOccurrenceAt. final JsonField<String>_tenant()Returns the raw JSON value of tenant. final Map<String, JsonValue>_additionalProperties()final Schedule.BuildertoBuilder()final Schedulevalidate()final BooleanisValid()Booleanequals(Object other)IntegerhashCode()StringtoString()final static Schedule.Builderbuilder()Returns a mutable builder for constructing an instance of Schedule. -
-
Method Detail
-
insertedAt
final OffsetDateTime insertedAt()
Timestamp when the resource was created.
-
recipient
final Recipient recipient()
A recipient of a notification, which is either a user or an object.
-
repeats
final List<ScheduleRepeatRule> repeats()
The repeat rule for the schedule.
-
updatedAt
final OffsetDateTime updatedAt()
The timestamp when the resource was last updated.
-
actor
final Optional<Recipient> actor()
A recipient of a notification, which is either a user or an object.
-
data
final Optional<Schedule.Data> data()
An optional map of data to pass into the workflow execution.
-
lastOccurrenceAt
final Optional<OffsetDateTime> lastOccurrenceAt()
The last occurrence of the schedule.
-
nextOccurrenceAt
final Optional<OffsetDateTime> nextOccurrenceAt()
The next occurrence of the schedule.
-
tenant
final Optional<String> tenant()
The tenant to trigger the workflow for. Triggering with a tenant will use any tenant-level overrides associated with the tenant object, and all messages produced from workflow runs will be tagged with the tenant.
-
_id
final JsonField<String> _id()
Returns the raw JSON value of id.
Unlike id, this method doesn't throw if the JSON field has an unexpected type.
-
_insertedAt
final JsonField<OffsetDateTime> _insertedAt()
Returns the raw JSON value of insertedAt.
Unlike insertedAt, this method doesn't throw if the JSON field has an unexpected type.
-
_recipient
final JsonField<Recipient> _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.
-
_updatedAt
final JsonField<OffsetDateTime> _updatedAt()
Returns the raw JSON value of updatedAt.
Unlike updatedAt, this method doesn't throw if the JSON field has an unexpected type.
-
_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.
-
__typename
final JsonField<String> __typename()
Returns the raw JSON value of _typename.
Unlike _typename, this method doesn't throw if the JSON field has an unexpected type.
-
_actor
final JsonField<Recipient> _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<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.
-
_lastOccurrenceAt
final JsonField<OffsetDateTime> _lastOccurrenceAt()
Returns the raw JSON value of lastOccurrenceAt.
Unlike lastOccurrenceAt, this method doesn't throw if the JSON field has an unexpected type.
-
_nextOccurrenceAt
final JsonField<OffsetDateTime> _nextOccurrenceAt()
Returns the raw JSON value of nextOccurrenceAt.
Unlike nextOccurrenceAt, this method doesn't throw if the JSON field has an unexpected type.
-
_tenant
final JsonField<String> _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 Schedule.Builder toBuilder()
-
builder
final static Schedule.Builder builder()
Returns a mutable builder for constructing an instance of Schedule.
The following fields are required:
.id() .insertedAt() .recipient() .repeats() .updatedAt() .workflow()
-
-
-
-